Python SDK reference

Contents:

  • Annotation Import
    • AnnotationImport
      • AnnotationImport.errors
      • AnnotationImport.inputs
      • AnnotationImport.refresh()
      • AnnotationImport.statuses
      • AnnotationImport.wait_till_done()
    • CreatableAnnotationImport
    • LabelImport
      • LabelImport.create_from_file()
      • LabelImport.create_from_objects()
      • LabelImport.create_from_url()
      • LabelImport.from_name()
      • LabelImport.parent_id
    • MALPredictionImport
      • MALPredictionImport.create_from_file()
      • MALPredictionImport.create_from_objects()
      • MALPredictionImport.create_from_url()
      • MALPredictionImport.delete()
      • MALPredictionImport.from_name()
      • MALPredictionImport.parent_id
    • MEAPredictionImport
      • MEAPredictionImport.create_from_file()
      • MEAPredictionImport.create_from_objects()
      • MEAPredictionImport.create_from_url()
      • MEAPredictionImport.from_name()
      • MEAPredictionImport.parent_id
    • MEAToMALPredictionImport
      • MEAToMALPredictionImport.create_for_model_run_data_rows()
      • MEAToMALPredictionImport.from_name()
      • MEAToMALPredictionImport.parent_id
  • App
    • App
      • App.model_computed_fields
      • App.model_config
      • App.model_fields
  • Asset Attachment
    • AssetAttachment
      • AssetAttachment.attachment_type
      • AssetAttachment.attachment_value
      • AssetAttachment.attachment_name
      • AssetAttachment.delete()
      • AssetAttachment.update()
    • AttachmentType
  • Batch
    • Batch
      • Batch.name
      • Batch.created_at
      • Batch.updated_at
      • Batch.deleted
      • Batch.project
      • Batch.created_by
      • Batch.delete()
      • Batch.delete_labels()
      • Batch.project()
      • Batch.remove_queued_data_rows()
  • Benchmark
    • Benchmark
      • Benchmark.created_at
      • Benchmark.last_activity
      • Benchmark.average_agreement
      • Benchmark.completed_count
      • Benchmark.created_by
      • Benchmark.reference_label
  • Client
    • Client
      • Client.__init__()
      • Client.assign_global_keys_to_data_rows()
      • Client.build_catalog_query()
      • Client.clear_global_keys()
      • Client.create_dataset()
      • Client.create_embedding()
      • Client.create_feature_schema()
      • Client.create_model()
      • Client.create_model_config()
      • Client.create_model_evaluation_project()
      • Client.create_offline_model_evaluation_project()
      • Client.create_ontology()
      • Client.create_ontology_from_feature_schemas()
      • Client.create_project()
      • Client.create_prompt_response_generation_project()
      • Client.create_response_creation_project()
      • Client.delete_feature_schema_from_ontology()
      • Client.delete_model_config()
      • Client.delete_unused_feature_schema()
      • Client.delete_unused_ontology()
      • Client.execute()
      • Client.get_catalog_slice()
      • Client.get_data_row()
      • Client.get_data_row_by_global_key()
      • Client.get_data_row_ids_for_external_ids()
      • Client.get_data_row_ids_for_global_keys()
      • Client.get_data_row_metadata_ontology()
      • Client.get_dataset()
      • Client.get_datasets()
      • Client.get_embedding_by_id()
      • Client.get_embedding_by_name()
      • Client.get_embeddings()
      • Client.get_feature_schema()
      • Client.get_feature_schemas()
      • Client.get_labeling_service_dashboards()
      • Client.get_model()
      • Client.get_model_run()
      • Client.get_model_slice()
      • Client.get_models()
      • Client.get_ontologies()
      • Client.get_ontology()
      • Client.get_organization()
      • Client.get_project()
      • Client.get_projects()
      • Client.get_roles()
      • Client.get_task_by_id()
      • Client.get_unused_feature_schemas()
      • Client.get_unused_ontologies()
      • Client.get_user()
      • Client.get_users()
      • Client.insert_feature_schema_into_ontology()
      • Client.is_feature_schema_archived()
      • Client.run_foundry_app()
      • Client.send_to_annotate_from_catalog()
      • Client.unarchive_feature_schema_node()
      • Client.update_feature_schema_title()
      • Client.upsert_feature_schema()
      • Client.upsert_label_feedback()
  • Conflict Resolution Strategy
    • ConflictResolutionStrategy
  • DataRow
    • DataRow
      • DataRow.external_id
      • DataRow.global_key
      • DataRow.row_data
      • DataRow.updated_at
      • DataRow.created_at
      • DataRow.media_attributes
      • DataRow.metadata_fields
      • DataRow.metadata
      • DataRow.dataset
      • DataRow.created_by
      • DataRow.organization
      • DataRow.labels
      • DataRow.attachments
      • DataRow.bulk_delete()
      • DataRow.create_attachment()
      • DataRow.export()
      • DataRow.export_v2()
      • DataRow.get_winning_label_id()
      • DataRow.update()
    • KeyType
      • KeyType.AUTO
      • KeyType.GKEY
      • KeyType.ID
  • DataRow Metadata
    • DataRowMetadata
      • DataRowMetadata.model_computed_fields
      • DataRowMetadata.model_config
      • DataRowMetadata.model_fields
    • DataRowMetadataBatchResponse
      • DataRowMetadataBatchResponse.model_computed_fields
      • DataRowMetadataBatchResponse.model_config
      • DataRowMetadataBatchResponse.model_fields
    • DataRowMetadataField
      • DataRowMetadataField.model_computed_fields
      • DataRowMetadataField.model_config
      • DataRowMetadataField.model_fields
    • DataRowMetadataKind
    • DataRowMetadataOntology
      • DataRowMetadataOntology.bulk_delete()
      • DataRowMetadataOntology.bulk_export()
      • DataRowMetadataOntology.bulk_upsert()
      • DataRowMetadataOntology.create_schema()
      • DataRowMetadataOntology.delete_schema()
      • DataRowMetadataOntology.get_by_name()
      • DataRowMetadataOntology.parse_metadata()
      • DataRowMetadataOntology.parse_metadata_fields()
      • DataRowMetadataOntology.parse_upsert_metadata()
      • DataRowMetadataOntology.refresh_ontology()
      • DataRowMetadataOntology.update_enum_option()
      • DataRowMetadataOntology.update_schema()
    • DataRowMetadataSchema
      • DataRowMetadataSchema.model_computed_fields
      • DataRowMetadataSchema.model_config
      • DataRowMetadataSchema.model_fields
    • DeleteDataRowMetadata
      • DeleteDataRowMetadata.model_computed_fields
      • DeleteDataRowMetadata.model_config
      • DeleteDataRowMetadata.model_fields
  • Dataset
    • Dataset
      • Dataset.name
      • Dataset.description
      • Dataset.updated_at
      • Dataset.created_at
      • Dataset.row_count
      • Dataset.created_by
      • Dataset.organization
      • Dataset.add_iam_integration()
      • Dataset.create_data_row()
      • Dataset.create_data_rows()
      • Dataset.data_row_for_external_id()
      • Dataset.data_rows()
      • Dataset.data_rows_for_external_id()
      • Dataset.export()
      • Dataset.export_v2()
      • Dataset.remove_iam_integration()
      • Dataset.upsert_data_rows()
  • Embedding
    • Embedding
      • Embedding.id
      • Embedding.name
      • Embedding.dims
      • Embedding.custom
      • Embedding.delete()
      • Embedding.get_imported_vector_count()
      • Embedding.import_vectors_from_file()
      • Embedding.model_computed_fields
      • Embedding.model_config
      • Embedding.model_fields
      • Embedding.model_post_init()
  • Enums
    • AnnotationImportState
    • CollectionJobStatus
  • Exceptions
    • ApiLimitError
    • AuthenticationError
    • AuthorizationError
    • ConfidenceNotSupportedException
    • CustomMetricsNotSupportedException
    • InconsistentOntologyException
    • InternalServerError
    • InvalidAttributeError
    • InvalidQueryError
    • LabelboxError
    • MALValidationError
    • MalformedQueryException
    • NetworkError
    • OperationNotAllowedException
    • OperationNotSupportedException
    • ProcessingWaitTimeout
    • ResourceConflict
    • ResourceCreationError
    • ResourceNotFoundError
    • TimeoutError
    • UnprocessableEntityError
    • UuidError
    • ValidationFailedError
    • error_message_for_unparsed_graphql_error()
  • Export Task
    • BufferedJsonConverterOutput
    • BufferedStream
      • BufferedStream.start()
    • ExportTask
      • ExportTask.ExportTaskException
      • ExportTask.completion_percentage
      • ExportTask.created_at
      • ExportTask.created_by
      • ExportTask.deleted
      • ExportTask.errors
      • ExportTask.errors_url
      • ExportTask.get_buffered_stream()
      • ExportTask.get_task()
      • ExportTask.get_total_file_size()
      • ExportTask.get_total_lines()
      • ExportTask.has_errors()
      • ExportTask.has_result()
      • ExportTask.metadata
      • ExportTask.name
      • ExportTask.organization
      • ExportTask.result
      • ExportTask.result_url
      • ExportTask.status
      • ExportTask.type
      • ExportTask.uid
      • ExportTask.updated_at
      • ExportTask.wait_till_done()
    • StreamType
  • Fact Checking Tool
    • FactCheckingActions
    • FactCheckingTool
  • Foundry Client
  • Foundry Model
    • Model
      • Model.model_computed_fields
      • Model.model_config
      • Model.model_fields
  • Identifiable
    • GlobalKey
    • Identifiable
    • UniqueId
  • Identifiables
    • DataRowIds
    • GlobalKeys
    • UniqueIds
  • Label
    • Label
      • Label.label
      • Label.seconds_to_label
      • Label.agreement
      • Label.benchmark_agreement
      • Label.is_benchmark_reference
      • Label.project
      • Label.data_row
      • Label.reviews
      • Label.created_by
      • Label.bulk_delete()
      • Label.create_benchmark()
      • Label.create_review()
  • Label Score
    • LabelScore
      • LabelScore.name
      • LabelScore.score
      • LabelScore.model_computed_fields
      • LabelScore.model_config
      • LabelScore.model_fields
  • Labeling Frontend
    • LabelingFrontend
  • Labeling Frontend Options
  • Labeling Parameter Override
  • Labeling Service
    • LabelingService
      • LabelingService.dashboard()
      • LabelingService.get()
      • LabelingService.getOrCreate()
      • LabelingService.model_computed_fields
      • LabelingService.model_config
      • LabelingService.model_fields
      • LabelingService.request()
      • LabelingService.start()
  • Labeling Service Dashboard
    • LabelingServiceDashboard
      • LabelingServiceDashboard.id
      • LabelingServiceDashboard.name
      • LabelingServiceDashboard.status
      • LabelingServiceDashboard.data_rows_count
      • LabelingServiceDashboard.tasks_completed_count
      • LabelingServiceDashboard.tasks_remaining_count
      • LabelingServiceDashboard.tags
      • LabelingServiceDashboard.media_type
      • LabelingServiceDashboard.editor_task_type
      • LabelingServiceDashboard.client
      • LabelingServiceDashboard.get()
      • LabelingServiceDashboard.model_computed_fields
      • LabelingServiceDashboard.model_config
      • LabelingServiceDashboard.model_fields
      • LabelingServiceDashboard.service_type
    • LabelingServiceDashboardTags
      • LabelingServiceDashboardTags.model_computed_fields
      • LabelingServiceDashboardTags.model_config
      • LabelingServiceDashboardTags.model_fields
  • Model
    • Model
      • Model.model_runs
      • Model.create_model_run()
      • Model.delete()
  • Model Config
    • ModelConfig
      • ModelConfig.inference_params
      • ModelConfig.model_id
      • ModelConfig.name
  • Model Run
    • DataSplit
    • ModelRun
      • ModelRun.Status
      • ModelRun.add_predictions()
      • ModelRun.delete()
      • ModelRun.delete_model_run_data_rows()
      • ModelRun.export()
      • ModelRun.export_v2()
      • ModelRun.get_config()
      • ModelRun.reset_config()
      • ModelRun.send_to_annotate_from_model()
      • ModelRun.update_config()
      • ModelRun.upsert_data_rows()
      • ModelRun.upsert_labels()
      • ModelRun.upsert_predictions_and_send_to_project()
    • ModelRunDataRow
  • Ontology
    • FeatureSchema
    • Ontology
      • Ontology.description
      • Ontology.updated_at
      • Ontology.created_at
      • Ontology.normalized
      • Ontology.object_schema_count
      • Ontology.classification_schema_count
      • Ontology.projects
      • Ontology.created_by
      • Ontology.classifications()
      • Ontology.tools()
    • OntologyBuilder
      • OntologyBuilder.tools
      • OntologyBuilder.classifications
  • Organization
    • Organization
      • Organization.updated_at
      • Organization.created_at
      • Organization.name
      • Organization.users
      • Organization.projects
      • Organization.webhooks
      • Organization.create_resource_tag()
      • Organization.get_default_iam_integration()
      • Organization.get_iam_integrations()
      • Organization.get_resource_tags()
      • Organization.invite_limit()
      • Organization.invite_user()
      • Organization.remove_user()
  • Pagination
    • PaginatedCollection
      • PaginatedCollection.__init__()
      • PaginatedCollection.get_many()
      • PaginatedCollection.get_one()
  • Project
    • Project
      • Project.name
      • Project.description
      • Project.updated_at
      • Project.created_at
      • Project.setup_complete
      • Project.last_activity_time
      • Project.auto_audit_number_of_labels
      • Project.auto_audit_percentage
      • Project.is_benchmark_enabled
      • Project.is_consensus_enabled
      • Project.created_by
      • Project.organization
      • Project.labeling_frontend
      • Project.labeling_frontend_options
      • Project.labeling_parameter_overrides
      • Project.webhooks
      • Project.benchmarks
      • Project.ontology
      • Project.task_queues
      • Project.add_model_config()
      • Project.batches()
      • Project.clone()
      • Project.connect_ontology()
      • Project.create_batch()
      • Project.create_batches()
      • Project.create_batches_from_dataset()
      • Project.delete_project_model_config()
      • Project.enable_model_assisted_labeling()
      • Project.export()
      • Project.export_issues()
      • Project.export_v2()
      • Project.extend_reservations()
      • Project.get_label_count()
      • Project.get_label_imports()
      • Project.get_labeling_service()
      • Project.get_labeling_service_dashboard()
      • Project.get_labeling_service_status()
      • Project.get_mal_prediction_imports()
      • Project.get_overview()
      • Project.get_resource_tags()
      • Project.is_chat_evaluation()
      • Project.is_prompt_response()
      • Project.labeler_performance()
      • Project.labels()
      • Project.members()
      • Project.move_data_rows_to_task_queue()
      • Project.review_metrics()
      • Project.set_labeling_parameter_overrides()
      • Project.set_project_model_setup_complete()
      • Project.task_queues()
      • Project.update()
      • Project.update_data_row_labeling_priority()
      • Project.update_project_resource_tags()
      • Project.upsert_instructions()
    • ProjectMember
  • Project Model Config
    • ProjectModelConfig
      • ProjectModelConfig.project_id
      • ProjectModelConfig.model_config_id
      • ProjectModelConfig.model_config
      • ProjectModelConfig.delete()
  • Step Reasoning Tool
    • PromptIssueTool
  • Quality Mode
    • QualityMode
  • Request Client
    • RequestClient
      • RequestClient.execute()
  • Resource Tag
    • ResourceTag
      • ResourceTag.text
      • ResourceTag.color
      • ResourceTag.project_resource_tag
  • Review
    • Review
      • Review.created_at
      • Review.updated_at
      • Review.score
      • Review.created_by
      • Review.organization
      • Review.project
      • Review.label
      • Review.NetScore
  • Search Filters
    • BaseSearchFilter
      • BaseSearchFilter.model_computed_fields
      • BaseSearchFilter.model_config
      • BaseSearchFilter.model_fields
    • DateRange
      • DateRange.model_computed_fields
      • DateRange.model_config
      • DateRange.model_fields
    • DateRangeValue
      • DateRangeValue.model_computed_fields
      • DateRangeValue.model_config
      • DateRangeValue.model_fields
    • DateValue
      • DateValue.model_computed_fields
      • DateValue.model_config
      • DateValue.model_fields
    • IdOperator
    • IntegerValue
      • IntegerValue.model_computed_fields
      • IntegerValue.model_config
      • IntegerValue.model_fields
    • OperationTypeEnum
    • OrganizationFilter
      • OrganizationFilter.model_computed_fields
      • OrganizationFilter.model_config
      • OrganizationFilter.model_fields
    • ProjectStageFilter
      • ProjectStageFilter.model_computed_fields
      • ProjectStageFilter.model_config
      • ProjectStageFilter.model_fields
    • RangeDateTimeOperatorWithSingleValue
    • RangeOperatorWithSingleValue
    • RangeOperatorWithValue
    • SharedWithOrganizationFilter
      • SharedWithOrganizationFilter.model_computed_fields
      • SharedWithOrganizationFilter.model_config
      • SharedWithOrganizationFilter.model_fields
    • TagFilter
      • TagFilter.model_computed_fields
      • TagFilter.model_config
      • TagFilter.model_fields
    • TaskCompletedCountFilter
      • TaskCompletedCountFilter.model_computed_fields
      • TaskCompletedCountFilter.model_config
      • TaskCompletedCountFilter.model_fields
    • TaskRemainingCountFilter
      • TaskRemainingCountFilter.model_computed_fields
      • TaskRemainingCountFilter.model_config
      • TaskRemainingCountFilter.model_fields
    • WorkforceRequestedDateFilter
      • WorkforceRequestedDateFilter.model_computed_fields
      • WorkforceRequestedDateFilter.model_config
      • WorkforceRequestedDateFilter.model_fields
    • WorkforceRequestedDateRangeFilter
      • WorkforceRequestedDateRangeFilter.model_computed_fields
      • WorkforceRequestedDateRangeFilter.model_config
      • WorkforceRequestedDateRangeFilter.model_fields
    • WorkforceStageUpdatedFilter
      • WorkforceStageUpdatedFilter.model_computed_fields
      • WorkforceStageUpdatedFilter.model_config
      • WorkforceStageUpdatedFilter.model_fields
    • WorkforceStageUpdatedRangeFilter
      • WorkforceStageUpdatedRangeFilter.model_computed_fields
      • WorkforceStageUpdatedRangeFilter.model_config
      • WorkforceStageUpdatedRangeFilter.model_fields
    • WorkspaceFilter
      • WorkspaceFilter.model_computed_fields
      • WorkspaceFilter.model_config
      • WorkspaceFilter.model_fields
    • build_search_filter()
  • Send To Annotate Params
    • SendToAnnotateFromCatalogParams
      • SendToAnnotateFromCatalogParams.model_computed_fields
      • SendToAnnotateFromCatalogParams.model_config
      • SendToAnnotateFromCatalogParams.model_fields
    • SendToAnnotateFromModelParams
  • Slice
    • CatalogSlice
      • CatalogSlice.export()
      • CatalogSlice.export_v2()
      • CatalogSlice.get_data_row_identifiers()
    • ModelSlice
      • ModelSlice.get_data_row_identifiers()
      • ModelSlice.get_data_row_ids()
    • Slice
      • Slice.name
      • Slice.description
      • Slice.created_at
      • Slice.updated_at
      • Slice.filter
      • Slice.DataRowIdAndGlobalKey
  • Step Reasoning Tool
    • IncorrectStepActions
    • StepReasoningTool
  • Task
    • DataUpsertTask
      • DataUpsertTask.created_data_rows
      • DataUpsertTask.errors
      • DataUpsertTask.failed_data_rows
      • DataUpsertTask.result
    • Task
      • Task.updated_at
      • Task.created_at
      • Task.name
      • Task.status
      • Task.completion_percentage
      • Task.created_by
      • Task.organization
      • Task.created_data_rows
      • Task.errors
      • Task.failed_data_rows
      • Task.refresh()
      • Task.result
      • Task.wait_till_done()
  • Task Queue
    • TaskQueue
  • User
    • User
      • User.updated_at
      • User.created_at
      • User.email
      • User.name
      • User.nickname
      • User.picture
      • User.is_viewer
      • User.is_external_viewer
      • User.organization
      • User.created_tasks
      • User.projects
      • User.remove_from_project()
      • User.update_org_role()
      • User.upsert_project_role()
  • Webhook
    • Webhook
      • Webhook.updated_at
      • Webhook.created_at
      • Webhook.url
      • Webhook.topics
      • Webhook.status
      • Webhook.Status
      • Webhook.Topic
      • Webhook.create()
      • Webhook.delete()
      • Webhook.update()
Python SDK reference
  • Search

© Copyright 2024, Labelbox.

Built with Sphinx using a theme provided by Read the Docs.