Skip to content

Add Annotations endpoints #3705

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 Annotations endpoints #3705

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
787 changes: 786 additions & 1 deletion .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

40 changes: 40 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsAnnotationQueue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Create an LLM Observability annotation queue returns "Created" 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.LLMObsAnnotationQueueDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueDataRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueResponse;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueType;

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

LLMObsAnnotationQueueRequest body =
new LLMObsAnnotationQueueRequest()
.data(
new LLMObsAnnotationQueueDataRequest()
.attributes(
new LLMObsAnnotationQueueDataAttributesRequest()
.description("Queue for annotating customer support traces")
.name("My annotation queue")
.projectId("a33671aa-24fd-4dcd-9b33-a8ec7dde7751"))
.type(LLMObsAnnotationQueueType.QUEUES));

try {
LLMObsAnnotationQueueResponse result = apiInstance.createLLMObsAnnotationQueue(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#createLLMObsAnnotationQueue");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
48 changes: 48 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsAnnotationQueueInteractions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// Add annotation queue interactions returns "Created" 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.LLMObsAnnotationQueueInteractionItem;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsDataRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsResponse;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsType;
import com.datadog.api.client.v2.model.LLMObsInteractionType;
import java.util.Collections;

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

LLMObsAnnotationQueueInteractionsRequest body =
new LLMObsAnnotationQueueInteractionsRequest()
.data(
new LLMObsAnnotationQueueInteractionsDataRequest()
.attributes(
new LLMObsAnnotationQueueInteractionsDataAttributesRequest()
.interactions(
Collections.singletonList(
new LLMObsAnnotationQueueInteractionItem()
.contentId("trace-abc-123")
.type(LLMObsInteractionType.TRACE))))
.type(LLMObsAnnotationQueueInteractionsType.INTERACTIONS));

try {
LLMObsAnnotationQueueInteractionsResponse result =
apiInstance.createLLMObsAnnotationQueueInteractions(
"b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling LlmObservabilityApi#createLLMObsAnnotationQueueInteractions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
23 changes: 23 additions & 0 deletions examples/v2/llm-observability/DeleteLLMObsAnnotationQueue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Delete an LLM Observability annotation queue returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.LlmObservabilityApi;

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

try {
apiInstance.deleteLLMObsAnnotationQueue("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c");
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#deleteLLMObsAnnotationQueue");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
42 changes: 42 additions & 0 deletions examples/v2/llm-observability/DeleteLLMObsAnnotationQueueInteractions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// Delete annotation queue interactions 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.LLMObsAnnotationQueueInteractionsType;
import com.datadog.api.client.v2.model.LLMObsDeleteAnnotationQueueInteractionsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteAnnotationQueueInteractionsDataRequest;
import com.datadog.api.client.v2.model.LLMObsDeleteAnnotationQueueInteractionsRequest;
import java.util.Arrays;

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

LLMObsDeleteAnnotationQueueInteractionsRequest body =
new LLMObsDeleteAnnotationQueueInteractionsRequest()
.data(
new LLMObsDeleteAnnotationQueueInteractionsDataRequest()
.attributes(
new LLMObsDeleteAnnotationQueueInteractionsDataAttributesRequest()
.interactionIds(
Arrays.asList(
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000001")))
.type(LLMObsAnnotationQueueInteractionsType.INTERACTIONS));

try {
apiInstance.deleteLLMObsAnnotationQueueInteractions(
"b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body);
} catch (ApiException e) {
System.err.println(
"Exception when calling LlmObservabilityApi#deleteLLMObsAnnotationQueueInteractions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
27 changes: 27 additions & 0 deletions examples/v2/llm-observability/GetLLMObsAnnotatedInteractions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Get annotated queue interactions 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.LLMObsAnnotatedInteractionsResponse;

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

try {
LLMObsAnnotatedInteractionsResponse result =
apiInstance.getLLMObsAnnotatedInteractions("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c");
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling LlmObservabilityApi#getLLMObsAnnotatedInteractions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/llm-observability/ListLLMObsAnnotationQueues.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// List LLM Observability annotation queues 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.LLMObsAnnotationQueuesResponse;

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

try {
LLMObsAnnotationQueuesResponse result = apiInstance.listLLMObsAnnotationQueues();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#listLLMObsAnnotationQueues");
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/UpdateLLMObsAnnotationQueue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Update an LLM Observability annotation queue 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.LLMObsAnnotationQueueResponse;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueType;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueUpdateDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueUpdateDataRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueUpdateRequest;

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

LLMObsAnnotationQueueUpdateRequest body =
new LLMObsAnnotationQueueUpdateRequest()
.data(
new LLMObsAnnotationQueueUpdateDataRequest()
.attributes(
new LLMObsAnnotationQueueUpdateDataAttributesRequest()
.description("Updated description")
.name("Updated queue name"))
.type(LLMObsAnnotationQueueType.QUEUES));

try {
LLMObsAnnotationQueueResponse result =
apiInstance.updateLLMObsAnnotationQueue("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#updateLLMObsAnnotationQueue");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
7 changes: 7 additions & 0 deletions src/main/java/com/datadog/api/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -903,19 +903,26 @@ public class ApiClient {
put("v2.updateJiraIssueTemplate", false);
put("v2.createTenancyConfig", false);
put("v2.getTenancyConfigs", false);
put("v2.createLLMObsAnnotationQueue", false);
put("v2.createLLMObsAnnotationQueueInteractions", false);
put("v2.createLLMObsDataset", false);
put("v2.createLLMObsDatasetRecords", false);
put("v2.createLLMObsExperiment", false);
put("v2.createLLMObsExperimentEvents", false);
put("v2.createLLMObsProject", false);
put("v2.deleteLLMObsAnnotationQueue", false);
put("v2.deleteLLMObsAnnotationQueueInteractions", false);
put("v2.deleteLLMObsDatasetRecords", false);
put("v2.deleteLLMObsDatasets", false);
put("v2.deleteLLMObsExperiments", false);
put("v2.deleteLLMObsProjects", false);
put("v2.getLLMObsAnnotatedInteractions", false);
put("v2.listLLMObsAnnotationQueues", false);
put("v2.listLLMObsDatasetRecords", false);
put("v2.listLLMObsDatasets", false);
put("v2.listLLMObsExperiments", false);
put("v2.listLLMObsProjects", false);
put("v2.updateLLMObsAnnotationQueue", false);
put("v2.updateLLMObsDataset", false);
put("v2.updateLLMObsDatasetRecords", false);
put("v2.updateLLMObsExperiment", false);
Expand Down
Loading
Loading