@datadog/datadog-api-client 1.57.0 → 1.58.0

package/dist/packages/datadog-api-client-v2/apis/LLMObservabilityApi.js

@@ -546,6 +546,33 @@ class LLMObservabilityApiRequestFactory extends baseapi_1.BaseAPIRequestFactory
             return requestContext;
         });
     }
+    getLLMObsAnnotationQueueLabelSchema(queueId, _options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            logger_1.logger.warn("Using unstable operation 'getLLMObsAnnotationQueueLabelSchema'");
+            if (!_config.unstableOperations["v2.getLLMObsAnnotationQueueLabelSchema"]) {
+                throw new Error("Unstable operation 'getLLMObsAnnotationQueueLabelSchema' is disabled");
+            }
+            // verify required parameter 'queueId' is not null or undefined
+            if (queueId === null || queueId === undefined) {
+                throw new baseapi_1.RequiredError("queueId", "getLLMObsAnnotationQueueLabelSchema");
+            }
+            // Path Params
+            const localVarPath = "/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema".replace("{queue_id}", encodeURIComponent(String(queueId)));
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.LLMObservabilityApi.getLLMObsAnnotationQueueLabelSchema")
+                .makeRequestContext(localVarPath, http_1.HttpMethod.GET);
+            requestContext.setHeaderParam("Accept", "application/json");
+            requestContext.setHttpConfig(_config.httpConfig);
+            // Apply auth methods
+            (0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
+                "apiKeyAuth",
+                "appKeyAuth",
+            ]);
+            return requestContext;
+        });
+    }
     getLLMObsCustomEvalConfig(evalName, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
@@ -799,6 +826,44 @@ class LLMObservabilityApiRequestFactory extends baseapi_1.BaseAPIRequestFactory
             return requestContext;
         });
     }
+    updateLLMObsAnnotationQueueLabelSchema(queueId, body, _options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            logger_1.logger.warn("Using unstable operation 'updateLLMObsAnnotationQueueLabelSchema'");
+            if (!_config.unstableOperations["v2.updateLLMObsAnnotationQueueLabelSchema"]) {
+                throw new Error("Unstable operation 'updateLLMObsAnnotationQueueLabelSchema' is disabled");
+            }
+            // verify required parameter 'queueId' is not null or undefined
+            if (queueId === null || queueId === undefined) {
+                throw new baseapi_1.RequiredError("queueId", "updateLLMObsAnnotationQueueLabelSchema");
+            }
+            // verify required parameter 'body' is not null or undefined
+            if (body === null || body === undefined) {
+                throw new baseapi_1.RequiredError("body", "updateLLMObsAnnotationQueueLabelSchema");
+            }
+            // Path Params
+            const localVarPath = "/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema".replace("{queue_id}", encodeURIComponent(String(queueId)));
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.LLMObservabilityApi.updateLLMObsAnnotationQueueLabelSchema")
+                .makeRequestContext(localVarPath, http_1.HttpMethod.PUT);
+            requestContext.setHeaderParam("Accept", "application/json");
+            requestContext.setHttpConfig(_config.httpConfig);
+            // Body Params
+            const contentType = ObjectSerializer_1.ObjectSerializer.getPreferredMediaType([
+                "application/json",
+            ]);
+            requestContext.setHeaderParam("Content-Type", contentType);
+            const serializedBody = ObjectSerializer_1.ObjectSerializer.stringify(ObjectSerializer_1.ObjectSerializer.serialize(body, "LLMObsAnnotationQueueLabelSchemaUpdateRequest", ""), contentType);
+            requestContext.setBody(serializedBody);
+            // Apply auth methods
+            (0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
+                "apiKeyAuth",
+                "appKeyAuth",
+            ]);
+            return requestContext;
+        });
+    }
     updateLLMObsCustomEvalConfig(evalName, body, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
@@ -1732,6 +1797,56 @@ class LLMObservabilityApiResponseProcessor {
             throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
         });
     }
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getLLMObsAnnotationQueueLabelSchema
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getLLMObsAnnotationQueueLabelSchema(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contentType = ObjectSerializer_1.ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+            if (response.httpStatusCode === 200) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "LLMObsAnnotationQueueLabelSchemaResponse");
+                return body;
+            }
+            if (response.httpStatusCode === 401 ||
+                response.httpStatusCode === 403 ||
+                response.httpStatusCode === 404 ||
+                response.httpStatusCode === 500) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "JSONAPIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            if (response.httpStatusCode === 429) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "APIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            // Work around for missing responses in specification, e.g. for petstore.yaml
+            if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "LLMObsAnnotationQueueLabelSchemaResponse", "");
+                return body;
+            }
+            const body = (yield response.body.text()) || "";
+            throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
+        });
+    }
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -2079,6 +2194,57 @@ class LLMObservabilityApiResponseProcessor {
             throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
         });
     }
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to updateLLMObsAnnotationQueueLabelSchema
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    updateLLMObsAnnotationQueueLabelSchema(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contentType = ObjectSerializer_1.ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+            if (response.httpStatusCode === 200) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "LLMObsAnnotationQueueLabelSchemaResponse");
+                return body;
+            }
+            if (response.httpStatusCode === 400 ||
+                response.httpStatusCode === 401 ||
+                response.httpStatusCode === 403 ||
+                response.httpStatusCode === 404 ||
+                response.httpStatusCode === 500) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "JSONAPIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            if (response.httpStatusCode === 429) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "APIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            // Work around for missing responses in specification, e.g. for petstore.yaml
+            if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "LLMObsAnnotationQueueLabelSchemaResponse", "");
+                return body;
+            }
+            const body = (yield response.body.text()) || "";
+            throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
+        });
+    }
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -2339,8 +2505,10 @@ class LLMObservabilityApi {
             responseProcessor || new LLMObservabilityApiResponseProcessor();
     }
     /**
-     * Create a new annotation queue. Only `name`, `project_id`, and `description` are accepted.
-     * Fields such as `created_by`, `owned_by`, `created_at`, `modified_by`, and `modified_at` are inferred by the backend.
+     * Create an annotation queue. The `name` and `project_id` fields are required.
+     * An optional `annotation_schema` can be provided to define the labels for the queue.
+     * Fields such as `created_by`, `owned_by`, `created_at`, `modified_by`,
+     * and `modified_at` are inferred by the backend.
      * @param param The request object
      */
     createLLMObsAnnotationQueue(param, options) {
@@ -2354,7 +2522,7 @@ class LLMObservabilityApi {
         });
     }
     /**
-     * Add one or more interactions (traces) to an annotation queue.
+     * Add one or more interactions (traces or sessions) to an annotation queue.
      * At least one interaction must be provided.
      * @param param The request object
      */
