Skip to content

Add OpenAPI spec for LLM Observability Experiments API #3537

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: master
Choose a base branch
from
Open

Add OpenAPI spec for LLM Observability Experiments API #3537

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
3,335 changes: 2,658 additions & 677 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsDataset.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Create an LLM Observability dataset 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.LLMObsDatasetDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsDatasetDataRequest;
import com.datadog.api.client.v2.model.LLMObsDatasetRequest;
import com.datadog.api.client.v2.model.LLMObsDatasetResponse;
import com.datadog.api.client.v2.model.LLMObsDatasetType;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createLLMObsDataset", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsDatasetRequest body =
new LLMObsDatasetRequest()
.data(
new LLMObsDatasetDataRequest()
.attributes(new LLMObsDatasetDataAttributesRequest().name("My LLM Dataset"))
.type(LLMObsDatasetType.DATASETS));

try {
LLMObsDatasetResponse result =
apiInstance.createLLMObsDataset("a33671aa-24fd-4dcd-9b33-a8ec7dde7751", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#createLLMObsDataset");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
46 changes: 46 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsDatasetRecords.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// Append records to an LLM Observability dataset 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.LLMObsDatasetRecordItem;
import com.datadog.api.client.v2.model.LLMObsDatasetRecordsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsDatasetRecordsDataRequest;
import com.datadog.api.client.v2.model.LLMObsDatasetRecordsMutationResponse;
import com.datadog.api.client.v2.model.LLMObsDatasetRecordsRequest;
import com.datadog.api.client.v2.model.LLMObsRecordType;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createLLMObsDatasetRecords", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsDatasetRecordsRequest body =
new LLMObsDatasetRecordsRequest()
.data(
new LLMObsDatasetRecordsDataRequest()
.attributes(
new LLMObsDatasetRecordsDataAttributesRequest()
.records(
Collections.singletonList(
new LLMObsDatasetRecordItem()
.expectedOutput(null)
.input(null))))
.type(LLMObsRecordType.RECORDS));

try {
LLMObsDatasetRecordsMutationResponse result =
apiInstance.createLLMObsDatasetRecords(
"a33671aa-24fd-4dcd-9b33-a8ec7dde7751", "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#createLLMObsDatasetRecords");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
40 changes: 40 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsExperiment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Create an LLM Observability experiment 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.LLMObsExperimentDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentDataRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentResponse;
import com.datadog.api.client.v2.model.LLMObsExperimentType;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createLLMObsExperiment", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsExperimentRequest body =
new LLMObsExperimentRequest()
.data(
new LLMObsExperimentDataRequest()
.attributes(
new LLMObsExperimentDataAttributesRequest()
.datasetId("9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d")
.name("My Experiment v1")
.projectId("a33671aa-24fd-4dcd-9b33-a8ec7dde7751"))
.type(LLMObsExperimentType.EXPERIMENTS));

try {
LLMObsExperimentResponse result = apiInstance.createLLMObsExperiment(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#createLLMObsExperiment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
68 changes: 68 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsExperimentEvents.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
// Push events for an LLM Observability experiment returns "Accepted" 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.LLMObsEventType;
import com.datadog.api.client.v2.model.LLMObsExperimentEventsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentEventsDataRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentEventsRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentMetric;
import com.datadog.api.client.v2.model.LLMObsExperimentMetricError;
import com.datadog.api.client.v2.model.LLMObsExperimentSpan;
import com.datadog.api.client.v2.model.LLMObsExperimentSpanError;
import com.datadog.api.client.v2.model.LLMObsExperimentSpanMeta;
import com.datadog.api.client.v2.model.LLMObsMetricAssessment;
import com.datadog.api.client.v2.model.LLMObsMetricScoreType;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createLLMObsExperimentEvents", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsExperimentEventsRequest body =
new LLMObsExperimentEventsRequest()
.data(
new LLMObsExperimentEventsDataRequest()
.attributes(
new LLMObsExperimentEventsDataAttributesRequest()
.metrics(
Collections.singletonList(
new LLMObsExperimentMetric()
.assessment(LLMObsMetricAssessment.PASS)
.error(new LLMObsExperimentMetricError())
.label("faithfulness")
.metricType(LLMObsMetricScoreType.SCORE)
.spanId("span-7a1b2c3d")
.timestampMs(1705314600000L)))
.spans(
Collections.singletonList(
new LLMObsExperimentSpan()
.datasetId("9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d")
.duration(1500000000L)
.meta(
new LLMObsExperimentSpanMeta()
.error(new LLMObsExperimentSpanError())
.input(null)
.output(null))
.name("llm_call")
.projectId("a33671aa-24fd-4dcd-9b33-a8ec7dde7751")
.spanId("span-7a1b2c3d")
.startNs(1705314600000000000L)
.status("ok")
.traceId("abc123def456"))))
.type(LLMObsEventType.EVENTS));

try {
apiInstance.createLLMObsExperimentEvents("3fd6b5e0-8910-4b1c-a7d0-5b84de329012", body);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#createLLMObsExperimentEvents");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
36 changes: 36 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsProject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Create an LLM Observability project 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.LLMObsProjectDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsProjectDataRequest;
import com.datadog.api.client.v2.model.LLMObsProjectRequest;
import com.datadog.api.client.v2.model.LLMObsProjectResponse;
import com.datadog.api.client.v2.model.LLMObsProjectType;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createLLMObsProject", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsProjectRequest body =
new LLMObsProjectRequest()
.data(
new LLMObsProjectDataRequest()
.attributes(new LLMObsProjectDataAttributesRequest().name("My LLM Project"))
.type(LLMObsProjectType.PROJECTS));

try {
LLMObsProjectResponse result = apiInstance.createLLMObsProject(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#createLLMObsProject");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
40 changes: 40 additions & 0 deletions examples/v2/llm-observability/DeleteLLMObsDatasetRecords.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Delete LLM Observability dataset records returns "No Content" 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.LLMObsDeleteDatasetRecordsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteDatasetRecordsDataRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteDatasetRecordsRequest;
import com.datadog.api.client.v2.model.LLMObsRecordType;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteLLMObsDatasetRecords", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsDeleteDatasetRecordsRequest body =
new LLMObsDeleteDatasetRecordsRequest()
.data(
new LLMObsDeleteDatasetRecordsDataRequest()
.attributes(
new LLMObsDeleteDatasetRecordsDataAttributesRequest()
.recordIds(
Collections.singletonList(
"rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c")))
.type(LLMObsRecordType.RECORDS));

try {
apiInstance.deleteLLMObsDatasetRecords(
"a33671aa-24fd-4dcd-9b33-a8ec7dde7751", "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d", body);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#deleteLLMObsDatasetRecords");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
38 changes: 38 additions & 0 deletions examples/v2/llm-observability/DeleteLLMObsDatasets.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Delete LLM Observability datasets returns "No Content" 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.LLMObsDatasetType;
import com.datadog.api.client.v2.model.LLMObsDeleteDatasetsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteDatasetsDataRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteDatasetsRequest;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteLLMObsDatasets", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsDeleteDatasetsRequest body =
new LLMObsDeleteDatasetsRequest()
.data(
new LLMObsDeleteDatasetsDataRequest()
.attributes(
new LLMObsDeleteDatasetsDataAttributesRequest()
.datasetIds(
Collections.singletonList("9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d")))
.type(LLMObsDatasetType.DATASETS));

try {
apiInstance.deleteLLMObsDatasets("a33671aa-24fd-4dcd-9b33-a8ec7dde7751", body);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#deleteLLMObsDatasets");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
38 changes: 38 additions & 0 deletions examples/v2/llm-observability/DeleteLLMObsExperiments.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Delete LLM Observability experiments returns "No Content" 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.LLMObsDeleteExperimentsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteExperimentsDataRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteExperimentsRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentType;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteLLMObsExperiments", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsDeleteExperimentsRequest body =
new LLMObsDeleteExperimentsRequest()
.data(
new LLMObsDeleteExperimentsDataRequest()
.attributes(
new LLMObsDeleteExperimentsDataAttributesRequest()
.experimentIds(
Collections.singletonList("3fd6b5e0-8910-4b1c-a7d0-5b84de329012")))
.type(LLMObsExperimentType.EXPERIMENTS));

try {
apiInstance.deleteLLMObsExperiments(body);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#deleteLLMObsExperiments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
38 changes: 38 additions & 0 deletions examples/v2/llm-observability/DeleteLLMObsProjects.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Delete LLM Observability projects returns "No Content" 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.LLMObsDeleteProjectsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteProjectsDataRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteProjectsRequest;
import com.datadog.api.client.v2.model.LLMObsProjectType;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteLLMObsProjects", true);
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

LLMObsDeleteProjectsRequest body =
new LLMObsDeleteProjectsRequest()
.data(
new LLMObsDeleteProjectsDataRequest()
.attributes(
new LLMObsDeleteProjectsDataAttributesRequest()
.projectIds(
Collections.singletonList("a33671aa-24fd-4dcd-9b33-a8ec7dde7751")))
.type(LLMObsProjectType.PROJECTS));

try {
apiInstance.deleteLLMObsProjects(body);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#deleteLLMObsProjects");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading