Breakthrough Model

AlbertSession

AlbertSession(
    *,
    base_url: str,
    token: str | None = None,
    client_credentials: ClientCredentials | None = None,
    retries: int | None = None,
)

Bases: Session

A session that has a base URL, which is prefixed to all request URLs.

Parameters:

Name	Type	Description	Default
base_url	str	The base URL to prefix to all requests. (e.g., "https://sandbox.albertinvent.com")	required
retries	int	The number of retries for failed requests. Defaults to 3.	None
client_credentials	ClientCredentials | None	The client credentials for programmatic authentication. Optional if token is provided.	None
token	str | None	The JWT token for authentication. Optional if client credentials are provided.	None

Methods:

Name	Description
request

Source code in src/albert/session.py

def __init__(
    self,
    *,
    base_url: str,
    token: str | None = None,
    client_credentials: ClientCredentials | None = None,
    retries: int | None = None,
):
    super().__init__()
    self.base_url = base_url
    self.headers.update(
        {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "User-Agent": f"albert-SDK V.{albert.__version__}",
        }
    )

    if token is None and client_credentials is None:
        raise ValueError("Either client credentials or token must be specified.")

    self._provided_token = token
    self._token_manager = (
        TokenManager(base_url, client_credentials) if client_credentials is not None else None
    )

    # Set up retry logic
    retries = retries if retries is not None else 3
    retry = Retry(
        total=retries,
        read=retries,
        connect=retries,
        backoff_factor=0.3,
        status_forcelist=(500, 502, 503, 504, 403),
        raise_on_status=False,
    )
    adapter = HTTPAdapter(max_retries=retry)
    self.mount("http://", adapter)
    self.mount("https://", adapter)

base_url instance-attribute

base_url = base_url

request

request(
    method: str, path: str, *args, **kwargs
) -> Response

Source code in src/albert/session.py

def request(self, method: str, path: str, *args, **kwargs) -> requests.Response:
    self.headers["Authorization"] = f"Bearer {self._access_token}"
    full_url = urljoin(self.base_url, path) if not path.startswith("http") else path
    with handle_http_errors():
        response = super().request(method, full_url, *args, **kwargs)
        response.raise_for_status()
        return response

BTModel

Bases: BaseResource

dataset_id class-attribute instance-attribute

dataset_id: str = Field(..., alias='datasetId')

end_time class-attribute instance-attribute

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

flag class-attribute instance-attribute

flag: bool = Field(default=False)

id class-attribute instance-attribute

id: str | None = Field(default=None)

model_binary_key class-attribute instance-attribute

model_binary_key: str | None = Field(
    default=None, alias="modelBinaryKey"
)

name instance-attribute

name: str

parent_id class-attribute instance-attribute

parent_id: str | None = Field(
    default=None, alias="parentId"
)

start_time class-attribute instance-attribute

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

state instance-attribute

state: BTModelState

target instance-attribute

target: list[str]

total_time class-attribute instance-attribute

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

BTModelCollection

BTModelCollection(
    *, session: AlbertSession, parent_id: str
)

Bases: BaseCollection

BTModelCollection is a collection class for managing Breakthrough model entities.

Breakthrough models are associated with a parent Breakthrough model session.

Parameters:

Name	Type	Description	Default
session	AlbertSession	The Albert session instance.	required
parent_id	str	The Albert ID for the parent BTModelSession.	required

Attributes:

Name	Type	Description
base_path	str	The base path for BTModel API requests.

Methods:

Name	Description
create
delete	Delete a BTModel by ID.
get_by_id
update

Source code in src/albert/collections/btmodel.py

def __init__(self, *, session: AlbertSession, parent_id: str):
    super().__init__(session=session)
    self.parent_id = parent_id
    self.base_path = f"/api/{BTModelCollection._api_version}/btmodel/{parent_id}/model"

base_path instance-attribute

base_path = f"/api/{_api_version}/btmodel/{parent_id}/model"

parent_id instance-attribute

parent_id = parent_id

create

create(*, model: BTModel) -> BTModel

Source code in src/albert/collections/btmodel.py

def create(self, *, model: BTModel) -> BTModel:
    response = self.session.post(
        self.base_path,
        json=model.model_dump(mode="json", by_alias=True, exclude_none=True),
    )
    return BTModel(**response.json())

delete

delete(*, id: str) -> None

Delete a BTModel by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the BTModel to delete.	required

Returns:

Type	Description
None

Source code in src/albert/collections/btmodel.py

