benchling_sdk.services.v2.stable.aa_sequence_service module

class AaSequenceService

Bases: benchling_sdk.services.v2.base_service.BaseService

AA Sequences.

AA Sequences are the working units of cells that make everything run (they help make structures, catalyze reactions and allow for signaling - a kind of internal cell communication). On Benchling, these are comprised of a string of amino acids and collections of other attributes, such as annotations. See https://benchling.com/api/reference#/AA%20Sequences

archive(aa_sequence_ids: Iterable[str], reason: EntityArchiveReason) → AaSequencesArchivalChange

Archive an AA Sequence.

See https://benchling.com/api/reference#/AA%20Sequences/archiveAASequences

auto_annotate(auto_annotate: AutoAnnotateAaSequences) → TaskHelper[EmptyTaskResponse]

Auto-annotate AA sequences with matching features from specified Feature Libraries.

See https://benchling.com/api/reference#/AA%20Sequences/autoAnnotateAaSequences

back_translate(translate: BackTranslate) → TaskHelper[BulkCreateDnaSequencesAsyncTaskResponse]

Create back-translated DNA sequences from AA sequences.

See https://benchling.com/api/v2/reference#/AA%20Sequences/backTranslate

bulk_create(aa_sequences: Iterable[AaSequenceBulkCreate]) → TaskHelper[BulkCreateAaSequencesAsyncTaskResponse]

Bulk create AA sequences.

See https://benchling.com/api/reference#/AA%20Sequences/bulkCreateAASequences

bulk_get(aa_sequence_ids: Iterable[str], returning: Optional[Iterable[str]] = None) → Optional[List[AaSequence]]

Bulk get AA sequences by ID.

See https://benchling.com/api/reference#/AA%20Sequences/bulkGetAASequences

bulk_update(aa_sequences: Iterable[AaSequenceBulkUpdate]) → TaskHelper[BulkUpdateAaSequencesAsyncTaskResponse]

Bulk update AA sequences.

See https://benchling.com/api/reference#/AA%20Sequences/bulkUpdateAASequences

bulk_upsert(body: AaSequencesBulkUpsertRequest, returning: Optional[Iterable[str]] = None) → TaskHelper[BulkUpdateAaSequencesAsyncTaskResponse]

Bulk create or update AA sequences.

See https://benchling.com/api/reference#/AA%20Sequences/bulkUpsertAASequences

create(aa_sequence: AaSequenceCreate) → AaSequence

Create an AA Sequence.

See https://benchling.com/api/reference#/AA%20Sequences/createAASequence

find_matching_regions(find_matching_region: AaSequencesFindMatchingRegion) → TaskHelper[FindMatchingRegionsAsyncTaskResponse]

Find matching regions for AA sequences.

See https://benchling.com/api/v2/reference#/AA%20Sequences/findMatchingRegionsAaSequences

get_by_id(aa_sequence_id: str, returning: Optional[Iterable[str]] = None) → AaSequence

Get an AA Sequence.

See https://benchling.com/api/reference#/AA%20Sequences/getAASequence

list(modified_at: Optional[str] = None, name: Optional[str] = None, amino_acids: Optional[str] = None, folder_id: Optional[str] = None, mentioned_in: Optional[List[str]] = None, project_id: Optional[str] = None, registry_id: Optional[str] = None, schema_id: Optional[str] = None, archive_reason: Optional[str] = None, mentions: Optional[List[str]] = None, ids: Optional[Iterable[str]] = None, entity_registry_ids_any_of: Optional[Iterable[str]] = None, name_includes: Optional[str] = None, names_any_of: Optional[Iterable[str]] = None, names_any_of_case_sensitive: Optional[Iterable[str]] = None, schema_fields: Optional[Dict[str, Any]] = None, creator_ids: Optional[Iterable[str]] = None, sort: Optional[Union[str, ListAASequencesSort]] = None, page_size: Optional[int] = None, author_idsany_of: Optional[Iterable[str]] = None, returning: Optional[Iterable[str]] = None) → PageIterator[AaSequence]

List AA Sequences.

See https://benchling.com/api/reference#/AA%20Sequences/listAASequences

match_amino_acids(match_bases: AaSequencesMatchBases) → PageIterator[AaSequence]

Return AA Sequences that exactly match the provided amino acids.

See https://benchling.com/api/reference#/AA%20Sequences/matchAminoAcidsAaSequences

search(search_request: AaSequencesSearchBases) → PageIterator[AaSequence]

Return AA Sequences that contain the provided amino acids.

Search indexing is asynchronous, so results my be not be available immediately after creation.

See https://benchling.com/api/reference#/AA%20Sequences/searchAaSequences

unarchive(aa_sequence_ids: Iterable[str]) → AaSequencesArchivalChange

Unarchive an AA Sequence.

See https://benchling.com/api/reference#/AA%20Sequences/unarchiveAASequences

update(aa_sequence_id: str, aa_sequence: AaSequenceUpdate) → AaSequence

Update an AA Sequence.

See https://benchling.com/api/reference#/AA%20Sequences/updateAASequence

upsert(entity_registry_id: str, aa_sequence: AaSequenceUpsert) → AaSequence

Create or modify an Amino Acid Sequence.

See https://benchling.com/api/reference#/AA%20Sequences/upsertAaSequence