Skip to content

Add OpenAPI for LLM Observability dataset export batch_update clone restore and records upload SSE #4271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

Add OpenAPI for LLM Observability dataset export batch_update clone restore and records upload SSE #4271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
724 changes: 706 additions & 18 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

154 changes: 154 additions & 0 deletions features/v2/llm_observability.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,76 @@ Feature: LLM Observability
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/ml-observability
Scenario: Batch update LLM Observability dataset records returns "Bad Request" response
Given operation "BatchUpdateLLMObsDataset" enabled
And new "BatchUpdateLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"create_new_version": true, "delete_records": [], "insert_records": [{"expected_output": null, "id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c", "input": null, "tag_operations": {"add": [], "remove": [], "set": []}, "tags": []}], "tags": [], "update_records": [{"expected_output": null, "id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c", "input": null, "tag_operations": {"add": [], "remove": [], "set": []}}]}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/ml-observability
Scenario: Batch update LLM Observability dataset records returns "Not Found" response
Given operation "BatchUpdateLLMObsDataset" enabled
And new "BatchUpdateLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"create_new_version": true, "delete_records": [], "insert_records": [{"expected_output": null, "id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c", "input": null, "tag_operations": {"add": [], "remove": [], "set": []}, "tags": []}], "tags": [], "update_records": [{"expected_output": null, "id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c", "input": null, "tag_operations": {"add": [], "remove": [], "set": []}}]}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/ml-observability
Scenario: Batch update LLM Observability dataset records returns "OK" response
Given operation "BatchUpdateLLMObsDataset" enabled
And new "BatchUpdateLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"create_new_version": true, "delete_records": [], "insert_records": [{"expected_output": null, "id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c", "input": null, "tag_operations": {"add": [], "remove": [], "set": []}, "tags": []}], "tags": [], "update_records": [{"expected_output": null, "id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c", "input": null, "tag_operations": {"add": [], "remove": [], "set": []}}]}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/ml-observability
Scenario: Batch update LLM Observability dataset records returns "Payload Too Large" response
Given operation "BatchUpdateLLMObsDataset" enabled
And new "BatchUpdateLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"create_new_version": true, "delete_records": [], "insert_records": [{"expected_output": null, "id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c", "input": null, "tag_operations": {"add": [], "remove": [], "set": []}, "tags": []}], "tags": [], "update_records": [{"expected_output": null, "id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c", "input": null, "tag_operations": {"add": [], "remove": [], "set": []}}]}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 413 Payload Too Large