def delete(self, *, id: str) -> None:
    """Delete a BTModel by ID.

    Parameters
    ----------
    id : str
        The ID of the BTModel to delete.

    Returns
    -------
    None
    """
    self.session.delete(f"{self.base_path}/{id}")

get_by_id

get_by_id(*, id: str) -> BTModel

Source code in src/albert/collections/btmodel.py

def get_by_id(self, *, id: str) -> BTModel:
    response = self.session.get(f"{self.base_path}/{id}")
    return BTModel(**response.json())

update

update(*, model: BTModel) -> BTModel

Source code in src/albert/collections/btmodel.py

def update(self, *, model: BTModel) -> BTModel:
    path = f"{self.base_path}/{model.id}"
    payload = self._generate_patch_payload(
        existing=self.get_by_id(id=model.id),
        updated=model,
    )
    self.session.patch(path, json=payload.model_dump(mode="json", by_alias=True))
    return self.get_by_id(id=model.id)

BTModelSession

BTModelSession(**data)

Bases: BaseSessionResource

Source code in src/albert/resources/base.py

def __init__(self, **data):
    super().__init__(**data)
    self._session = data.get("session")

albert_model_details class-attribute instance-attribute

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

category instance-attribute

category: BTModelCategory

dataset_id class-attribute instance-attribute

dataset_id: str = Field(..., alias='datasetId')

default_model class-attribute instance-attribute

default_model: str | None = Field(
    default=None, alias="defaultModel"
)

flag class-attribute instance-attribute

flag: bool = Field(default=False)

id class-attribute instance-attribute

id: str | None = Field(default=None)

model_count class-attribute instance-attribute

model_count: int | None = Field(
    default=None, alias="modelCount"
)

models property

models

name instance-attribute

name: str

registry class-attribute instance-attribute

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

target class-attribute instance-attribute

target: list[str] | None = Field(default=None)

total_time class-attribute instance-attribute

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

BTModelSessionCollection

BTModelSessionCollection(*, session: AlbertSession)

Bases: BaseCollection

BTModelSessionCollection is a collection class for managing Breakthrough model session entities.

Parameters:

Name	Type	Description	Default
session	AlbertSession	The Albert session instance.	required

Attributes:

Name	Type	Description
base_path	str	The base path for BTModelSession API requests.

Methods:

Name	Description
create
delete	Delete a BTModelSession by ID.
get_by_id
update

Source code in src/albert/collections/btmodel.py

def __init__(self, *, session: AlbertSession):
    super().__init__(session=session)
    self.base_path = f"/api/{BTModelSessionCollection._api_version}/btmodel"

base_path instance-attribute

base_path = f'/api/{_api_version}/btmodel'

create

create(*, model_session: BTModelSession) -> BTModelSession

Source code in src/albert/collections/btmodel.py

def create(self, *, model_session: BTModelSession) -> BTModelSession:
    response = self.session.post(
        self.base_path,
        json=model_session.model_dump(mode="json", by_alias=True, exclude_none=True),
    )
    return self._deserialize_with_session(response.json())

delete

delete(*, id: str) -> None

Delete a BTModelSession by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the BTModelSession to delete.	required

Returns:

Type	Description
None

Source code in src/albert/collections/btmodel.py

def delete(self, *, id: str) -> None:
    """Delete a BTModelSession by ID.

    Parameters
    ----------
    id : str
        The ID of the BTModelSession to delete.

    Returns
    -------
    None
    """
    self.session.delete(f"{self.base_path}/{id}")

get_by_id

get_by_id(*, id: str) -> BTModelSession

Source code in src/albert/collections/btmodel.py

def get_by_id(self, *, id: str) -> BTModelSession:
    response = self.session.get(f"{self.base_path}/{id}")
    return self._deserialize_with_session(response.json())

update

update(*, model_session: BTModelSession) -> BTModelSession

Source code in src/albert/collections/btmodel.py

def update(self, *, model_session: BTModelSession) -> BTModelSession:
    path = f"{self.base_path}/{model_session.id}"
    payload = self._generate_patch_payload(
        existing=self.get_by_id(id=model_session.id),
        updated=model_session,
    )
    self.session.patch(path, json=payload.model_dump(mode="json", by_alias=True))
    return self.get_by_id(id=model_session.id)

BaseCollection

BaseCollection(*, session: AlbertSession)

BaseCollection is the base class for all collection classes.

Parameters:

Name	Type	Description	Default
session	AlbertSession	The Albert API Session instance.	required

Source code in src/albert/collections/base.py

def __init__(self, *, session: AlbertSession):
    self.session = session

session instance-attribute

session = session