--- title: Get annotation queue label schema description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > LLM Observability --- # Get annotation queue label schema{% #get-annotation-queue-label-schema %} {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema | ### Overview Retrieve the label schema for a given annotation queue. ### Arguments #### Path Parameters | Name | Type | Description | | -------------------------- | ------ | ------------------------------------------------- | | queue_id [*required*] | string | The ID of the LLM Observability annotation queue. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing the label schema of an annotation queue. | Parent field | Field | Type | Description | | ----------------- | ----------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data object for an annotation queue label schema. | | data | attributes [*required*] | object | Attributes of an annotation queue label schema. | | attributes | annotation_schema [*required*] | object | Schema defining the labels for an annotation queue. | | annotation_schema | label_schemas [*required*] | [object] | List of label schema definitions. | | label_schemas | description | string | Description of the label. | | label_schemas | has_assessment | boolean | Whether this label includes an assessment field. | | label_schemas | has_reasoning | boolean | Whether this label includes a reasoning field. | | label_schemas | id | string | Unique identifier of the label schema. Assigned by the server if not provided. | | label_schemas | is_assessment | boolean | Whether the boolean label represents an assessment. Requires `has_assessment` to be true. | | label_schemas | is_integer | boolean | Whether score values must be integers. Applicable to score-type labels. | | label_schemas | is_required | boolean | Whether this label is required for an annotation. | | label_schemas | max | double | Maximum value for score-type labels. | | label_schemas | min | double | Minimum value for score-type labels. | | label_schemas | name [*required*] | string | Name of the label. Must match the pattern `^[a-zA-Z0-9_-]+$` and be unique within the queue. | | label_schemas | type [*required*] | enum | Type of a label in an annotation queue label schema. Allowed enum values: `score,categorical,boolean,text` | | label_schemas | values | [string] | Allowed values for categorical-type labels. Must contain at least one non-empty, unique value. | | data | id [*required*] | string | Unique identifier of the annotation queue. | | data | type [*required*] | enum | Resource type of an LLM Observability annotation queue. Allowed enum values: `queues` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "annotation_schema": { "label_schemas": [ { "description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5, "min": 0, "name": "quality", "type": "score", "values": [ "good", "bad", "neutral" ] } ] } }, "id": "00000000-0000-0000-0000-000000000001", "type": "queues" } } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="500" %} Internal Server Error {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export queue_id="00000000-0000-0000-0000-000000000001" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/${queue_id}/label-schema" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get annotation queue label schema returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi configuration = Configuration() configuration.unstable_operations["get_llm_obs_annotation_queue_label_schema"] = True with ApiClient(configuration) as api_client: api_instance = LLMObservabilityApi(api_client) response = api_instance.get_llm_obs_annotation_queue_label_schema( queue_id="queue_id", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get annotation queue label schema returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.get_llm_obs_annotation_queue_label_schema".to_sym] = true end api_instance = DatadogAPIClient::V2::LLMObservabilityAPI.new p api_instance.get_llm_obs_annotation_queue_label_schema("queue_id") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get annotation queue label schema returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetLLMObsAnnotationQueueLabelSchema", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewLLMObservabilityApi(apiClient) resp, r, err := api.GetLLMObsAnnotationQueueLabelSchema(ctx, "queue_id") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `LLMObservabilityApi.GetLLMObsAnnotationQueueLabelSchema`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `LLMObservabilityApi.GetLLMObsAnnotationQueueLabelSchema`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get annotation queue label schema returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.LlmObservabilityApi; import com.datadog.api.client.v2.model.LLMObsAnnotationQueueLabelSchemaResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.getLLMObsAnnotationQueueLabelSchema", true); LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient); try { LLMObsAnnotationQueueLabelSchemaResponse result = apiInstance.getLLMObsAnnotationQueueLabelSchema("00000000-0000-0000-0000-000000000001"); System.out.println(result); } catch (ApiException e) { System.err.println( "Exception when calling LlmObservabilityApi#getLLMObsAnnotationQueueLabelSchema"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get annotation queue label schema returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_llm_observability::LLMObservabilityAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.GetLLMObsAnnotationQueueLabelSchema", true); let api = LLMObservabilityAPI::with_config(configuration); let resp = api .get_llm_obs_annotation_queue_label_schema("queue_id".to_string()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get annotation queue label schema returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.getLLMObsAnnotationQueueLabelSchema"] = true; const apiInstance = new v2.LLMObservabilityApi(configuration); const params: v2.LLMObservabilityApiGetLLMObsAnnotationQueueLabelSchemaRequest = { queueId: "queue_id", }; apiInstance .getLLMObsAnnotationQueueLabelSchema(params) .then((data: v2.LLMObsAnnotationQueueLabelSchemaResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}