Design Candidate Sets (🧪Beta)
albert.collections.design_candidate_sets.DesignCandidateSetCollection
Bases: BaseCollection
Access design candidate sets in the Albert platform (🧪 Beta).
A candidate set holds the candidates a design run produced. Its ID is the
result_set_id of the completed run. Sets are read-only. List a set's candidates
with client.design_candidates.get_all(candidate_set_id=...).
This collection is accessed as client.design_candidate_sets.
Beta Feature!
Please do not use in production or without explicit guidance from Albert. You might otherwise have a bad experience. This feature currently falls outside of the Albert support contract, but we'd love your feedback!
Example
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
session
|
AlbertSession
|
The authenticated Albert session used for API calls. |
required |
Attributes:
| Name | Type | Description |
|---|---|---|
base_path |
str
|
The base API route for candidate-set requests. |
Methods:
| Name | Description |
|---|---|
get_by_id |
Get a candidate set by its ID. |
Source code in src/albert/collections/design_candidate_sets.py
get_by_id
get_by_id(
*, id: DesignCandidateSetId
) -> DesignCandidateSet
Get a candidate set by its ID.
Example
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
DesignCandidateSetId
|
The candidate set ID (format |
required |
Returns:
| Type | Description |
|---|---|
DesignCandidateSet
|
The fully populated DesignCandidateSet. |