@generated @skip @team:DataDog/ml-observability
Scenario: Clone an LLM Observability dataset returns "Bad Request" response
Given operation "CloneLLMObsDataset" enabled
And new "CloneLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"description": "Clone of the original dataset for experimentation.", "name": "My cloned dataset"}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/ml-observability
Scenario: Clone an LLM Observability dataset returns "Not Found" response
Given operation "CloneLLMObsDataset" enabled
And new "CloneLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"description": "Clone of the original dataset for experimentation.", "name": "My cloned dataset"}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/ml-observability
Scenario: Clone an LLM Observability dataset returns "OK" response
Given operation "CloneLLMObsDataset" enabled
And new "CloneLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"description": "Clone of the original dataset for experimentation.", "name": "My cloned dataset"}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/ml-observability
Scenario: Create an LLM Observability annotation queue returns "Bad Request" response
Given operation "CreateLLMObsAnnotationQueue" enabled
Expand Down Expand Up @@ -417,6 +487,33 @@ Feature: LLM Observability
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/ml-observability
Scenario: Export an LLM Observability dataset returns "Bad Request" response
Given operation "ExportLLMObsDataset" enabled
And new "ExportLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/ml-observability
Scenario: Export an LLM Observability dataset returns "Not Found" response
Given operation "ExportLLMObsDataset" enabled
And new "ExportLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/ml-observability
Scenario: Export an LLM Observability dataset returns "OK" response
Given operation "ExportLLMObsDataset" enabled
And new "ExportLLMObsDataset" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/ml-observability
Scenario: Get LLM Observability dataset draft state returns "Bad Request" response
Given operation "GetLLMObsDatasetDraftState" enabled
Expand Down Expand Up @@ -770,6 +867,36 @@ Feature: LLM Observability
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/ml-observability
Scenario: Restore an LLM Observability dataset version returns "Bad Request" response
Given operation "RestoreLLMObsDatasetVersion" enabled
And new "RestoreLLMObsDatasetVersion" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"dataset_version": 1}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/ml-observability
Scenario: Restore an LLM Observability dataset version returns "Not Found" response
Given operation "RestoreLLMObsDatasetVersion" enabled
And new "RestoreLLMObsDatasetVersion" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"dataset_version": 1}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/ml-observability
Scenario: Restore an LLM Observability dataset version returns "OK" response
Given operation "RestoreLLMObsDatasetVersion" enabled
And new "RestoreLLMObsDatasetVersion" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"dataset_version": 1}, "id": "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", "type": "datasets"}}
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/ml-observability
Scenario: Run an LLM inference returns "Bad Request" response
Given operation "CreateLLMObsIntegrationInference" enabled
Expand Down Expand Up @@ -1040,3 +1167,30 @@ Feature: LLM Observability
And body with value {"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.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}}
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/ml-observability
Scenario: Upload records to an LLM Observability dataset returns "Bad Request" response
Given operation "UploadLLMObsDatasetRecordsFile" enabled
And new "UploadLLMObsDatasetRecordsFile" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/ml-observability
Scenario: Upload records to an LLM Observability dataset returns "Not Found" response
Given operation "UploadLLMObsDatasetRecordsFile" enabled
And new "UploadLLMObsDatasetRecordsFile" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/ml-observability
Scenario: Upload records to an LLM Observability dataset returns "OK" response
Given operation "UploadLLMObsDatasetRecordsFile" enabled
And new "UploadLLMObsDatasetRecordsFile" request
And request contains "project_id" parameter from "REPLACE.ME"
And request contains "dataset_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK
32 changes: 32 additions & 0 deletions features/v2/undo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3943,6 +3943,20 @@
"type": "idempotent"
}
},
"BatchUpdateLLMObsDataset": {
"tag": "LLM Observability",
"undo": {
"type": "idempotent"
}
},
"CloneLLMObsDataset": {
"tag": "LLM Observability",
"undo": {
"operationId": "TODO",
"parameters": [],
"type": "unsafe"
}
},
"GetLLMObsDatasetDraftState": {
"tag": "LLM Observability",
"undo": {
Expand All @@ -3961,6 +3975,12 @@
"type": "idempotent"
}
},
"ExportLLMObsDataset": {
"tag": "LLM Observability",
"undo": {
"type": "safe"
}
},
"ListLLMObsDatasetRecords": {
"tag": "LLM Observability",
"undo": {
Expand Down Expand Up @@ -3998,12 +4018,24 @@
"type": "unsafe"
}
},
"RestoreLLMObsDatasetVersion": {
"tag": "LLM Observability",
"undo": {
"type": "idempotent"
}
},
"ListLLMObsDatasetVersions": {
"tag": "LLM Observability",
"undo": {
"type": "safe"
}
},
"UploadLLMObsDatasetRecordsFile": {
"tag": "LLM Observability",
"undo": {
"type": "idempotent"
}
},
"ListLLMObsExperimentEvents": {
"tag": "LLM Observability",
"undo": {
Expand Down
95 changes: 95 additions & 0 deletions private/bdd_runner/src/support/scenarios_model_mapping.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2965,6 +2965,36 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
},
operationResponseType: "LLMObsDatasetResponse",
},
"LLMObservabilityApi.V2.BatchUpdateLLMObsDataset": {
projectId: {
type: "string",
format: "",
},
datasetId: {
type: "string",
format: "",
},
body: {
type: "LLMObsDatasetBatchUpdateRequest",
format: "",
},
operationResponseType: "LLMObsDatasetRecordsMutationResponse",
},
"LLMObservabilityApi.V2.CloneLLMObsDataset": {
projectId: {
type: "string",
format: "",
},
datasetId: {
type: "string",
format: "",
},
body: {
type: "LLMObsDatasetCloneRequest",
format: "",
},
operationResponseType: "LLMObsDatasetResponse",
},
"LLMObservabilityApi.V2.GetLLMObsDatasetDraftState": {
projectId: {
type: "string",
Expand Down Expand Up @@ -2998,6 +3028,25 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
},
operationResponseType: "{}",
},
"LLMObservabilityApi.V2.ExportLLMObsDataset": {
projectId: {
type: "string",
format: "",
},
datasetId: {
type: "string",
format: "",
},
format: {
type: "LLMObsDatasetExportFormat",
format: "",
},
version: {
type: "number",
format: "int64",
},
operationResponseType: "string",
},
"LLMObservabilityApi.V2.ListLLMObsDatasetRecords": {
projectId: {
type: "string",
Expand Down Expand Up @@ -3066,6 +3115,21 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
},
operationResponseType: "{}",
},
"LLMObservabilityApi.V2.RestoreLLMObsDatasetVersion": {
projectId: {
type: "string",
format: "",
},
datasetId: {
type: "string",
format: "",
},
body: {
type: "LLMObsDatasetRestoreVersionRequest",
format: "",
},
operationResponseType: "{}",
},
"LLMObservabilityApi.V2.ListLLMObsDatasetVersions": {
projectId: {
type: "string",
Expand All @@ -3077,6 +3141,37 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
},
operationResponseType: "LLMObsDatasetVersionsResponse",
},
"LLMObservabilityApi.V2.UploadLLMObsDatasetRecordsFile": {
projectId: {
type: "string",
format: "",
},
datasetId: {
type: "string",
format: "",
},
deduplicate: {
type: "boolean",
format: "",
},
overwrite: {
type: "boolean",
format: "",
},
tags: {
type: "Array<string>",
format: "",
},
includeUserData: {
type: "boolean",
format: "",
},
file: {
type: "HttpFile",
format: "binary",
},
operationResponseType: "string",
},
"LLMObservabilityApi.V2.ListLLMObsExperimentEvents": {
experimentId: {
type: "string",
Expand Down
Loading
Loading