@@ -2537,7 +2705,7 @@ class LLMObservabilityApi {
         });
     }
     /**
-     * Retrieve all interactions and their annotations for a given annotation queue.
+     * Retrieve all interactions (traces and sessions) and their annotations for a given annotation queue.
      * @param param The request object
      */
     getLLMObsAnnotatedInteractions(param, options) {
@@ -2550,6 +2718,20 @@ class LLMObservabilityApi {
             });
         });
     }
+    /**
+     * Retrieve the label schema for a given annotation queue.
+     * @param param The request object
+     */
+    getLLMObsAnnotationQueueLabelSchema(param, options) {
+        const requestContextPromise = this.requestFactory.getLLMObsAnnotationQueueLabelSchema(param.queueId, options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.getLLMObsAnnotationQueueLabelSchema(responseContext);
+            });
+        });
+    }
     /**
      * Retrieve a custom LLM Observability evaluator configuration by its name.
      * @param param The request object
@@ -2636,7 +2818,7 @@ class LLMObservabilityApi {
         });
     }
     /**
-     * Partially update an annotation queue. Only `name` and `description` can be updated.
+     * Partially update an annotation queue. The `name`, `description`, and `annotation_schema` fields can be updated.
      * @param param The request object
      */
     updateLLMObsAnnotationQueue(param, options) {
@@ -2649,6 +2831,23 @@ class LLMObservabilityApi {
             });
         });
     }
+    /**
+     * Create or replace the label schema for a given annotation queue.
+     * The label schema defines the labels annotators can apply to interactions in the queue.
+     * Label names must be unique within the queue and match the pattern `^[a-zA-Z0-9_-]+$`.
+     * Each label must have a valid type: score, categorical, boolean, or text.
+     * @param param The request object
+     */
+    updateLLMObsAnnotationQueueLabelSchema(param, options) {
+        const requestContextPromise = this.requestFactory.updateLLMObsAnnotationQueueLabelSchema(param.queueId, param.body, options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.updateLLMObsAnnotationQueueLabelSchema(responseContext);
+            });
+        });
+    }
     /**
      * Create or update a custom LLM Observability evaluator configuration by its name.
      * @param param The request object