benchling_sdk.services.v2.stable.connect_service module

class ConnectService

Bases: benchling_sdk.services.v2.base_service.BaseService

Connect.

Connect endpoints support Benchling Connect actions, like instrument data conversion.

See https://benchling.com/api/reference#/Connect

convert_to_asm(file_info: benchling_api_client.v2.stable.models.convert_to_asm.ConvertToASM) → benchling_api_client.v2.stable.models.convert_to_asm_response_200.ConvertToASMResponse_200

Convert an input blob or file containing instrument data to ASM (Allotrope Simple Model) JSON.

May provide the name of the instrument vendor (see /connect/list-allotropy-vendors) or the ID of a connection associated with an instrument vendor.

See https://benchling.com/api/reference#/Connect/convertToASM

convert_to_csv(file_info: benchling_api_client.v2.stable.models.convert_to_csv.ConvertToCSV) → List[benchling_api_client.v2.stable.models.convert_to_csv_response_200_item.ConvertToCSVResponse_200Item]

Convert a blob or file containing ASM, JSON, or instrument data to CSV.

If the file is ASM JSON, specify either no transform type (in which case all transform types will be returned), a matching transform type for the ASM schema, or a custom JSON mapper config.

If the file non-ASM JSON, must provide a JSON mapper config argument, which specifies how to map the JSON to CSV. Reach out to Benchling Support for more information about how to create a JSON mapper config.

If the file is an instrument file, must also specify an instrument vendor. The file will be converted first to ASM JSON and then to CSV. Only the CSV output will be returned.

May provide an AutomationOutputFile with CSV transform arguments configured to read the transform type or mapper config from.

May provide a connection ID associated with an instrument to read the vendor from.

See https://benchling.com/api/reference#/Connect/convertToCSV

list_allotropy_vendors() → List[None]

Return the list of available allotropy instrument vendor types.

See https://benchling.com/api/reference#/Connect/listAllotropyVendors