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

Show JSON schema: 
{
  "$defs": {
    "AuditFields": {
      "description": "The audit fields for a resource",
      "properties": {
        "by": {
          "default": null,
          "title": "By",
          "type": "string"
        },
        "byName": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Byname"
        },
        "at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "At"
        }
      },
      "title": "AuditFields",
      "type": "object"
    },
    "BTInsightCategory": {
      "enum": [
        "Optimizer",
        "Custom Optimizer",
        "Impact Chart",
        "Molecule",
        "Smart DOE",
        "Generate"
      ],
      "title": "BTInsightCategory",
      "type": "string"
    },
    "BTInsightPayloadType": {
      "enum": [
        "Breakthrough",
        "Alberto"
      ],
      "title": "BTInsightPayloadType",
      "type": "string"
    },
    "BTInsightRegistry": {
      "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"
    },
    "BTInsightState": {
      "enum": [
        "Queued",
        "Building Models",
        "Generating Candidates",
        "Complete",
        "Error"
      ],
      "title": "BTInsightState",
      "type": "string"
    },
    "Status": {
      "description": "The status of a resource",
      "enum": [
        "active",
        "inactive"
      ],
      "title": "Status",
      "type": "string"
    }
  },
  "properties": {
    "status": {
      "anyOf": [
        {
          "$ref": "#/$defs/Status"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "Created": {
      "anyOf": [
        {
          "$ref": "#/$defs/AuditFields"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "Updated": {
      "anyOf": [
        {
          "$ref": "#/$defs/AuditFields"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "category": {
      "$ref": "#/$defs/BTInsightCategory"
    },
    "Metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Metadata"
    },
    "state": {
      "anyOf": [
        {
          "$ref": "#/$defs/BTInsightState"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "albertId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Albertid"
    },
    "datasetId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Datasetid"
    },
    "modelSessionId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Modelsessionid"
    },
    "modelId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Modelid"
    },
    "outputKey": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Outputkey"
    },
    "startTime": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Starttime"
    },
    "endTime": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Endtime"
    },
    "totalTime": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Totaltime"
    },
    "RawPayload": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Rawpayload"
    },
    "payloadType": {
      "anyOf": [
        {
          "$ref": "#/$defs/BTInsightPayloadType"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "Registry": {
      "anyOf": [
        {
          "$ref": "#/$defs/BTInsightRegistry"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "contentEdited": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Contentedited"
    }
  },
  "required": [
    "name",
    "category"
  ],
  "title": "BTInsight",
  "type": "object"
}

Fields:

name 

name: str

category 

category: BTInsightCategory

metadata 

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

state 

state: BTInsightState | None = None

id 

id: BTInsightId | None = None

dataset_id 

dataset_id: BTDatasetId | None = None

model_session_id 

model_session_id: BTModelSessionId | None = None

model_id 

model_id: BTModelId | None = None

output_key 

output_key: str | None = None

start_time 

start_time: str | None = None

end_time 

end_time: str | None = None

total_time 

total_time: str | None = None

raw_payload 

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

payload_type 

payload_type: BTInsightPayloadType | None = None

registry 

registry: BTInsightRegistry | None = None

content_edited 

content_edited: bool | None = None