openapi: 3.1.0 info: title: LangSmith access_policies annotation-queues API description: 'The LangSmith API is used to programmatically create and manage LangSmith resources. ## Host https://api.smith.langchain.com ## Authentication To authenticate with the LangSmith API, set the `X-Api-Key` header to a valid [LangSmith API key](https://docs.langchain.com/langsmith/create-account-api-key#create-an-api-key). ' version: 0.1.0 servers: - url: / tags: - name: annotation-queues paths: /api/v1/annotation-queues: get: tags: - annotation-queues summary: Get Annotation Queues operationId: get_annotation_queues_api_v1_annotation_queues_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: ids in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Ids - name: name in: query required: false schema: anyOf: - type: string - type: 'null' title: Name - name: name_contains in: query required: false schema: anyOf: - type: string - type: 'null' title: Name Contains - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 100 title: Limit - name: tag_value_id in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Tag Value Id - name: dataset_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Dataset Id - name: queue_type in: query required: false schema: anyOf: - enum: - single - pairwise type: string - type: 'null' title: Queue Type - name: assigned_to_me in: query required: false schema: type: boolean default: false title: Assigned To Me - name: sort_by in: query required: false schema: anyOf: - type: string - type: 'null' title: Sort By - name: sort_by_desc in: query required: false schema: type: boolean default: true title: Sort By Desc responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AnnotationQueueSchemaWithSize' title: Response Get Annotation Queues Api V1 Annotation Queues Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - annotation-queues summary: Create Annotation Queue operationId: create_annotation_queue_api_v1_annotation_queues_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueCreateSchema' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - annotation-queues summary: Delete Annotation Queues description: "Delete multiple annotation queues with partial success support.\n\nReturns:\n - 200: All queues deleted successfully\n - 207: Some queues deleted successfully, some failed" operationId: delete_annotation_queues_api_v1_annotation_queues_delete security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_ids in: query required: true schema: type: array items: type: string format: uuid maxItems: 100 title: Queue Ids responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/populate: post: tags: - annotation-queues summary: Populate Annotation Queue description: Populate annotation queue with runs from an experiment. operationId: populate_annotation_queue_api_v1_annotation_queues_populate_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PopulateAnnotationQueueSchema' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] /api/v1/annotation-queues/{queue_id}: delete: tags: - annotation-queues summary: Delete Annotation Queue operationId: delete_annotation_queue_api_v1_annotation_queues__queue_id__delete security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - annotation-queues summary: Update Annotation Queue operationId: update_annotation_queue_api_v1_annotation_queues__queue_id__patch security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueUpdateSchema' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - annotation-queues summary: Get Annotation Queue operationId: get_annotation_queue_api_v1_annotation_queues__queue_id__get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueSchemaWithRubric' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/runs: post: tags: - annotation-queues summary: Add Runs To Annotation Queue operationId: add_runs_to_annotation_queue_api_v1_annotation_queues__queue_id__runs_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id requestBody: required: true content: application/json: schema: anyOf: - type: array items: type: string format: uuid - type: array items: $ref: '#/components/schemas/AnnotationQueueRunAddSchema' title: Runs responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AnnotationQueueRunSchema' title: Response Add Runs To Annotation Queue Api V1 Annotation Queues Queue Id Runs Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - annotation-queues summary: Get Runs From Annotation Queue operationId: get_runs_from_annotation_queue_api_v1_annotation_queues__queue_id__runs_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 100 title: Limit - name: archived in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Archived - name: include_stats in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Include Stats - name: status in: query required: false schema: anyOf: - enum: - needs_my_review - needs_others_review - completed type: string - type: 'null' title: Status responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/RunSchemaWithAnnotationQueueInfo' title: Response Get Runs From Annotation Queue Api V1 Annotation Queues Queue Id Runs Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/runs/by-key: post: tags: - annotation-queues summary: Add Runs To Annotation Queue By Key operationId: add_runs_to_annotation_queue_by_key_api_v1_annotation_queues__queue_id__runs_by_key_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/AddRunToQueueByKeyRequest' title: Runs responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AnnotationQueueRunSchema' title: Response Add Runs To Annotation Queue By Key Api V1 Annotation Queues Queue Id Runs By Key Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/export: post: tags: - annotation-queues summary: Export Annotation Queue Archived Runs operationId: export_annotation_queue_archived_runs_api_v1_annotation_queues__queue_id__export_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExportAnnotationQueueRunsRequest' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/run/{index}: get: tags: - annotation-queues summary: Get Run From Annotation Queue description: Get a run from an annotation queue operationId: get_run_from_annotation_queue_api_v1_annotation_queues__queue_id__run__index__get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id - name: index in: path required: true schema: type: integer title: Index - name: include_extra in: query required: false schema: type: boolean default: false title: Include Extra responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RunSchemaWithAnnotationQueueInfo' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{run_id}/queues: get: tags: - annotation-queues summary: Get Annotation Queues For Run operationId: get_annotation_queues_for_run_api_v1_annotation_queues__run_id__queues_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: run_id in: path required: true schema: type: string format: uuid title: Run Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AnnotationQueueSchema' title: Response Get Annotation Queues For Run Api V1 Annotation Queues Run Id Queues Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/runs/{queue_run_id}: patch: tags: - annotation-queues summary: Update Run In Annotation Queue operationId: update_run_in_annotation_queue_api_v1_annotation_queues__queue_id__runs__queue_run_id__patch security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id - name: queue_run_id in: path required: true schema: type: string format: uuid title: Queue Run Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueRunUpdateSchema' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - annotation-queues summary: Delete Run From Annotation Queue operationId: delete_run_from_annotation_queue_api_v1_annotation_queues__queue_id__runs__queue_run_id__delete security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id - name: queue_run_id in: path required: true schema: type: string format: uuid title: Queue Run Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/runs/delete: post: tags: - annotation-queues summary: Delete Runs From Annotation Queue operationId: delete_runs_from_annotation_queue_api_v1_annotation_queues__queue_id__runs_delete_post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueBulkDeleteRunsRequest' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/total_size: get: tags: - annotation-queues summary: Get Total Size From Annotation Queue operationId: get_total_size_from_annotation_queue_api_v1_annotation_queues__queue_id__total_size_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueSizeSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/total_archived: get: tags: - annotation-queues summary: Get Total Archived From Annotation Queue operationId: get_total_archived_from_annotation_queue_api_v1_annotation_queues__queue_id__total_archived_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id - name: start_time in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Time - name: end_time in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Time responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueSizeSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/size: get: tags: - annotation-queues summary: Get Size From Annotation Queue operationId: get_size_from_annotation_queue_api_v1_annotation_queues__queue_id__size_get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id - name: status in: query required: false schema: anyOf: - enum: - needs_my_review - needs_others_review - completed type: string - type: 'null' title: Status responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AnnotationQueueSizeSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/status/{annotation_queue_run_id}: post: tags: - annotation-queues summary: Create Identity Annotation Queue Run Status operationId: create_identity_annotation_queue_run_status_api_v1_annotation_queues_status__annotation_queue_run_id__post security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: annotation_queue_run_id in: path required: true schema: type: string format: uuid title: Annotation Queue Run Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IdentityAnnotationQueueRunStatusCreateSchema' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/annotation-queues/{queue_id}/runs/resolve/{queue_run_id}: get: tags: - annotation-queues summary: Resolve Annotation Queue Run description: Resolve a queue run ID to its section and run data for deep linking. operationId: resolve_annotation_queue_run_api_v1_annotation_queues__queue_id__runs_resolve__queue_run_id__get security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] parameters: - name: queue_id in: path required: true schema: type: string format: uuid title: Queue Id - name: queue_run_id in: path required: true schema: type: string format: uuid title: Queue Run Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResolvedAnnotationQueueRunSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/platform/annotation-queues/{queue_id}/reviewers: post: security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] description: Assigns a single identity as a reviewer for the queue. Idempotent. tags: - annotation-queues summary: Add a reviewer to an annotation queue parameters: - description: Queue ID name: queue_id in: path required: true schema: type: string responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/annotationqueues.AddReviewerResponse' '400': description: Bad Request content: application/json: schema: type: object additionalProperties: type: string '404': description: Not Found content: application/json: schema: type: object additionalProperties: type: string '500': description: Internal Server Error content: application/json: schema: type: object additionalProperties: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/annotationqueues.AddReviewerRequest' /v1/platform/annotation-queues/{queue_id}/reviewers/{identity_id}: delete: security: - API Key: [] - Tenant ID: [] - Bearer Auth: [] description: Unassigns an identity as a reviewer for the queue. Idempotent. tags: - annotation-queues summary: Remove a reviewer from an annotation queue parameters: - description: Queue ID name: queue_id in: path required: true schema: type: string - description: Identity ID of the reviewer to remove name: identity_id in: path required: true schema: type: string responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object additionalProperties: type: string '404': description: Not Found content: application/json: schema: type: object additionalProperties: type: string '500': description: Internal Server Error content: application/json: schema: type: object additionalProperties: type: string components: schemas: AssignedReviewerSchema: properties: id: type: string format: uuid title: Id name: anyOf: - type: string - type: 'null' title: Name email: anyOf: - type: string - type: 'null' title: Email type: object required: - id title: AssignedReviewerSchema description: Identity info for an assigned reviewer on an annotation queue. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError AnnotationQueueBulkDeleteRunsRequest: properties: delete_all: type: boolean title: Delete All default: false run_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Run Ids exclude_run_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Exclude Run Ids type: object title: AnnotationQueueBulkDeleteRunsRequest AnnotationQueueRubricItemSchema: properties: feedback_key: type: string title: Feedback Key description: anyOf: - type: string - type: 'null' title: Description value_descriptions: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Value Descriptions score_descriptions: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Score Descriptions is_required: anyOf: - type: boolean - type: 'null' title: Is Required is_assertion: anyOf: - type: boolean - type: 'null' title: Is Assertion type: object required: - feedback_key title: AnnotationQueueRubricItemSchema HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ExportAnnotationQueueRunsRequest: properties: start_time: anyOf: - type: string format: date-time - type: 'null' title: Start Time end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time include_annotator_detail: type: boolean title: Include Annotator Detail default: false type: object title: ExportAnnotationQueueRunsRequest description: Export annotation queue runs request schema. IdentityAnnotationQueueRunStatusCreateSchema: properties: status: anyOf: - type: string - type: 'null' title: Status override_added_at: anyOf: - type: string format: date-time - type: 'null' title: Override Added At type: object title: IdentityAnnotationQueueRunStatusCreateSchema description: Identity annotation queue run status create schema. PopulateAnnotationQueueSchema: properties: queue_id: type: string format: uuid title: Queue Id session_ids: items: type: string format: uuid type: array title: Session Ids type: object required: - queue_id - session_ids title: PopulateAnnotationQueueSchema AnnotationQueueSchema: properties: description: anyOf: - type: string - type: 'null' title: Description created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At num_reviewers_per_item: anyOf: - type: integer - type: 'null' title: Num Reviewers Per Item default: 1 enable_reservations: anyOf: - type: boolean - type: 'null' title: Enable Reservations default: true reservation_minutes: anyOf: - type: integer - type: 'null' title: Reservation Minutes default: 1 reviewer_access_mode: type: string title: Reviewer Access Mode default: any name: type: string title: Name id: type: string format: uuid title: Id tenant_id: type: string format: uuid title: Tenant Id source_rule_id: anyOf: - type: string format: uuid - type: 'null' title: Source Rule Id run_rule_id: anyOf: - type: string format: uuid - type: 'null' title: Run Rule Id default_dataset: anyOf: - type: string format: uuid - type: 'null' title: Default Dataset queue_type: type: string enum: - single - pairwise title: Queue Type metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata assigned_reviewers: items: $ref: '#/components/schemas/AssignedReviewerSchema' type: array title: Assigned Reviewers default: [] type: object required: - name - id - tenant_id - queue_type title: AnnotationQueueSchema description: AnnotationQueue schema. annotationqueues.AddReviewerRequest: type: object required: - identity_id properties: identity_id: type: string AnnotationQueueSizeSchema: properties: size: type: integer title: Size type: object required: - size title: AnnotationQueueSizeSchema description: Size of an Annotation Queue AnnotationQueueRunSchema: properties: run_id: type: string format: uuid title: Run Id queue_id: type: string format: uuid title: Queue Id last_reviewed_time: anyOf: - type: string format: date-time - type: 'null' title: Last Reviewed Time added_at: type: string format: date-time title: Added At id: type: string format: uuid title: Id type: object required: - run_id - queue_id - id title: AnnotationQueueRunSchema AddRunToQueueByKeyRequest: properties: run_id: type: string format: uuid title: Run Id session_id: type: string format: uuid title: Session Id start_time: type: string format: date-time title: Start Time type: object required: - run_id - session_id - start_time title: AddRunToQueueByKeyRequest description: Add run to AQ by SmithDB key. is_root derived server-side (LSAQ-141). AnnotationQueueCreateSchema: properties: description: anyOf: - type: string - type: 'null' title: Description created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At num_reviewers_per_item: anyOf: - type: integer - type: 'null' title: Num Reviewers Per Item default: 1 enable_reservations: anyOf: - type: boolean - type: 'null' title: Enable Reservations default: true reservation_minutes: anyOf: - type: integer - type: 'null' title: Reservation Minutes default: 1 reviewer_access_mode: type: string title: Reviewer Access Mode default: any name: type: string title: Name id: type: string format: uuid title: Id default_dataset: anyOf: - type: string format: uuid - type: 'null' title: Default Dataset rubric_items: anyOf: - items: $ref: '#/components/schemas/AnnotationQueueRubricItemSchema' type: array - type: 'null' title: Rubric Items rubric_instructions: anyOf: - type: string - type: 'null' title: Rubric Instructions session_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Session Ids metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object required: - name title: AnnotationQueueCreateSchema description: AnnotationQueue schema. AnnotationQueueSchemaWithRubric: properties: description: anyOf: - type: string - type: 'null' title: Description created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At num_reviewers_per_item: anyOf: - type: integer - type: 'null' title: Num Reviewers Per Item default: 1 enable_reservations: anyOf: - type: boolean - type: 'null' title: Enable Reservations default: true reservation_minutes: anyOf: - type: integer - type: 'null' title: Reservation Minutes default: 1 reviewer_access_mode: type: string title: Reviewer Access Mode default: any name: type: string title: Name id: type: string format: uuid title: Id tenant_id: type: string format: uuid title: Tenant Id source_rule_id: anyOf: - type: string format: uuid - type: 'null' title: Source Rule Id run_rule_id: anyOf: - type: string format: uuid - type: 'null' title: Run Rule Id default_dataset: anyOf: - type: string format: uuid - type: 'null' title: Default Dataset queue_type: type: string enum: - single - pairwise title: Queue Type metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata assigned_reviewers: items: $ref: '#/components/schemas/AssignedReviewerSchema' type: array title: Assigned Reviewers default: [] rubric_items: anyOf: - items: $ref: '#/components/schemas/AnnotationQueueRubricItemSchema' type: array - type: 'null' title: Rubric Items rubric_instructions: anyOf: - type: string - type: 'null' title: Rubric Instructions type: object required: - name - id - tenant_id - queue_type title: AnnotationQueueSchemaWithRubric description: AnnotationQueue schema with rubric. AnnotationQueueRunAddSchema: properties: run_id: type: string format: uuid title: Run Id deprecated: true start_time: anyOf: - type: string format: date-time - type: 'null' title: Start Time deprecated: true session_id: anyOf: - type: string format: uuid - type: 'null' title: Session Id deprecated: true trace_id: anyOf: - type: string format: uuid - type: 'null' title: Trace Id deprecated: true parent_run_id: anyOf: - type: string format: uuid - type: 'null' title: Parent Run Id deprecated: true trace_tier: anyOf: - $ref: '#/components/schemas/TraceTier' - type: 'null' deprecated: true type: object required: - run_id title: AnnotationQueueRunAddSchema description: 'Deprecated: use plain UUID list or AddRunToQueueByKeyRequest instead.' RunSchemaWithAnnotationQueueInfo: properties: name: type: string title: Name inputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs inputs_preview: anyOf: - type: string - type: 'null' title: Inputs Preview run_type: $ref: '#/components/schemas/RunTypeEnum' start_time: type: string format: date-time title: Start Time end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra error: anyOf: - type: string - type: 'null' title: Error execution_order: type: integer minimum: 1.0 title: Execution Order default: 1 serialized: anyOf: - additionalProperties: true type: object - type: 'null' title: Serialized outputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs outputs_preview: anyOf: - type: string - type: 'null' title: Outputs Preview parent_run_id: anyOf: - type: string format: uuid - type: 'null' title: Parent Run Id manifest_id: anyOf: - type: string format: uuid - type: 'null' title: Manifest Id manifest_s3_id: anyOf: - type: string format: uuid - type: 'null' title: Manifest S3 Id events: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Events tags: anyOf: - items: type: string type: array - type: 'null' title: Tags inputs_s3_urls: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs S3 Urls outputs_s3_urls: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs S3 Urls s3_urls: anyOf: - additionalProperties: true type: object - type: 'null' title: S3 Urls trace_id: type: string format: uuid title: Trace Id dotted_order: type: string title: Dotted Order trace_min_start_time: anyOf: - type: string format: date-time - type: 'null' title: Trace Min Start Time trace_max_start_time: anyOf: - type: string format: date-time - type: 'null' title: Trace Max Start Time id: type: string format: uuid title: Id status: type: string title: Status child_run_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Child Run Ids direct_child_run_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Direct Child Run Ids parent_run_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Parent Run Ids feedback_stats: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Feedback Stats reference_example_id: anyOf: - type: string format: uuid - type: 'null' title: Reference Example Id total_tokens: type: integer title: Total Tokens default: 0 prompt_tokens: type: integer title: Prompt Tokens default: 0 completion_tokens: type: integer title: Completion Tokens default: 0 prompt_token_details: anyOf: - additionalProperties: type: integer type: object - type: 'null' title: Prompt Token Details completion_token_details: anyOf: - additionalProperties: type: integer type: object - type: 'null' title: Completion Token Details total_cost: anyOf: - type: string - type: 'null' title: Total Cost prompt_cost: anyOf: - type: string - type: 'null' title: Prompt Cost completion_cost: anyOf: - type: string - type: 'null' title: Completion Cost prompt_cost_details: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Prompt Cost Details completion_cost_details: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Completion Cost Details price_model_id: anyOf: - type: string format: uuid - type: 'null' title: Price Model Id first_token_time: anyOf: - type: string format: date-time - type: 'null' title: First Token Time messages: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Messages session_id: type: string format: uuid title: Session Id app_path: type: string title: App Path last_queued_at: anyOf: - type: string format: date-time - type: 'null' title: Last Queued At in_dataset: anyOf: - type: boolean - type: 'null' title: In Dataset share_token: anyOf: - type: string format: uuid - type: 'null' title: Share Token trace_tier: anyOf: - $ref: '#/components/schemas/TraceTier' - type: 'null' trace_first_received_at: anyOf: - type: string format: date-time - type: 'null' title: Trace First Received At ttl_seconds: anyOf: - type: integer - type: 'null' title: Ttl Seconds trace_upgrade: type: boolean title: Trace Upgrade default: false reference_dataset_id: anyOf: - type: string format: uuid - type: 'null' title: Reference Dataset Id thread_id: anyOf: - type: string - type: 'null' title: Thread Id queue_run_id: type: string format: uuid title: Queue Run Id last_reviewed_time: anyOf: - type: string format: date-time - type: 'null' title: Last Reviewed Time added_at: anyOf: - type: string format: date-time - type: 'null' title: Added At effective_added_at: anyOf: - type: string format: date-time - type: 'null' title: Effective Added At reserved_by: items: type: string format: uuid type: array title: Reserved By default: [] completed_by: items: type: string format: uuid type: array title: Completed By default: [] type: object required: - name - run_type - trace_id - dotted_order - id - status - session_id - app_path - queue_run_id title: RunSchemaWithAnnotationQueueInfo description: Run schema with annotation queue info. AnnotationQueueSchemaWithSize: properties: description: anyOf: - type: string - type: 'null' title: Description created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At num_reviewers_per_item: anyOf: - type: integer - type: 'null' title: Num Reviewers Per Item default: 1 enable_reservations: anyOf: - type: boolean - type: 'null' title: Enable Reservations default: true reservation_minutes: anyOf: - type: integer - type: 'null' title: Reservation Minutes default: 1 reviewer_access_mode: type: string title: Reviewer Access Mode default: any name: type: string title: Name id: type: string format: uuid title: Id tenant_id: type: string format: uuid title: Tenant Id source_rule_id: anyOf: - type: string format: uuid - type: 'null' title: Source Rule Id run_rule_id: anyOf: - type: string format: uuid - type: 'null' title: Run Rule Id default_dataset: anyOf: - type: string format: uuid - type: 'null' title: Default Dataset queue_type: type: string enum: - single - pairwise title: Queue Type metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata assigned_reviewers: items: $ref: '#/components/schemas/AssignedReviewerSchema' type: array title: Assigned Reviewers default: [] total_runs: type: integer title: Total Runs type: object required: - name - id - tenant_id - queue_type - total_runs title: AnnotationQueueSchemaWithSize description: AnnotationQueue schema with size. RunTypeEnum: type: string enum: - tool - chain - llm - retriever - embedding - prompt - parser title: RunTypeEnum description: Enum for run types. AnnotationQueueRunUpdateSchema: properties: last_reviewed_time: anyOf: - type: string format: date-time - type: 'null' title: Last Reviewed Time added_at: anyOf: - type: string format: date-time - type: 'null' title: Added At type: object title: AnnotationQueueRunUpdateSchema AnnotationQueueUpdateSchema: properties: name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description default_dataset: anyOf: - type: string format: uuid - type: 'null' title: Default Dataset num_reviewers_per_item: anyOf: - type: integer - $ref: '#/components/schemas/Missing' - type: 'null' title: Num Reviewers Per Item default: 1 enable_reservations: type: boolean title: Enable Reservations default: true reservation_minutes: anyOf: - type: integer - type: 'null' title: Reservation Minutes rubric_items: anyOf: - items: $ref: '#/components/schemas/AnnotationQueueRubricItemSchema' type: array - type: 'null' title: Rubric Items rubric_instructions: anyOf: - type: string - type: 'null' title: Rubric Instructions metadata: anyOf: - additionalProperties: true type: object - $ref: '#/components/schemas/Missing' - type: 'null' title: Metadata default: __missing__: __missing__ reviewer_access_mode: anyOf: - type: string enum: - any - assigned - type: 'null' title: Reviewer Access Mode type: object title: AnnotationQueueUpdateSchema description: AnnotationQueue update schema. Missing: properties: __missing__: type: string const: __missing__ title: Missing type: object required: - __missing__ title: Missing TraceTier: type: string enum: - longlived - shortlived title: TraceTier annotationqueues.AddReviewerResponse: type: object properties: identity_id: type: string ResolvedAnnotationQueueRunSchema: properties: section: type: string enum: - needs_my_review - needs_others_review - completed title: Section position: type: integer title: Position type: object required: - section - position title: ResolvedAnnotationQueueRunSchema description: Resolved annotation queue run position for deep linking. securitySchemes: API Key: type: apiKey in: header name: X-API-Key Tenant ID: type: apiKey in: header name: X-Tenant-Id Bearer Auth: type: http description: Bearer tokens are used to authenticate from the UI. Must also specify x-tenant-id or x-organization-id (for org scoped apis). scheme: bearer Organization ID: type: apiKey in: header name: X-Organization-Id