Skip to content

Add public API spec for LLM Observability prompt registry CRUD endpoints #4090

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 public API spec for LLM Observability prompt registry CRUD endpoints #4090

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
1,752 changes: 1,532 additions & 220 deletions .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/CreateLLMObsPrompt.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Create an LLM Observability prompt 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.LLMObsCreatePromptData;
import com.datadog.api.client.v2.model.LLMObsCreatePromptDataAttributes;
import com.datadog.api.client.v2.model.LLMObsCreatePromptRequest;
import com.datadog.api.client.v2.model.LLMObsPromptResponse;
import com.datadog.api.client.v2.model.LLMObsPromptTemplate;
import com.datadog.api.client.v2.model.LLMObsPromptType;

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

LLMObsCreatePromptRequest body =
new LLMObsCreatePromptRequest()
.data(
new LLMObsCreatePromptData()
.attributes(
new LLMObsCreatePromptDataAttributes()
.promptId("Example-LLM-Observability")
.template(new LLMObsPromptTemplate("Hello")))
.type(LLMObsPromptType.PROMPT_TEMPLATES));

try {
LLMObsPromptResponse result = apiInstance.createLLMObsPrompt(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#createLLMObsPrompt");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
43 changes: 43 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsPromptVersion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Create a new LLM Observability prompt version 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.LLMObsCreatePromptVersionData;
import com.datadog.api.client.v2.model.LLMObsCreatePromptVersionDataAttributes;
import com.datadog.api.client.v2.model.LLMObsCreatePromptVersionRequest;
import com.datadog.api.client.v2.model.LLMObsPromptTemplate;
import com.datadog.api.client.v2.model.LLMObsPromptVersionResponse;
import com.datadog.api.client.v2.model.LLMObsPromptVersionType;

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

// there is a valid "prompt" in the system
String PROMPT_DATA_ATTRIBUTES_PROMPT_ID = System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");

LLMObsCreatePromptVersionRequest body =
new LLMObsCreatePromptVersionRequest()
.data(
new LLMObsCreatePromptVersionData()
.attributes(
new LLMObsCreatePromptVersionDataAttributes()
.template(new LLMObsPromptTemplate("Hello v3")))
.type(LLMObsPromptVersionType.PROMPT_TEMPLATE_VERSIONS));

try {
LLMObsPromptVersionResponse result =
apiInstance.createLLMObsPromptVersion(PROMPT_DATA_ATTRIBUTES_PROMPT_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#createLLMObsPromptVersion");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
29 changes: 29 additions & 0 deletions examples/v2/llm-observability/DeleteLLMObsPrompt.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Delete an LLM Observability prompt 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.LLMObsDeletedPromptResponse;

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

// there is a valid "prompt" in the system
String PROMPT_DATA_ATTRIBUTES_PROMPT_ID = System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");

try {
LLMObsDeletedPromptResponse result =
apiInstance.deleteLLMObsPrompt(PROMPT_DATA_ATTRIBUTES_PROMPT_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#deleteLLMObsPrompt");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
29 changes: 29 additions & 0 deletions examples/v2/llm-observability/GetLLMObsPrompt.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Get an LLM Observability prompt 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.LLMObsPromptSDKResponse;

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

// there is a valid "prompt" in the system
String PROMPT_DATA_ATTRIBUTES_PROMPT_ID = System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");

try {
LLMObsPromptSDKResponse result =
apiInstance.getLLMObsPrompt(PROMPT_DATA_ATTRIBUTES_PROMPT_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#getLLMObsPrompt");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
34 changes: 34 additions & 0 deletions examples/v2/llm-observability/GetLLMObsPromptVersion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Get a specific LLM Observability prompt version 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.LLMObsPromptVersionResponse;

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

// there is a valid "prompt" in the system
String PROMPT_DATA_ATTRIBUTES_PROMPT_ID = System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");

// there is a valid "prompt_version" in the system
Long PROMPT_VERSION_DATA_ATTRIBUTES_VERSION =
Long.parseLong(System.getenv("PROMPT_VERSION_DATA_ATTRIBUTES_VERSION"));

try {
LLMObsPromptVersionResponse result =
apiInstance.getLLMObsPromptVersion(
PROMPT_DATA_ATTRIBUTES_PROMPT_ID, PROMPT_VERSION_DATA_ATTRIBUTES_VERSION);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#getLLMObsPromptVersion");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
29 changes: 29 additions & 0 deletions examples/v2/llm-observability/ListLLMObsPromptVersions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// List versions of an LLM Observability prompt 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.LLMObsPromptVersionsResponse;

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

// there is a valid "prompt" in the system
String PROMPT_DATA_ATTRIBUTES_PROMPT_ID = System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");

try {
LLMObsPromptVersionsResponse result =
apiInstance.listLLMObsPromptVersions(PROMPT_DATA_ATTRIBUTES_PROMPT_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#listLLMObsPromptVersions");
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/ListLLMObsPrompts.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// List LLM Observability prompts 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.LLMObsPromptsResponse;

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

try {
LLMObsPromptsResponse result = apiInstance.listLLMObsPrompts();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#listLLMObsPrompts");
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/UpdateLLMObsPrompt.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Update an LLM Observability prompt 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.LLMObsPromptResponse;
import com.datadog.api.client.v2.model.LLMObsPromptType;
import com.datadog.api.client.v2.model.LLMObsUpdatePromptData;
import com.datadog.api.client.v2.model.LLMObsUpdatePromptDataAttributes;
import com.datadog.api.client.v2.model.LLMObsUpdatePromptRequest;

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

// there is a valid "prompt" in the system
String PROMPT_DATA_ATTRIBUTES_PROMPT_ID = System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");

LLMObsUpdatePromptRequest body =
new LLMObsUpdatePromptRequest()
.data(
new LLMObsUpdatePromptData()
.attributes(new LLMObsUpdatePromptDataAttributes().title("New title"))
.type(LLMObsPromptType.PROMPT_TEMPLATES));

try {
LLMObsPromptResponse result =
apiInstance.updateLLMObsPrompt(PROMPT_DATA_ATTRIBUTES_PROMPT_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#updateLLMObsPrompt");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
45 changes: 45 additions & 0 deletions examples/v2/llm-observability/UpdateLLMObsPromptVersion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Update a specific LLM Observability prompt version 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.LLMObsPromptVersionResponse;
import com.datadog.api.client.v2.model.LLMObsPromptVersionType;
import com.datadog.api.client.v2.model.LLMObsUpdatePromptVersionData;
import com.datadog.api.client.v2.model.LLMObsUpdatePromptVersionDataAttributes;
import com.datadog.api.client.v2.model.LLMObsUpdatePromptVersionRequest;

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

// there is a valid "prompt" in the system
String PROMPT_DATA_ATTRIBUTES_PROMPT_ID = System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");

// there is a valid "prompt_version" in the system
Long PROMPT_VERSION_DATA_ATTRIBUTES_VERSION =
Long.parseLong(System.getenv("PROMPT_VERSION_DATA_ATTRIBUTES_VERSION"));

LLMObsUpdatePromptVersionRequest body =
new LLMObsUpdatePromptVersionRequest()
.data(
new LLMObsUpdatePromptVersionData()
.attributes(new LLMObsUpdatePromptVersionDataAttributes())
.type(LLMObsPromptVersionType.PROMPT_TEMPLATE_VERSIONS));

try {
LLMObsPromptVersionResponse result =
apiInstance.updateLLMObsPromptVersion(
PROMPT_DATA_ATTRIBUTES_PROMPT_ID, PROMPT_VERSION_DATA_ATTRIBUTES_VERSION, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#updateLLMObsPromptVersion");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
9 changes: 9 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 @@ -788,6 +788,8 @@ public class ApiClient {
put("v2.createLLMObsExperimentEvents", false);
put("v2.createLLMObsIntegrationInference", false);
put("v2.createLLMObsProject", false);
put("v2.createLLMObsPrompt", false);
put("v2.createLLMObsPromptVersion", false);
put("v2.deleteLLMObsAnnotationQueue", false);
put("v2.deleteLLMObsAnnotationQueueInteractions", false);
put("v2.deleteLLMObsAnnotations", false);
Expand All @@ -798,6 +800,7 @@ public class ApiClient {
put("v2.deleteLLMObsExperiments", false);
put("v2.deleteLLMObsPatternsConfig", false);
put("v2.deleteLLMObsProjects", false);
put("v2.deleteLLMObsPrompt", false);
put("v2.exportLLMObsDataset", false);
put("v2.getLLMObsAnnotatedInteractions", false);
put("v2.getLLMObsAnnotatedInteractionsByTraceIDs", false);
Expand All @@ -806,6 +809,8 @@ public class ApiClient {
put("v2.getLLMObsDatasetDraftState", false);
put("v2.getLLMObsPatternsConfig", false);
put("v2.getLLMObsPatternsRunStatus", false);
put("v2.getLLMObsPrompt", false);
put("v2.getLLMObsPromptVersion", false);
put("v2.listLLMObsAnnotationQueues", false);
put("v2.listLLMObsDatasetRecords", false);
put("v2.listLLMObsDatasets", false);
Expand All @@ -822,6 +827,8 @@ public class ApiClient {
put("v2.listLLMObsPatternsTopics", false);
put("v2.listLLMObsPatternsTopicsWithClusteredPoints", false);
put("v2.listLLMObsProjects", false);
put("v2.listLLMObsPrompts", false);
put("v2.listLLMObsPromptVersions", false);
put("v2.listLLMObsSpans", false);
put("v2.lockLLMObsDatasetDraftState", false);
put("v2.restoreLLMObsDatasetVersion", false);
Expand All @@ -837,6 +844,8 @@ public class ApiClient {
put("v2.updateLLMObsDatasetRecords", false);
put("v2.updateLLMObsExperiment", false);
put("v2.updateLLMObsProject", false);
put("v2.updateLLMObsPrompt", false);
put("v2.updateLLMObsPromptVersion", false);
put("v2.uploadLLMObsDatasetRecordsFile", false);
put("v2.upsertLLMObsAnnotations", false);
put("v2.upsertLLMObsPatternsConfig", false);
Expand Down
Loading
Loading