Skip to content

Breakthrough Insights

albert.resources.btinsight

BTInsightCategory

Bases: str, Enum

Attributes:

Name Type Description
OPTIMIZER
CUSTOM_OPTIMIZER
IMPACT_CHART
MOLECULE
SMART_DOE
GENERATE

OPTIMIZER 

OPTIMIZER = 'Optimizer'

CUSTOM_OPTIMIZER 

CUSTOM_OPTIMIZER = 'Custom Optimizer'

IMPACT_CHART 

IMPACT_CHART = 'Impact Chart'

MOLECULE 

MOLECULE = 'Molecule'

SMART_DOE 

SMART_DOE = 'Smart DOE'

GENERATE 

GENERATE = 'Generate'

BTInsightState

Bases: str, Enum

Attributes:

Name Type Description
QUEUED
BUILDING_MODELS
GENERATING_CANDIDATES
COMPLETE
ERROR

QUEUED 

QUEUED = 'Queued'

BUILDING_MODELS 

BUILDING_MODELS = 'Building Models'

GENERATING_CANDIDATES 

GENERATING_CANDIDATES = 'Generating Candidates'

COMPLETE 

COMPLETE = 'Complete'

ERROR 

ERROR = 'Error'

BTInsightPayloadType

Bases: str, Enum

Attributes:

Name Type Description
BREAKTHROUGH
ALBERTO

BREAKTHROUGH 

BREAKTHROUGH = 'Breakthrough'

ALBERTO 

ALBERTO = 'Alberto'

BTInsightRegistry

Bases: BaseAlbertModel

Registry for the BTInsight.

Registry contains result metadata for the BTInsight. Additional attributes can be added to the registry as needed.

Show JSON schema: 
{
  "description": "Registry for the BTInsight.\n\nRegistry contains result metadata for the BTInsight.\nAdditional attributes can be added to the registry as needed.",
  "properties": {
    "BuildLogs": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Buildlogs"
    },
    "Metrics": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Metrics"
    },
    "Settings": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Settings"
    }
  },
  "title": "BTInsightRegistry",
  "type": "object"
}

Fields:

build_logs 

build_logs: dict[str, Any] | None = None

metrics 

metrics: dict[str, Any] | None = None

settings 

settings: dict[str, Any] | None = None

BTInsight

Bases: BaseResource

Attributes:

Name Type Description
name str
category BTInsightCategory
metadata dict[str, Any] | None
state BTInsightState | None
id BTInsightId | None
dataset_id BTDatasetId | None
model_session_id BTModelSessionId | None
model_id BTModelId | None
output_key str | None
start_time str | None
end_time str | None
total_time str | None
raw_payload dict[str, Any] | None
payload_type BTInsightPayloadType | None
registry BTInsightRegistry | None
content_edited bool | None

name 

name: str

category 

category: BTInsightCategory

metadata 

metadata: dict[str, Any] | None = Field(
    default=None, alias="Metadata"
)

state 

state: BTInsightState | None = Field(default=None)

id 

id: BTInsightId | None = Field(
    default=None, alias="albertId"
)

dataset_id 

dataset_id: BTDatasetId | None = Field(
    default=None, alias="datasetId"
)

model_session_id 

model_session_id: BTModelSessionId | None = Field(
    default=None, alias="modelSessionId"
)

model_id 

model_id: BTModelId | None = Field(
    default=None, alias="modelId"
)

output_key 

output_key: str | None = Field(
    default=None, alias="outputKey"
)

start_time 

start_time: str | None = Field(
    default=None, alias="startTime"
)

end_time 

end_time: str | None = Field(default=None, alias='endTime')

total_time 

total_time: str | None = Field(
    default=None, alias="totalTime"
)

raw_payload 

raw_payload: dict[str, Any] | None = Field(
    default=None, alias="RawPayload"
)

payload_type 

payload_type: BTInsightPayloadType | None = Field(
    default=None, alias="payloadType"
)

registry 

registry: BTInsightRegistry | None = Field(
    default=None, alias="Registry"
)

content_edited 

content_edited: bool | None = Field(
    default=None, alias="contentEdited"
)