diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index e09ffe0168e..d8d10fbdb7c 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -14218,6 +14218,123 @@ menu: unstable: - v2 order: 34 + - name: Update a specific LLM Observability prompt version + url: /api/latest/llm-observability/update-a-specific-llm-observability-prompt-version/ + identifier: llm-observability-update-a-specific-llm-observability-prompt-version + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - UpdateLLMObsPromptVersion + unstable: + - v2 + order: 72 + - name: Get a specific LLM Observability prompt version + url: /api/latest/llm-observability/get-a-specific-llm-observability-prompt-version/ + identifier: llm-observability-get-a-specific-llm-observability-prompt-version + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - GetLLMObsPromptVersion + unstable: + - v2 + order: 71 + - name: Create a new LLM Observability prompt version + url: /api/latest/llm-observability/create-a-new-llm-observability-prompt-version/ + identifier: llm-observability-create-a-new-llm-observability-prompt-version + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - CreateLLMObsPromptVersion + unstable: + - v2 + order: 70 + - name: List versions of an LLM Observability prompt + url: /api/latest/llm-observability/list-versions-of-an-llm-observability-prompt/ + identifier: llm-observability-list-versions-of-an-llm-observability-prompt + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - ListLLMObsPromptVersions + unstable: + - v2 + order: 69 + - name: Update an LLM Observability prompt + url: /api/latest/llm-observability/update-an-llm-observability-prompt/ + identifier: llm-observability-update-an-llm-observability-prompt + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - UpdateLLMObsPrompt + unstable: + - v2 + order: 67 + - name: Get an LLM Observability prompt + url: /api/latest/llm-observability/get-an-llm-observability-prompt/ + identifier: llm-observability-get-an-llm-observability-prompt + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - GetLLMObsPrompt + unstable: + - v2 + order: 66 + - name: Delete an LLM Observability prompt + url: /api/latest/llm-observability/delete-an-llm-observability-prompt/ + identifier: llm-observability-delete-an-llm-observability-prompt + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - DeleteLLMObsPrompt + unstable: + - v2 + order: 68 + - name: Create an LLM Observability prompt + url: /api/latest/llm-observability/create-an-llm-observability-prompt/ + identifier: llm-observability-create-an-llm-observability-prompt + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - CreateLLMObsPrompt + unstable: + - v2 + order: 65 + - name: List LLM Observability prompts + url: /api/latest/llm-observability/list-llm-observability-prompts/ + identifier: llm-observability-list-llm-observability-prompts + parent: llm-observability + generated: true + params: + versions: + - v2 + operationids: + - ListLLMObsPrompts + unstable: + - v2 + order: 64 - name: Update an LLM Observability project url: /api/latest/llm-observability/update-an-llm-observability-project/ identifier: llm-observability-update-an-llm-observability-project diff --git a/content/en/api/latest/llm-observability/create-a-new-llm-observability-prompt-version/index.md b/content/en/api/latest/llm-observability/create-a-new-llm-observability-prompt-version/index.md new file mode 100644 index 00000000000..d8941f9b246 --- /dev/null +++ b/content/en/api/latest/llm-observability/create-a-new-llm-observability-prompt-version/index.md @@ -0,0 +1,3 @@ +--- +title: Create a new LLM Observability prompt version +--- diff --git a/content/en/api/latest/llm-observability/create-an-llm-observability-prompt/index.md b/content/en/api/latest/llm-observability/create-an-llm-observability-prompt/index.md new file mode 100644 index 00000000000..9f75e2614ed --- /dev/null +++ b/content/en/api/latest/llm-observability/create-an-llm-observability-prompt/index.md @@ -0,0 +1,3 @@ +--- +title: Create an LLM Observability prompt +--- diff --git a/content/en/api/latest/llm-observability/delete-an-llm-observability-prompt/index.md b/content/en/api/latest/llm-observability/delete-an-llm-observability-prompt/index.md new file mode 100644 index 00000000000..ac097ffd276 --- /dev/null +++ b/content/en/api/latest/llm-observability/delete-an-llm-observability-prompt/index.md @@ -0,0 +1,3 @@ +--- +title: Delete an LLM Observability prompt +--- diff --git a/content/en/api/latest/llm-observability/get-a-specific-llm-observability-prompt-version/index.md b/content/en/api/latest/llm-observability/get-a-specific-llm-observability-prompt-version/index.md new file mode 100644 index 00000000000..0b6b8b3b0f9 --- /dev/null +++ b/content/en/api/latest/llm-observability/get-a-specific-llm-observability-prompt-version/index.md @@ -0,0 +1,3 @@ +--- +title: Get a specific LLM Observability prompt version +--- diff --git a/content/en/api/latest/llm-observability/get-an-llm-observability-prompt/index.md b/content/en/api/latest/llm-observability/get-an-llm-observability-prompt/index.md new file mode 100644 index 00000000000..631946a5204 --- /dev/null +++ b/content/en/api/latest/llm-observability/get-an-llm-observability-prompt/index.md @@ -0,0 +1,3 @@ +--- +title: Get an LLM Observability prompt +--- diff --git a/content/en/api/latest/llm-observability/list-llm-observability-prompts/index.md b/content/en/api/latest/llm-observability/list-llm-observability-prompts/index.md new file mode 100644 index 00000000000..36caa45fdb4 --- /dev/null +++ b/content/en/api/latest/llm-observability/list-llm-observability-prompts/index.md @@ -0,0 +1,3 @@ +--- +title: List LLM Observability prompts +--- diff --git a/content/en/api/latest/llm-observability/list-versions-of-an-llm-observability-prompt/index.md b/content/en/api/latest/llm-observability/list-versions-of-an-llm-observability-prompt/index.md new file mode 100644 index 00000000000..cc4fb6bf5c3 --- /dev/null +++ b/content/en/api/latest/llm-observability/list-versions-of-an-llm-observability-prompt/index.md @@ -0,0 +1,3 @@ +--- +title: List versions of an LLM Observability prompt +--- diff --git a/content/en/api/latest/llm-observability/update-a-specific-llm-observability-prompt-version/index.md b/content/en/api/latest/llm-observability/update-a-specific-llm-observability-prompt-version/index.md new file mode 100644 index 00000000000..58f8687370f --- /dev/null +++ b/content/en/api/latest/llm-observability/update-a-specific-llm-observability-prompt-version/index.md @@ -0,0 +1,3 @@ +--- +title: Update a specific LLM Observability prompt version +--- diff --git a/content/en/api/latest/llm-observability/update-an-llm-observability-prompt/index.md b/content/en/api/latest/llm-observability/update-an-llm-observability-prompt/index.md new file mode 100644 index 00000000000..8afd86d15bf --- /dev/null +++ b/content/en/api/latest/llm-observability/update-an-llm-observability-prompt/index.md @@ -0,0 +1,3 @@ +--- +title: Update an LLM Observability prompt +--- diff --git a/content/en/api/v2/llm-observability/examples.json b/content/en/api/v2/llm-observability/examples.json index 93020e853c2..358d082b1c0 100644 --- a/content/en/api/v2/llm-observability/examples.json +++ b/content/en/api/v2/llm-observability/examples.json @@ -4745,6 +4745,994 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for updating an LLM Observability project.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for updating an LLM Observability project.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Updated description of the project.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Updated name of the project.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability project. \nAllowed enum values: projects

\n
\n \n
\n
\n
\n
" } }, + "ListLLMObsPrompts": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", + "created_at": "2025-01-15T10:00:00Z", + "created_from": "sdk-registry", + "description": "Answers customer questions using the company knowledge base.", + "in_registry": true, + "last_version_created_at": "2025-02-01T14:30:00Z", + "num_versions": 2, + "prompt_id": "customer-support-assistant", + "source": "registry", + "title": "Customer Support Assistant" + }, + "id": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "type": "prompt-templates" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of LLM Observability prompts.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an LLM Observability prompt registry entry.

\n
\n
\n
\n
\n
\n

author

\n
\n

string

\n

UUID of the user who authored the prompt.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the prompt was created.

\n
\n \n
\n
\n
\n
\n
\n

created_from [required]

\n
\n

string

\n

Source that created the prompt, such as ui-registry, sdk-registry, or sdk-instrumentation.

\n
\n \n
\n
\n
\n
\n
\n

datasets

\n
\n

[object]

\n

Datasets observed in runs associated with this prompt.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

extracted_from

\n
\n

string

\n

Source prompt from which this prompt was extracted, when applicable.

\n
\n \n
\n
\n
\n
\n
\n

in_registry [required]

\n
\n

boolean

\n

Whether the prompt is a registry entry (as opposed to a code-discovered prompt).

\n
\n \n
\n
\n
\n
\n
\n

last_seen_at

\n
\n

date-time

\n

Timestamp of the most recent observed run of this prompt.

\n
\n \n
\n
\n
\n
\n
\n

last_version_created_at

\n
\n

date-time

\n

Timestamp when the most recent version of the prompt was created.

\n
\n \n
\n
\n
\n
\n
\n

ml_app

\n
\n

string

\n

The ML application this prompt is associated with.

\n
\n \n
\n
\n
\n
\n
\n

ml_apps

\n
\n

[string]

\n

ML applications observed running this prompt.

\n
\n \n
\n
\n
\n
\n
\n

num_versions [required]

\n
\n

int64

\n

Number of versions of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

Whether the prompt was created from the registry or discovered from observed LLM calls. \nAllowed enum values: registry,code

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags observed on runs of this prompt.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the prompt.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt. \nAllowed enum values: prompt-templates

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateLLMObsPrompt": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", + "created_at": "2025-01-15T10:00:00Z", + "created_from": "sdk-registry", + "description": "Answers customer questions using the company knowledge base.", + "in_registry": true, + "last_version_created_at": "2025-01-15T10:00:00Z", + "num_versions": 1, + "prompt_id": "customer-support-assistant", + "source": "registry", + "title": "Customer Support Assistant" + }, + "id": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "type": "prompt-templates" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an LLM Observability prompt registry entry.

\n
\n
\n
\n
\n
\n

author

\n
\n

string

\n

UUID of the user who authored the prompt.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the prompt was created.

\n
\n \n
\n
\n
\n
\n
\n

created_from [required]

\n
\n

string

\n

Source that created the prompt, such as ui-registry, sdk-registry, or sdk-instrumentation.

\n
\n \n
\n
\n
\n
\n
\n

datasets

\n
\n

[object]

\n

Datasets observed in runs associated with this prompt.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

extracted_from

\n
\n

string

\n

Source prompt from which this prompt was extracted, when applicable.

\n
\n \n
\n
\n
\n
\n
\n

in_registry [required]

\n
\n

boolean

\n

Whether the prompt is a registry entry (as opposed to a code-discovered prompt).

\n
\n \n
\n
\n
\n
\n
\n

last_seen_at

\n
\n

date-time

\n

Timestamp of the most recent observed run of this prompt.

\n
\n \n
\n
\n
\n
\n
\n

last_version_created_at

\n
\n

date-time

\n

Timestamp when the most recent version of the prompt was created.

\n
\n \n
\n
\n
\n
\n
\n

ml_app

\n
\n

string

\n

The ML application this prompt is associated with.

\n
\n \n
\n
\n
\n
\n
\n

ml_apps

\n
\n

[string]

\n

ML applications observed running this prompt.

\n
\n \n
\n
\n
\n
\n
\n

num_versions [required]

\n
\n

int64

\n

Number of versions of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

Whether the prompt was created from the registry or discovered from observed LLM calls. \nAllowed enum values: registry,code

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags observed on runs of this prompt.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the prompt.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt. \nAllowed enum values: prompt-templates

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "409": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "prompt_id": "customer-support-assistant", + "template": {} + }, + "type": "prompt-templates" + } + }, + "json": { + "data": { + "attributes": { + "description": "string", + "env_ids": [], + "labels": [], + "prompt_id": "customer-support-assistant", + "template": { + "description": "You are a helpful assistant for {{audience}}.", + "minLength": "You are a helpful assistant for {{audience}}.", + "pattern": "You are a helpful assistant for {{audience}}.", + "type": "You are a helpful assistant for {{audience}}." + }, + "title": "string", + "user_version": "string" + }, + "type": "prompt-templates" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for creating an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an LLM Observability prompt and its first version. prompt_id and template are required; all other attributes are optional.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional description of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

env_ids

\n
\n

[string]

\n

Optional feature-flag environment UUIDs the service attempts to enable and configure to use the first version as their default after creation.

\n
\n \n
\n
\n
\n
\n
\n

labels

\n
\n

[string]

\n

DEPRECATED: Optional labels to attach to the first version. Do not use this attribute for new integrations.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier for the new prompt.

\n
\n \n
\n
\n
\n
\n
\n

template [required]

\n
\n

 <oneOf>

\n

A text template or a list of chat messages.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

string

\n

A text prompt template.

\n
\n \n
\n
\n
\n
\n
\n

Object 2

\n
\n

[object]

\n

A chat prompt template.

\n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

Content of the message.

\n
\n \n
\n
\n
\n
\n
\n

role [required]

\n
\n

string

\n

Role of the message (for example system, user, or assistant).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Optional title of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

user_version

\n
\n

string

\n

Optional user-supplied version identifier for the first version.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt. \nAllowed enum values: prompt-templates

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteLLMObsPrompt": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "deleted_at": "2025-02-10T09:15:00Z", + "prompt_id": "customer-support-assistant" + }, + "id": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "type": "prompt-templates" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object confirming that an LLM Observability prompt was deleted.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes confirming that an LLM Observability prompt was deleted.

\n
\n
\n
\n
\n
\n

deleted_at [required]

\n
\n

date-time

\n

Timestamp when the prompt was deleted.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier of the deleted prompt.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the deleted prompt.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt. \nAllowed enum values: prompt-templates

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetLLMObsPrompt": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "chat_template": [ + { + "content": "You are a helpful customer support assistant for {{company_name}}.", + "role": "system" + }, + { + "content": "Help {{customer_name}} with this question: {{question}}", + "role": "user" + } + ], + "prompt_id": "customer-support-assistant", + "prompt_version_uuid": "d83ab666-61cc-5545-a83b-2424bb85467b", + "version": "2" + }, + "id": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "type": "prompt-templates" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a flattened LLM Observability prompt version returned for SDK consumption.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a flattened prompt version returned for SDK consumption. Exactly one of template and chat_template is returned.

\n
\n
\n
\n
\n
\n

chat_template

\n
\n

[object]

\n

Chat template for this prompt version, as a list of role and content messages. Omitted for text templates.

\n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

Content of the message.

\n
\n \n
\n
\n
\n
\n
\n

role [required]

\n
\n

string

\n

Role of the message (for example system, user, or assistant).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

labels

\n
\n

[string]

\n

DEPRECATED: Labels attached to the selected version.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id

\n
\n

string

\n

Customer-provided identifier of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

prompt_version_uuid

\n
\n

string

\n

Unique identifier of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

template

\n
\n

string

\n

Text template for this prompt version. Omitted for chat templates.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version identifier for this prompt version. This is the sequential version number unless a user-supplied version identifier was set, in which case that identifier is used instead.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt. \nAllowed enum values: prompt-templates

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateLLMObsPrompt": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", + "created_at": "2025-01-15T10:00:00Z", + "created_from": "sdk-registry", + "description": "Answers customer questions using the company knowledge base.", + "in_registry": true, + "last_version_created_at": "2025-01-15T10:00:00Z", + "num_versions": 1, + "prompt_id": "customer-support-assistant", + "source": "registry", + "title": "Customer Support Assistant" + }, + "id": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "type": "prompt-templates" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an LLM Observability prompt registry entry.

\n
\n
\n
\n
\n
\n

author

\n
\n

string

\n

UUID of the user who authored the prompt.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the prompt was created.

\n
\n \n
\n
\n
\n
\n
\n

created_from [required]

\n
\n

string

\n

Source that created the prompt, such as ui-registry, sdk-registry, or sdk-instrumentation.

\n
\n \n
\n
\n
\n
\n
\n

datasets

\n
\n

[object]

\n

Datasets observed in runs associated with this prompt.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

extracted_from

\n
\n

string

\n

Source prompt from which this prompt was extracted, when applicable.

\n
\n \n
\n
\n
\n
\n
\n

in_registry [required]

\n
\n

boolean

\n

Whether the prompt is a registry entry (as opposed to a code-discovered prompt).

\n
\n \n
\n
\n
\n
\n
\n

last_seen_at

\n
\n

date-time

\n

Timestamp of the most recent observed run of this prompt.

\n
\n \n
\n
\n
\n
\n
\n

last_version_created_at

\n
\n

date-time

\n

Timestamp when the most recent version of the prompt was created.

\n
\n \n
\n
\n
\n
\n
\n

ml_app

\n
\n

string

\n

The ML application this prompt is associated with.

\n
\n \n
\n
\n
\n
\n
\n

ml_apps

\n
\n

[string]

\n

ML applications observed running this prompt.

\n
\n \n
\n
\n
\n
\n
\n

num_versions [required]

\n
\n

int64

\n

Number of versions of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

Whether the prompt was created from the registry or discovered from observed LLM calls. \nAllowed enum values: registry,code

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags observed on runs of this prompt.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the prompt.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the prompt.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt. \nAllowed enum values: prompt-templates

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": {}, + "type": "prompt-templates" + } + }, + "json": { + "data": { + "attributes": { + "description": "string", + "title": "string" + }, + "type": "prompt-templates" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for updating an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for updating an LLM Observability prompt. At least one of title or description must be provided; both attributes are optional individually.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional new description for the prompt.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Optional new title for the prompt.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt. \nAllowed enum values: prompt-templates

\n
\n \n
\n
\n
\n
" + } + }, + "ListLLMObsPromptVersions": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", + "created_at": "2025-02-01T14:30:00Z", + "description": "Give concise answers and cite relevant help-center articles.", + "prompt_id": "customer-support-assistant", + "prompt_uuid": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "version": 2, + "version_created_at": "2025-02-01T14:30:00Z" + }, + "id": "d83ab666-61cc-5545-a83b-2424bb85467b", + "type": "prompt-template-versions" + }, + { + "attributes": { + "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", + "created_at": "2025-01-15T10:00:00Z", + "description": "Initial customer support prompt.", + "prompt_id": "customer-support-assistant", + "prompt_uuid": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "version": 1, + "version_created_at": "2025-01-15T10:00:00Z" + }, + "id": "20e5280b-c75d-5699-8a70-a2773a751428", + "type": "prompt-template-versions" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Prompt versions ordered from newest to oldest.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a prompt version returned in a list, excluding its template.

\n
\n
\n
\n
\n
\n

author

\n
\n

string

\n

UUID of the user who authored this version.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp stored on this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

datasets

\n
\n

[object]

\n

Datasets observed in runs associated with this prompt version.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this version.

\n
\n \n
\n
\n
\n
\n
\n

labels

\n
\n

[string]

\n

DEPRECATED: Labels attached to this version (for example development, staging, production).

\n
\n \n
\n
\n
\n
\n
\n

last_seen_at

\n
\n

date-time

\n

Timestamp of the most recent observed run of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

ml_app

\n
\n

string

\n

The ML application this prompt is associated with.

\n
\n \n
\n
\n
\n
\n
\n

ml_apps

\n
\n

[string]

\n

ML applications observed running this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier of the parent prompt.

\n
\n \n
\n
\n
\n
\n
\n

prompt_uuid [required]

\n
\n

string

\n

Unique identifier of the parent prompt.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags observed on runs of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

user_version

\n
\n

string

\n

User-supplied identifier for this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

Sequential version number.

\n
\n \n
\n
\n
\n
\n
\n

version_created_at

\n
\n

date-time

\n

Timestamp when this version was created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the prompt version.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt version. \nAllowed enum values: prompt-template-versions

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateLLMObsPromptVersion": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", + "created_at": "2025-02-01T14:30:00Z", + "description": "Give concise answers and cite relevant help-center articles.", + "prompt_id": "customer-support-assistant", + "prompt_uuid": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "template": [ + { + "content": "You are a helpful customer support assistant for {{company_name}}.", + "role": "system" + }, + { + "content": "Help {{customer_name}} with this question: {{question}}", + "role": "user" + } + ], + "version": 2, + "version_created_at": "2025-02-01T14:30:00Z" + }, + "id": "d83ab666-61cc-5545-a83b-2424bb85467b", + "type": "prompt-template-versions" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a specific version of an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a specific version of an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

author

\n
\n

string

\n

UUID of the user who authored this version.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp stored on this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

datasets

\n
\n

[object]

\n

Datasets observed in runs associated with this prompt version.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this version.

\n
\n \n
\n
\n
\n
\n
\n

labels

\n
\n

[string]

\n

DEPRECATED: Labels attached to this version (for example development, staging, production).

\n
\n \n
\n
\n
\n
\n
\n

last_seen_at

\n
\n

date-time

\n

Timestamp of the most recent observed run of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

ml_app

\n
\n

string

\n

The ML application this prompt is associated with.

\n
\n \n
\n
\n
\n
\n
\n

ml_apps

\n
\n

[string]

\n

ML applications observed running this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier of the parent prompt.

\n
\n \n
\n
\n
\n
\n
\n

prompt_uuid [required]

\n
\n

string

\n

Unique identifier of the parent prompt.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags observed on runs of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

template [required]

\n
\n

 <oneOf>

\n

A text template or a list of chat messages.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

string

\n

A text prompt template.

\n
\n \n
\n
\n
\n
\n
\n

Object 2

\n
\n

[object]

\n

A chat prompt template.

\n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

Content of the message.

\n
\n \n
\n
\n
\n
\n
\n

role [required]

\n
\n

string

\n

Role of the message (for example system, user, or assistant).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_version

\n
\n

string

\n

User-supplied identifier for this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

Sequential version number.

\n
\n \n
\n
\n
\n
\n
\n

version_created_at

\n
\n

date-time

\n

Timestamp when this version was created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the prompt version.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt version. \nAllowed enum values: prompt-template-versions

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "template": {} + }, + "type": "prompt-template-versions" + } + }, + "json": { + "data": { + "attributes": { + "description": "string", + "env_ids": [], + "labels": [], + "template": { + "description": "You are a helpful assistant for {{audience}}.", + "minLength": "You are a helpful assistant for {{audience}}.", + "pattern": "You are a helpful assistant for {{audience}}.", + "type": "You are a helpful assistant for {{audience}}." + }, + "user_version": "string" + }, + "type": "prompt-template-versions" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for creating an LLM Observability prompt version.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating a new version of an LLM Observability prompt. template is required; all other attributes are optional.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional description of this version.

\n
\n \n
\n
\n
\n
\n
\n

env_ids

\n
\n

[string]

\n

Optional feature-flag environment UUIDs the service attempts to enable and configure to use this version as their default after creation.

\n
\n \n
\n
\n
\n
\n
\n

labels

\n
\n

[string]

\n

DEPRECATED: Optional labels to attach to this version. Do not use this attribute for new integrations.

\n
\n \n
\n
\n
\n
\n
\n

template [required]

\n
\n

 <oneOf>

\n

A text template or a list of chat messages.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

string

\n

A text prompt template.

\n
\n \n
\n
\n
\n
\n
\n

Object 2

\n
\n

[object]

\n

A chat prompt template.

\n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

Content of the message.

\n
\n \n
\n
\n
\n
\n
\n

role [required]

\n
\n

string

\n

Role of the message (for example system, user, or assistant).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_version

\n
\n

string

\n

Optional user-supplied version identifier for this version.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt version. \nAllowed enum values: prompt-template-versions

\n
\n \n
\n
\n
\n
" + } + }, + "GetLLMObsPromptVersion": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", + "created_at": "2025-02-01T14:30:00Z", + "description": "Give concise answers and cite relevant help-center articles.", + "prompt_id": "customer-support-assistant", + "prompt_uuid": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "template": [ + { + "content": "You are a helpful customer support assistant for {{company_name}}.", + "role": "system" + }, + { + "content": "Help {{customer_name}} with this question: {{question}}", + "role": "user" + } + ], + "version": 2, + "version_created_at": "2025-02-01T14:30:00Z" + }, + "id": "d83ab666-61cc-5545-a83b-2424bb85467b", + "type": "prompt-template-versions" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a specific version of an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a specific version of an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

author

\n
\n

string

\n

UUID of the user who authored this version.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp stored on this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

datasets

\n
\n

[object]

\n

Datasets observed in runs associated with this prompt version.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this version.

\n
\n \n
\n
\n
\n
\n
\n

labels

\n
\n

[string]

\n

DEPRECATED: Labels attached to this version (for example development, staging, production).

\n
\n \n
\n
\n
\n
\n
\n

last_seen_at

\n
\n

date-time

\n

Timestamp of the most recent observed run of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

ml_app

\n
\n

string

\n

The ML application this prompt is associated with.

\n
\n \n
\n
\n
\n
\n
\n

ml_apps

\n
\n

[string]

\n

ML applications observed running this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier of the parent prompt.

\n
\n \n
\n
\n
\n
\n
\n

prompt_uuid [required]

\n
\n

string

\n

Unique identifier of the parent prompt.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags observed on runs of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

template [required]

\n
\n

 <oneOf>

\n

A text template or a list of chat messages.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

string

\n

A text prompt template.

\n
\n \n
\n
\n
\n
\n
\n

Object 2

\n
\n

[object]

\n

A chat prompt template.

\n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

Content of the message.

\n
\n \n
\n
\n
\n
\n
\n

role [required]

\n
\n

string

\n

Role of the message (for example system, user, or assistant).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_version

\n
\n

string

\n

User-supplied identifier for this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

Sequential version number.

\n
\n \n
\n
\n
\n
\n
\n

version_created_at

\n
\n

date-time

\n

Timestamp when this version was created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the prompt version.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt version. \nAllowed enum values: prompt-template-versions

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateLLMObsPromptVersion": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", + "created_at": "2025-02-01T14:30:00Z", + "description": "Give concise answers and cite relevant help-center articles.", + "prompt_id": "customer-support-assistant", + "prompt_uuid": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", + "template": [ + { + "content": "You are a helpful customer support assistant for {{company_name}}.", + "role": "system" + }, + { + "content": "Help {{customer_name}} with this question: {{question}}", + "role": "user" + } + ], + "version": 2, + "version_created_at": "2025-02-01T14:30:00Z" + }, + "id": "d83ab666-61cc-5545-a83b-2424bb85467b", + "type": "prompt-template-versions" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a specific version of an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a specific version of an LLM Observability prompt.

\n
\n
\n
\n
\n
\n

author

\n
\n

string

\n

UUID of the user who authored this version.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp stored on this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

datasets

\n
\n

[object]

\n

Datasets observed in runs associated with this prompt version.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this version.

\n
\n \n
\n
\n
\n
\n
\n

labels

\n
\n

[string]

\n

DEPRECATED: Labels attached to this version (for example development, staging, production).

\n
\n \n
\n
\n
\n
\n
\n

last_seen_at

\n
\n

date-time

\n

Timestamp of the most recent observed run of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

ml_app

\n
\n

string

\n

The ML application this prompt is associated with.

\n
\n \n
\n
\n
\n
\n
\n

ml_apps

\n
\n

[string]

\n

ML applications observed running this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

prompt_id [required]

\n
\n

string

\n

Customer-provided identifier of the parent prompt.

\n
\n \n
\n
\n
\n
\n
\n

prompt_uuid [required]

\n
\n

string

\n

Unique identifier of the parent prompt.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags observed on runs of this prompt version.

\n
\n \n
\n
\n
\n
\n
\n

template [required]

\n
\n

 <oneOf>

\n

A text template or a list of chat messages.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

string

\n

A text prompt template.

\n
\n \n
\n
\n
\n
\n
\n

Object 2

\n
\n

[object]

\n

A chat prompt template.

\n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

Content of the message.

\n
\n \n
\n
\n
\n
\n
\n

role [required]

\n
\n

string

\n

Role of the message (for example system, user, or assistant).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_version

\n
\n

string

\n

User-supplied identifier for this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

Sequential version number.

\n
\n \n
\n
\n
\n
\n
\n

version_created_at

\n
\n

date-time

\n

Timestamp when this version was created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the prompt version.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt version. \nAllowed enum values: prompt-template-versions

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": {}, + "type": "prompt-template-versions" + } + }, + "json": { + "data": { + "attributes": { + "description": "string", + "env_ids": [], + "labels": [] + }, + "type": "prompt-template-versions" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for updating an LLM Observability prompt version.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for updating an LLM Observability prompt version. At least one of description, labels, or env_ids must be provided; all three attributes are optional individually.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional new description for this version.

\n
\n \n
\n
\n
\n
\n
\n

env_ids

\n
\n

[string]

\n

Optional feature-flag environment UUIDs the service attempts to enable and configure to use this version as their default.

\n
\n \n
\n
\n
\n
\n
\n

labels

\n
\n

[string]

\n

DEPRECATED: Optional new labels for this version. Do not use this attribute for new integrations.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type of an LLM Observability prompt version. \nAllowed enum values: prompt-template-versions

\n
\n \n
\n
\n
\n
" + } + }, "ListLLMObsSpans": { "responses": { "200": { diff --git a/content/en/api/v2/llm-observability/request.CreateLLMObsPrompt.json b/content/en/api/v2/llm-observability/request.CreateLLMObsPrompt.json new file mode 100644 index 00000000000..d9caf179043 --- /dev/null +++ b/content/en/api/v2/llm-observability/request.CreateLLMObsPrompt.json @@ -0,0 +1,10 @@ +{ + "data": { + "attributes": { + "prompt_id": "Example-LLM-Observability", + "title": "Customer Support Assistant", + "template": "You are a helpful customer support assistant for {{company_name}}. Help {{customer_name}} with this question: {{question}}" + }, + "type": "prompt-templates" + } +} \ No newline at end of file diff --git a/content/en/api/v2/llm-observability/request.CreateLLMObsPromptVersion.json b/content/en/api/v2/llm-observability/request.CreateLLMObsPromptVersion.json new file mode 100644 index 00000000000..48b608687eb --- /dev/null +++ b/content/en/api/v2/llm-observability/request.CreateLLMObsPromptVersion.json @@ -0,0 +1,8 @@ +{ + "data": { + "attributes": { + "template": "You are a concise customer support assistant for {{company_name}}. Answer {{customer_name}}'s question: {{question}}" + }, + "type": "prompt-template-versions" + } +} \ No newline at end of file diff --git a/content/en/api/v2/llm-observability/request.UpdateLLMObsPrompt.json b/content/en/api/v2/llm-observability/request.UpdateLLMObsPrompt.json new file mode 100644 index 00000000000..ffa5f72cc51 --- /dev/null +++ b/content/en/api/v2/llm-observability/request.UpdateLLMObsPrompt.json @@ -0,0 +1,8 @@ +{ + "data": { + "attributes": { + "title": "Customer Support Assistant" + }, + "type": "prompt-templates" + } +} \ No newline at end of file diff --git a/content/en/api/v2/llm-observability/request.UpdateLLMObsPromptVersion.json b/content/en/api/v2/llm-observability/request.UpdateLLMObsPromptVersion.json new file mode 100644 index 00000000000..2d379f38e23 --- /dev/null +++ b/content/en/api/v2/llm-observability/request.UpdateLLMObsPromptVersion.json @@ -0,0 +1,8 @@ +{ + "data": { + "attributes": { + "description": "Give concise answers and cite relevant help-center articles." + }, + "type": "prompt-template-versions" + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index da58d66ffe1..fb2b7d262da 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -1100,6 +1100,34 @@ "description": "Update a personal access token returns \"OK\" response" } ], + "CreateLLMObsPromptVersion": [ + { + "group": "llm_observability", + "suffix": "", + "description": "Create a new LLM Observability prompt version returns \"OK\" response" + } + ], + "CreateLLMObsPrompt": [ + { + "group": "llm_observability", + "suffix": "", + "description": "Create an LLM Observability prompt returns \"OK\" response" + } + ], + "UpdateLLMObsPromptVersion": [ + { + "group": "llm_observability", + "suffix": "", + "description": "Update a specific LLM Observability prompt version returns \"OK\" response" + } + ], + "UpdateLLMObsPrompt": [ + { + "group": "llm_observability", + "suffix": "", + "description": "Update an LLM Observability prompt returns \"OK\" response" + } + ], "AggregateLogs": [ { "group": "logs", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 72b777981e1..2f787ccce4b 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -1009,6 +1009,32 @@ components: required: true schema: type: string + LLMObsPromptIDPathParameter: + description: The customer-provided identifier of the LLM Observability prompt. + example: "customer-support-assistant" + in: path + name: prompt_id + required: true + schema: + type: string + LLMObsPromptLabelQueryParameter: + description: >- + **Deprecated.** Optional label of the prompt version to return. Do not use this parameter for new integrations. If omitted, the latest version is returned. If the prompt has no labels, the latest version is returned even when a label is requested. If the prompt has labels but none match the requested label, a 404 response is returned. + in: query + name: label + required: false + schema: + type: string + LLMObsPromptVersionPathParameter: + description: The version number of the LLM Observability prompt. + example: 1 + in: path + name: version + required: true + schema: + format: int64 + minimum: 1 + type: integer LinkIDPathParameter: description: "The UUID of the case link." in: path @@ -52209,6 +52235,108 @@ components: $ref: "#/components/schemas/LLMObsContentBlock" minItems: 1 type: array + LLMObsCreatePromptData: + description: Data object for creating an LLM Observability prompt. + properties: + attributes: + $ref: "#/components/schemas/LLMObsCreatePromptDataAttributes" + type: + $ref: "#/components/schemas/LLMObsPromptType" + required: + - type + - attributes + type: object + LLMObsCreatePromptDataAttributes: + description: >- + Attributes for creating an LLM Observability prompt and its first version. `prompt_id` and `template` are required; all other attributes are optional. + properties: + description: + description: Optional description of the prompt. + type: string + env_ids: + description: >- + Optional feature-flag environment UUIDs the service attempts to enable and configure to use the first version as their default after creation. + items: + type: string + type: array + labels: + deprecated: true + description: >- + Optional labels to attach to the first version. Do not use this attribute for new integrations. + items: + $ref: "#/components/schemas/LLMObsPromptVersionLabel" + type: array + prompt_id: + description: Customer-provided identifier for the new prompt. + example: "customer-support-assistant" + minLength: 1 + type: string + template: + $ref: "#/components/schemas/LLMObsPromptTemplate" + title: + description: Optional title of the prompt. + type: string + user_version: + description: Optional user-supplied version identifier for the first version. + type: string + required: + - prompt_id + - template + type: object + LLMObsCreatePromptRequest: + description: Request to create an LLM Observability prompt. + properties: + data: + $ref: "#/components/schemas/LLMObsCreatePromptData" + required: + - data + type: object + LLMObsCreatePromptVersionData: + description: Data object for creating an LLM Observability prompt version. + properties: + attributes: + $ref: "#/components/schemas/LLMObsCreatePromptVersionDataAttributes" + type: + $ref: "#/components/schemas/LLMObsPromptVersionType" + required: + - type + - attributes + type: object + LLMObsCreatePromptVersionDataAttributes: + description: >- + Attributes for creating a new version of an LLM Observability prompt. `template` is required; all other attributes are optional. + properties: + description: + description: Optional description of this version. + type: string + env_ids: + description: >- + Optional feature-flag environment UUIDs the service attempts to enable and configure to use this version as their default after creation. + items: + type: string + type: array + labels: + deprecated: true + description: Optional labels to attach to this version. Do not use this attribute for new integrations. + items: + $ref: "#/components/schemas/LLMObsPromptVersionLabel" + type: array + template: + $ref: "#/components/schemas/LLMObsPromptTemplate" + user_version: + description: Optional user-supplied version identifier for this version. + type: string + required: + - template + type: object + LLMObsCreatePromptVersionRequest: + description: Request to create a new version of an LLM Observability prompt. + properties: + data: + $ref: "#/components/schemas/LLMObsCreatePromptVersionData" + required: + - data + type: object LLMObsCursorMeta: description: Pagination cursor metadata. properties: @@ -53684,6 +53812,53 @@ components: required: - data type: object + LLMObsDeletedPromptData: + description: Data object confirming that an LLM Observability prompt was deleted. + properties: + attributes: + $ref: "#/components/schemas/LLMObsDeletedPromptDataAttributes" + id: + description: Unique identifier of the deleted prompt. + example: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: string + type: + $ref: "#/components/schemas/LLMObsPromptType" + required: + - id + - type + - attributes + type: object + LLMObsDeletedPromptDataAttributes: + description: Attributes confirming that an LLM Observability prompt was deleted. + properties: + deleted_at: + description: Timestamp when the prompt was deleted. + example: "2025-02-10T09:15:00Z" + format: date-time + type: string + prompt_id: + description: Customer-provided identifier of the deleted prompt. + example: "customer-support-assistant" + type: string + required: + - prompt_id + - deleted_at + type: object + LLMObsDeletedPromptResponse: + description: Response confirming that an LLM Observability prompt was deleted. + example: + data: + attributes: + deleted_at: "2025-02-10T09:15:00Z" + prompt_id: "customer-support-assistant" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates + properties: + data: + $ref: "#/components/schemas/LLMObsDeletedPromptData" + required: + - data + type: object LLMObsDisplayBlockAnnotatedInteractionItem: description: A display_block interaction with its associated annotations. properties: @@ -56778,6 +56953,521 @@ components: required: - data type: object + LLMObsPromptChatMessage: + description: A single chat message in a prompt template. + properties: + content: + description: Content of the message. + example: "You are a helpful customer support assistant for {{company_name}}." + type: string + role: + description: Role of the message (for example `system`, `user`, or `assistant`). + example: "system" + type: string + required: + - role + - content + type: object + LLMObsPromptChatTemplate: + description: A chat prompt template. + items: + $ref: "#/components/schemas/LLMObsPromptChatMessage" + minItems: 1 + type: array + x-generate-alias-as-model: true + LLMObsPromptData: + description: Data object for an LLM Observability prompt. + properties: + attributes: + $ref: "#/components/schemas/LLMObsPromptDataAttributes" + id: + description: Unique identifier of the prompt. + example: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: string + type: + $ref: "#/components/schemas/LLMObsPromptType" + required: + - id + - type + - attributes + type: object + LLMObsPromptDataAttributes: + description: Attributes of an LLM Observability prompt registry entry. + properties: + author: + description: UUID of the user who authored the prompt. + type: string + created_at: + description: Timestamp when the prompt was created. + format: date-time + type: string + created_from: + description: >- + Source that created the prompt, such as `ui-registry`, `sdk-registry`, or `sdk-instrumentation`. + example: "sdk-registry" + type: string + datasets: + description: Datasets observed in runs associated with this prompt. + items: + $ref: "#/components/schemas/LLMObsPromptDataset" + type: array + description: + description: Description of the prompt. + type: string + extracted_from: + description: Source prompt from which this prompt was extracted, when applicable. + type: string + in_registry: + description: Whether the prompt is a registry entry (as opposed to a code-discovered prompt). + example: true + type: boolean + last_seen_at: + description: Timestamp of the most recent observed run of this prompt. + format: date-time + type: string + last_version_created_at: + description: Timestamp when the most recent version of the prompt was created. + format: date-time + type: string + ml_app: + description: The ML application this prompt is associated with. + type: string + ml_apps: + description: ML applications observed running this prompt. + items: + type: string + type: array + num_versions: + description: Number of versions of the prompt. + example: 2 + format: int64 + type: integer + prompt_id: + description: Customer-provided identifier of the prompt. + example: "customer-support-assistant" + type: string + source: + $ref: "#/components/schemas/LLMObsPromptResponseSource" + tags: + description: Tags observed on runs of this prompt. + items: + type: string + type: array + title: + description: Title of the prompt. + type: string + required: + - prompt_id + - source + - num_versions + - in_registry + - created_from + type: object + LLMObsPromptDataset: + description: A dataset observed in runs associated with a prompt or prompt version. + properties: + id: + description: Unique identifier of the dataset. + example: "" + type: string + name: + description: Name of the dataset. + type: string + required: + - id + type: object + LLMObsPromptResponse: + description: Response containing a single LLM Observability prompt. + example: + data: + attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-01-15T10:00:00Z" + created_from: "sdk-registry" + description: "Answers customer questions using the company knowledge base." + in_registry: true + last_version_created_at: "2025-01-15T10:00:00Z" + num_versions: 1 + prompt_id: "customer-support-assistant" + source: registry + title: "Customer Support Assistant" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates + properties: + data: + $ref: "#/components/schemas/LLMObsPromptData" + required: + - data + type: object + LLMObsPromptResponseSource: + description: Whether the prompt was created from the registry or discovered from observed LLM calls. + enum: + - registry + - code + example: registry + type: string + x-enum-varnames: + - REGISTRY + - CODE + LLMObsPromptSDKData: + description: Data object for a flattened LLM Observability prompt version returned for SDK consumption. + properties: + attributes: + $ref: "#/components/schemas/LLMObsPromptSDKDataAttributes" + id: + description: Unique identifier of the prompt. + example: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: string + type: + $ref: "#/components/schemas/LLMObsPromptType" + required: + - id + - type + - attributes + type: object + LLMObsPromptSDKDataAttributes: + description: >- + Attributes of a flattened prompt version returned for SDK consumption. Exactly one of `template` and `chat_template` is returned. + properties: + chat_template: + description: >- + Chat template for this prompt version, as a list of role and content messages. Omitted for text templates. + items: + $ref: "#/components/schemas/LLMObsPromptChatMessage" + type: array + labels: + deprecated: true + description: Labels attached to the selected version. + items: + type: string + type: array + prompt_id: + description: Customer-provided identifier of the prompt. + example: "customer-support-assistant" + type: string + prompt_version_uuid: + description: Unique identifier of this prompt version. + example: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: string + template: + description: Text template for this prompt version. Omitted for chat templates. + type: string + version: + description: >- + Version identifier for this prompt version. This is the sequential version number unless a user-supplied version identifier was set, in which case that identifier is used instead. + example: "2" + type: string + type: object + LLMObsPromptSDKResponse: + description: Response containing a flattened LLM Observability prompt version for SDK consumption. + example: + data: + attributes: + chat_template: + - content: "You are a helpful customer support assistant for {{company_name}}." + role: "system" + - content: "Help {{customer_name}} with this question: {{question}}" + role: "user" + prompt_id: "customer-support-assistant" + prompt_version_uuid: "d83ab666-61cc-5545-a83b-2424bb85467b" + version: "2" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates + properties: + data: + $ref: "#/components/schemas/LLMObsPromptSDKData" + required: + - data + type: object + LLMObsPromptTemplate: + description: A text template or a list of chat messages. + example: "You are a helpful assistant for {{audience}}." + oneOf: + - $ref: "#/components/schemas/LLMObsPromptTextTemplate" + - $ref: "#/components/schemas/LLMObsPromptChatTemplate" + LLMObsPromptTextTemplate: + description: A text prompt template. + minLength: 1 + pattern: ".*\\S.*" + type: string + LLMObsPromptType: + description: Resource type of an LLM Observability prompt. + enum: + - prompt-templates + example: prompt-templates + type: string + x-enum-varnames: + - PROMPT_TEMPLATES + LLMObsPromptVersionData: + description: Data object for a specific version of an LLM Observability prompt. + properties: + attributes: + $ref: "#/components/schemas/LLMObsPromptVersionDataAttributes" + id: + description: Unique identifier of the prompt version. + example: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: string + type: + $ref: "#/components/schemas/LLMObsPromptVersionType" + required: + - id + - type + - attributes + type: object + LLMObsPromptVersionDataAttributes: + description: Attributes of a specific version of an LLM Observability prompt. + properties: + author: + description: UUID of the user who authored this version. + type: string + created_at: + description: Timestamp stored on this prompt version. + format: date-time + type: string + datasets: + description: Datasets observed in runs associated with this prompt version. + items: + $ref: "#/components/schemas/LLMObsPromptDataset" + type: array + description: + description: Description of this version. + type: string + labels: + deprecated: true + description: Labels attached to this version (for example `development`, `staging`, `production`). + items: + type: string + type: array + last_seen_at: + description: Timestamp of the most recent observed run of this prompt version. + format: date-time + type: string + ml_app: + description: The ML application this prompt is associated with. + type: string + ml_apps: + description: ML applications observed running this prompt version. + items: + type: string + type: array + prompt_id: + description: Customer-provided identifier of the parent prompt. + example: "customer-support-assistant" + type: string + prompt_uuid: + description: Unique identifier of the parent prompt. + example: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: string + tags: + description: Tags observed on runs of this prompt version. + items: + type: string + type: array + template: + $ref: "#/components/schemas/LLMObsPromptTemplate" + user_version: + description: User-supplied identifier for this version. + type: string + version: + description: Sequential version number. + example: 1 + format: int64 + minimum: 1 + type: integer + version_created_at: + description: Timestamp when this version was created. + format: date-time + type: string + required: + - prompt_uuid + - prompt_id + - template + - version + type: object + LLMObsPromptVersionLabel: + description: A label attached to an LLM Observability prompt version. + enum: + - production + - development + type: string + x-enum-varnames: + - PRODUCTION + - DEVELOPMENT + LLMObsPromptVersionListData: + description: Data object for a prompt version returned in a list. + properties: + attributes: + $ref: "#/components/schemas/LLMObsPromptVersionListDataAttributes" + id: + description: Unique identifier of the prompt version. + example: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: string + type: + $ref: "#/components/schemas/LLMObsPromptVersionType" + required: + - id + - type + - attributes + type: object + LLMObsPromptVersionListDataAttributes: + description: Attributes of a prompt version returned in a list, excluding its template. + properties: + author: + description: UUID of the user who authored this version. + type: string + created_at: + description: Timestamp stored on this prompt version. + format: date-time + type: string + datasets: + description: Datasets observed in runs associated with this prompt version. + items: + $ref: "#/components/schemas/LLMObsPromptDataset" + type: array + description: + description: Description of this version. + type: string + labels: + deprecated: true + description: Labels attached to this version (for example `development`, `staging`, `production`). + items: + type: string + type: array + last_seen_at: + description: Timestamp of the most recent observed run of this prompt version. + format: date-time + type: string + ml_app: + description: The ML application this prompt is associated with. + type: string + ml_apps: + description: ML applications observed running this prompt version. + items: + type: string + type: array + prompt_id: + description: Customer-provided identifier of the parent prompt. + example: "customer-support-assistant" + type: string + prompt_uuid: + description: Unique identifier of the parent prompt. + example: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: string + tags: + description: Tags observed on runs of this prompt version. + items: + type: string + type: array + user_version: + description: User-supplied identifier for this version. + type: string + version: + description: Sequential version number. + example: 1 + format: int64 + minimum: 1 + type: integer + version_created_at: + description: Timestamp when this version was created. + format: date-time + type: string + required: + - prompt_uuid + - prompt_id + - version + type: object + LLMObsPromptVersionResponse: + description: Response containing a specific version of an LLM Observability prompt. + example: + data: + attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-02-01T14:30:00Z" + description: "Give concise answers and cite relevant help-center articles." + prompt_id: "customer-support-assistant" + prompt_uuid: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + template: + - content: "You are a helpful customer support assistant for {{company_name}}." + role: "system" + - content: "Help {{customer_name}} with this question: {{question}}" + role: "user" + version: 2 + version_created_at: "2025-02-01T14:30:00Z" + id: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: prompt-template-versions + properties: + data: + $ref: "#/components/schemas/LLMObsPromptVersionData" + required: + - data + type: object + LLMObsPromptVersionType: + description: Resource type of an LLM Observability prompt version. + enum: + - prompt-template-versions + example: prompt-template-versions + type: string + x-enum-varnames: + - PROMPT_TEMPLATE_VERSIONS + LLMObsPromptVersionsResponse: + description: Response containing the versions of an LLM Observability prompt. + example: + data: + - attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-02-01T14:30:00Z" + description: "Give concise answers and cite relevant help-center articles." + prompt_id: "customer-support-assistant" + prompt_uuid: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + version: 2 + version_created_at: "2025-02-01T14:30:00Z" + id: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: prompt-template-versions + - attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-01-15T10:00:00Z" + description: "Initial customer support prompt." + prompt_id: "customer-support-assistant" + prompt_uuid: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + version: 1 + version_created_at: "2025-01-15T10:00:00Z" + id: "20e5280b-c75d-5699-8a70-a2773a751428" + type: prompt-template-versions + properties: + data: + description: Prompt versions ordered from newest to oldest. + items: + $ref: "#/components/schemas/LLMObsPromptVersionListData" + type: array + required: + - data + type: object + LLMObsPromptsResponse: + description: Response containing a list of LLM Observability prompts. + example: + data: + - attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-01-15T10:00:00Z" + created_from: "sdk-registry" + description: "Answers customer questions using the company knowledge base." + in_registry: true + last_version_created_at: "2025-02-01T14:30:00Z" + num_versions: 2 + prompt_id: "customer-support-assistant" + source: registry + title: "Customer Support Assistant" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates + properties: + data: + description: List of LLM Observability prompts. + items: + $ref: "#/components/schemas/LLMObsPromptData" + type: array + required: + - data + type: object LLMObsRecordType: description: Resource type of LLM Observability dataset records. enum: @@ -57271,6 +57961,79 @@ components: - TRACE - EXPERIMENT_TRACE - SESSION + LLMObsUpdatePromptData: + description: Data object for updating an LLM Observability prompt. + properties: + attributes: + $ref: "#/components/schemas/LLMObsUpdatePromptDataAttributes" + type: + $ref: "#/components/schemas/LLMObsPromptType" + required: + - type + - attributes + type: object + LLMObsUpdatePromptDataAttributes: + additionalProperties: false + description: >- + Attributes for updating an LLM Observability prompt. At least one of `title` or `description` must be provided; both attributes are optional individually. + minProperties: 1 + properties: + description: + description: Optional new description for the prompt. + type: string + title: + description: Optional new title for the prompt. + type: string + type: object + LLMObsUpdatePromptRequest: + description: Request to update an LLM Observability prompt's metadata. + properties: + data: + $ref: "#/components/schemas/LLMObsUpdatePromptData" + required: + - data + type: object + LLMObsUpdatePromptVersionData: + description: Data object for updating an LLM Observability prompt version. + properties: + attributes: + $ref: "#/components/schemas/LLMObsUpdatePromptVersionDataAttributes" + type: + $ref: "#/components/schemas/LLMObsPromptVersionType" + required: + - type + - attributes + type: object + LLMObsUpdatePromptVersionDataAttributes: + additionalProperties: false + description: >- + Attributes for updating an LLM Observability prompt version. At least one of `description`, `labels`, or `env_ids` must be provided; all three attributes are optional individually. + minProperties: 1 + properties: + description: + description: Optional new description for this version. + type: string + env_ids: + description: >- + Optional feature-flag environment UUIDs the service attempts to enable and configure to use this version as their default. + items: + type: string + type: array + labels: + deprecated: true + description: Optional new labels for this version. Do not use this attribute for new integrations. + items: + $ref: "#/components/schemas/LLMObsPromptVersionLabel" + type: array + type: object + LLMObsUpdatePromptVersionRequest: + description: Request to update an LLM Observability prompt version's metadata or feature-flag environments. + properties: + data: + $ref: "#/components/schemas/LLMObsUpdatePromptVersionData" + required: + - data + type: object LLMObsUpsertAnnotationItem: description: |- A single annotation to create or update. The annotation is matched by @@ -152644,19 +153407,711 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: Push events for an LLM Observability experiment + summary: Push events for an LLM Observability experiment + tags: + - LLM Observability + x-menu-order: 17 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/integrations/{integration}/accounts: + get: + description: Retrieve the list of configured accounts for the specified LLM provider integration. + operationId: ListLLMObsIntegrationAccounts + parameters: + - $ref: "#/components/parameters/LLMObsIntegrationPathParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + - account_id: "org-XYZ123" + account_name: "Production OpenAI" + account_region: "" + id: "account-abc123" + integration: "openai" + schema: + items: + $ref: "#/components/schemas/LLMObsIntegrationAccount" + type: array + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: List LLM integration accounts + tags: + - LLM Observability + x-menu-order: 37 + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/integrations/{integration}/{account_id}/inference: + post: + description: Run an LLM inference request through the specified integration and account, returning the model response and token usage. + operationId: CreateLLMObsIntegrationInference + parameters: + - $ref: "#/components/parameters/LLMObsIntegrationPathParameter" + - $ref: "#/components/parameters/LLMObsAccountIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + max_tokens: 256 + messages: + - content: "What is the capital of France?" + role: "user" + model_id: "gpt-4o" + temperature: 0.7 + schema: + $ref: "#/components/schemas/LLMObsIntegrationInferenceRequest" + description: Inference request parameters. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + max_tokens: 256 + messages: + - content: "What is the capital of France?" + role: "user" + model_id: "gpt-4o" + response: + assessment: "pass" + content: "The capital of France is Paris." + finish_reason: "stop" + inference_codes: [] + input_tokens: 15 + latency: 843 + output_tokens: 9 + tools: [] + total_tokens: 24 + temperature: 0.7 + schema: + $ref: "#/components/schemas/LLMObsIntegrationInferenceResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Internal Server Error + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Run an LLM inference + tags: + - LLM Observability + x-menu-order: 39 + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/integrations/{integration}/{account_id}/models: + get: + description: Retrieve the list of models available for the specified LLM provider integration and account. + operationId: ListLLMObsIntegrationModels + parameters: + - $ref: "#/components/parameters/LLMObsIntegrationPathParameter" + - $ref: "#/components/parameters/LLMObsAccountIDPathParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + - has_access: true + id: "gpt-4o" + integration: "openai" + integration_display_name: "OpenAI" + json_schema: true + model_display_name: "GPT-4o" + model_id: "gpt-4o" + provider: "openai" + provider_display_name: "OpenAI" + schema: + items: + $ref: "#/components/schemas/LLMObsIntegrationModel" + type: array + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: List LLM integration models + tags: + - LLM Observability + x-menu-order: 38 + x-unstable: |- + **Note**: This endpoint is in Preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/projects: + get: + description: List all LLM Observability projects sorted by creation date, newest first. + operationId: ListLLMObsProjects + parameters: + - description: Filter projects by project ID. + in: query + name: filter[id] + schema: + type: string + - description: Filter projects by name. + in: query + name: filter[name] + schema: + type: string + - description: Use the Pagination cursor to retrieve the next page of results. + in: query + name: page[cursor] + schema: + type: string + - description: Maximum number of results to return per page. + in: query + name: page[limit] + schema: + format: int64 + type: integer + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: "" + name: My LLM Project + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000001 + type: projects + schema: + $ref: "#/components/schemas/LLMObsProjectsResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: List LLM Observability projects + tags: + - LLM Observability + x-menu-order: 1 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a new LLM Observability project. Returns the existing project if a name conflict occurs. + operationId: CreateLLMObsProject + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + name: My LLM Project + type: projects + schema: + $ref: "#/components/schemas/LLMObsProjectRequest" + description: Create project payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: "" + name: My LLM Project + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000002 + type: projects + schema: + $ref: "#/components/schemas/LLMObsProjectResponse" + description: OK + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: "" + name: My LLM Project + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000003 + type: projects + schema: + $ref: "#/components/schemas/LLMObsProjectResponse" + description: Created + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Create an LLM Observability project + tags: + - LLM Observability + x-menu-order: 2 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/projects/delete: + post: + description: Delete one or more LLM Observability projects. + operationId: DeleteLLMObsProjects + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + project_ids: + - a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + type: projects + schema: + $ref: "#/components/schemas/LLMObsDeleteProjectsRequest" + description: Delete projects payload. + required: true + responses: + "204": + description: No Content + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Delete LLM Observability projects + tags: + - LLM Observability + x-menu-order: 4 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/projects/{project_id}: + patch: + description: Partially update an existing LLM Observability project. + operationId: UpdateLLMObsProject + parameters: + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + type: projects + schema: + $ref: "#/components/schemas/LLMObsProjectUpdateRequest" + description: Update project payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: "" + name: My LLM Project + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000004 + type: projects + schema: + $ref: "#/components/schemas/LLMObsProjectResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Update an LLM Observability project + tags: + - LLM Observability + x-menu-order: 3 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/prompts: + get: + description: List all LLM Observability prompts in the prompt registry for the organization. + operationId: ListLLMObsPrompts + parameters: + - description: Optional filter for prompts by prompt ID. + example: "customer-support-assistant" + in: query + name: filter[prompt_id] + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-01-15T10:00:00Z" + created_from: "sdk-registry" + description: "Answers customer questions using the company knowledge base." + in_registry: true + last_version_created_at: "2025-02-01T14:30:00Z" + num_versions: 2 + prompt_id: "customer-support-assistant" + source: registry + title: "Customer Support Assistant" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates + schema: + $ref: "#/components/schemas/LLMObsPromptsResponse" + description: OK + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: List LLM Observability prompts + tags: + - LLM Observability + x-menu-order: 64 + x-permission: + operator: OR + permissions: + - llm_observability_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a new prompt (and its first version) in the LLM Observability prompt registry. + operationId: CreateLLMObsPrompt + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + description: "Answers customer questions using the company knowledge base." + prompt_id: "customer-support-assistant" + template: + - content: "You are a helpful customer support assistant for {{company_name}}." + role: "system" + - content: "Help {{customer_name}} with this question: {{question}}" + role: "user" + title: "Customer Support Assistant" + type: prompt-templates + schema: + $ref: "#/components/schemas/LLMObsCreatePromptRequest" + description: Create prompt payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-01-15T10:00:00Z" + created_from: "sdk-registry" + description: "Answers customer questions using the company knowledge base." + in_registry: true + last_version_created_at: "2025-01-15T10:00:00Z" + num_versions: 1 + prompt_id: "customer-support-assistant" + source: registry + title: "Customer Support Assistant" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates + schema: + $ref: "#/components/schemas/LLMObsPromptResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "409": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Conflict + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Create an LLM Observability prompt + tags: + - LLM Observability + x-menu-order: 65 + x-permission: + operator: AND + permissions: + - llm_observability_read + - llm_observability_write + - feature_flag_config_read + - feature_flag_config_write + - feature_flag_environment_config_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/prompts/{prompt_id}: + delete: + description: >- + Soft-delete an LLM Observability prompt. The prompt's version rows are retained, but they are no longer accessible through the public prompt registry endpoints. + operationId: DeleteLLMObsPrompt + parameters: + - $ref: "#/components/parameters/LLMObsPromptIDPathParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + deleted_at: "2025-02-10T09:15:00Z" + prompt_id: "customer-support-assistant" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates + schema: + $ref: "#/components/schemas/LLMObsDeletedPromptResponse" + description: OK + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Delete an LLM Observability prompt tags: - LLM Observability - x-menu-order: 17 + x-menu-order: 68 + x-permission: + operator: AND + permissions: + - llm_observability_read + - llm_observability_write + - feature_flag_config_read + - feature_flag_config_write + - feature_flag_environment_config_read x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/llm-obs/v1/integrations/{integration}/accounts: get: - description: Retrieve the list of configured accounts for the specified LLM provider integration. - operationId: ListLLMObsIntegrationAccounts + description: Get the latest version of an LLM Observability prompt by prompt ID. + operationId: GetLLMObsPrompt parameters: - - $ref: "#/components/parameters/LLMObsIntegrationPathParameter" + - $ref: "#/components/parameters/LLMObsPromptIDPathParameter" + - $ref: "#/components/parameters/LLMObsPromptLabelQueryParameter" responses: "200": content: @@ -152664,22 +154119,21 @@ paths: examples: default: value: - - account_id: "org-XYZ123" - account_name: "Production OpenAI" - account_region: "" - id: "account-abc123" - integration: "openai" + data: + attributes: + chat_template: + - content: "You are a helpful customer support assistant for {{company_name}}." + role: "system" + - content: "Help {{customer_name}} with this question: {{question}}" + role: "user" + prompt_id: "customer-support-assistant" + prompt_version_uuid: "d83ab666-61cc-5545-a83b-2424bb85467b" + version: "2" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates schema: - items: - $ref: "#/components/schemas/LLMObsIntegrationAccount" - type: array + $ref: "#/components/schemas/LLMObsPromptSDKResponse" description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Bad Request "401": content: application/json: @@ -152692,40 +154146,47 @@ paths: schema: $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - summary: List LLM integration accounts + summary: Get an LLM Observability prompt tags: - LLM Observability - x-menu-order: 37 + x-menu-order: 66 + x-permission: + operator: OR + permissions: + - llm_observability_read x-unstable: |- - **Note**: This endpoint is in Preview and is subject to change. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/llm-obs/v1/integrations/{integration}/{account_id}/inference: - post: - description: Run an LLM inference request through the specified integration and account, returning the model response and token usage. - operationId: CreateLLMObsIntegrationInference + patch: + description: Update the title, the description, or both, for an LLM Observability prompt. + operationId: UpdateLLMObsPrompt parameters: - - $ref: "#/components/parameters/LLMObsIntegrationPathParameter" - - $ref: "#/components/parameters/LLMObsAccountIDPathParameter" + - $ref: "#/components/parameters/LLMObsPromptIDPathParameter" requestBody: content: application/json: examples: default: value: - max_tokens: 256 - messages: - - content: "What is the capital of France?" - role: "user" - model_id: "gpt-4o" - temperature: 0.7 + data: + attributes: + description: "Answers customer questions using the company knowledge base." + title: "Customer Support Assistant" + type: prompt-templates schema: - $ref: "#/components/schemas/LLMObsIntegrationInferenceRequest" - description: Inference request parameters. + $ref: "#/components/schemas/LLMObsUpdatePromptRequest" + description: Update prompt payload. required: true responses: "200": @@ -152734,24 +154195,22 @@ paths: examples: default: value: - max_tokens: 256 - messages: - - content: "What is the capital of France?" - role: "user" - model_id: "gpt-4o" - response: - assessment: "pass" - content: "The capital of France is Paris." - finish_reason: "stop" - inference_codes: [] - input_tokens: 15 - latency: 843 - output_tokens: 9 - tools: [] - total_tokens: 24 - temperature: 0.7 + data: + attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-01-15T10:00:00Z" + created_from: "sdk-registry" + description: "Answers customer questions using the company knowledge base." + in_registry: true + last_version_created_at: "2025-01-15T10:00:00Z" + num_versions: 1 + prompt_id: "customer-support-assistant" + source: registry + title: "Customer Support Assistant" + id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + type: prompt-templates schema: - $ref: "#/components/schemas/LLMObsIntegrationInferenceResponse" + $ref: "#/components/schemas/LLMObsPromptResponse" description: OK "400": content: @@ -152771,108 +154230,39 @@ paths: schema: $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - "429": - $ref: "#/components/responses/TooManyRequestsResponse" - "500": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Internal Server Error - security: - - apiKeyAuth: [] - appKeyAuth: [] - summary: Run an LLM inference - tags: - - LLM Observability - x-menu-order: 39 - x-unstable: |- - **Note**: This endpoint is in Preview and is subject to change. - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/llm-obs/v1/integrations/{integration}/{account_id}/models: - get: - description: Retrieve the list of models available for the specified LLM provider integration and account. - operationId: ListLLMObsIntegrationModels - parameters: - - $ref: "#/components/parameters/LLMObsIntegrationPathParameter" - - $ref: "#/components/parameters/LLMObsAccountIDPathParameter" - responses: - "200": - content: - application/json: - examples: - default: - value: - - has_access: true - id: "gpt-4o" - integration: "openai" - integration_display_name: "OpenAI" - json_schema: true - model_display_name: "GPT-4o" - model_id: "gpt-4o" - provider: "openai" - provider_display_name: "OpenAI" - schema: - items: - $ref: "#/components/schemas/LLMObsIntegrationModel" - type: array - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Bad Request - "401": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Unauthorized - "403": + "404": content: application/json: schema: $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Forbidden + description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - summary: List LLM integration models + summary: Update an LLM Observability prompt tags: - LLM Observability - x-menu-order: 38 + x-menu-order: 67 + x-permission: + operator: AND + permissions: + - llm_observability_read + - llm_observability_write + - feature_flag_config_read + - feature_flag_config_write + - feature_flag_environment_config_read x-unstable: |- - **Note**: This endpoint is in Preview and is subject to change. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/llm-obs/v1/projects: + /api/v2/llm-obs/v1/prompts/{prompt_id}/versions: get: - description: List all LLM Observability projects sorted by creation date, newest first. - operationId: ListLLMObsProjects + description: >- + List all versions of an LLM Observability prompt, ordered newest to oldest. If the prompt does not exist, is not registered, or is archived, the response contains an empty list. + operationId: ListLLMObsPromptVersions parameters: - - description: Filter projects by project ID. - in: query - name: filter[id] - schema: - type: string - - description: Filter projects by name. - in: query - name: filter[name] - schema: - type: string - - description: Use the Pagination cursor to retrieve the next page of results. - in: query - name: page[cursor] - schema: - type: string - - description: Maximum number of results to return per page. - in: query - name: page[limit] - schema: - format: int64 - type: integer + - $ref: "#/components/parameters/LLMObsPromptIDPathParameter" responses: "200": content: @@ -152882,21 +154272,28 @@ paths: value: data: - attributes: - created_at: "2024-01-01T00:00:00+00:00" - description: "" - name: My LLM Project - updated_at: "2024-01-01T00:00:00+00:00" - id: 00000000-0000-0000-0000-000000000001 - type: projects + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-02-01T14:30:00Z" + description: "Give concise answers and cite relevant help-center articles." + prompt_id: "customer-support-assistant" + prompt_uuid: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + version: 2 + version_created_at: "2025-02-01T14:30:00Z" + id: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: prompt-template-versions + - attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-01-15T10:00:00Z" + description: "Initial customer support prompt." + prompt_id: "customer-support-assistant" + prompt_uuid: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + version: 1 + version_created_at: "2025-01-15T10:00:00Z" + id: "20e5280b-c75d-5699-8a70-a2773a751428" + type: prompt-template-versions schema: - $ref: "#/components/schemas/LLMObsProjectsResponse" + $ref: "#/components/schemas/LLMObsPromptVersionsResponse" description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Bad Request "401": content: application/json: @@ -152914,16 +154311,22 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: List LLM Observability projects + summary: List versions of an LLM Observability prompt tags: - LLM Observability - x-menu-order: 1 + x-menu-order: 69 + x-permission: + operator: OR + permissions: + - llm_observability_read x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: Create a new LLM Observability project. Returns the existing project if a name conflict occurs. - operationId: CreateLLMObsProject + description: Create a new version of an existing LLM Observability prompt. + operationId: CreateLLMObsPromptVersion + parameters: + - $ref: "#/components/parameters/LLMObsPromptIDPathParameter" requestBody: content: application/json: @@ -152932,11 +154335,16 @@ paths: value: data: attributes: - name: My LLM Project - type: projects + description: "Give concise answers and cite relevant help-center articles." + template: + - content: "You are a helpful customer support assistant for {{company_name}}." + role: "system" + - content: "Help {{customer_name}} with this question: {{question}}" + role: "user" + type: prompt-template-versions schema: - $ref: "#/components/schemas/LLMObsProjectRequest" - description: Create project payload. + $ref: "#/components/schemas/LLMObsCreatePromptVersionRequest" + description: Create prompt version payload. required: true responses: "200": @@ -152947,32 +154355,23 @@ paths: value: data: attributes: - created_at: "2024-01-01T00:00:00+00:00" - description: "" - name: My LLM Project - updated_at: "2024-01-01T00:00:00+00:00" - id: 00000000-0000-0000-0000-000000000002 - type: projects + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-02-01T14:30:00Z" + description: "Give concise answers and cite relevant help-center articles." + prompt_id: "customer-support-assistant" + prompt_uuid: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + template: + - content: "You are a helpful customer support assistant for {{company_name}}." + role: "system" + - content: "Help {{customer_name}} with this question: {{question}}" + role: "user" + version: 2 + version_created_at: "2025-02-01T14:30:00Z" + id: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: prompt-template-versions schema: - $ref: "#/components/schemas/LLMObsProjectResponse" + $ref: "#/components/schemas/LLMObsPromptVersionResponse" description: OK - "201": - content: - application/json: - examples: - default: - value: - data: - attributes: - created_at: "2024-01-01T00:00:00+00:00" - description: "" - name: My LLM Project - updated_at: "2024-01-01T00:00:00+00:00" - id: 00000000-0000-0000-0000-000000000003 - type: projects - schema: - $ref: "#/components/schemas/LLMObsProjectResponse" - description: Created "400": content: application/json: @@ -152991,40 +154390,65 @@ paths: schema: $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - summary: Create an LLM Observability project + summary: Create a new LLM Observability prompt version tags: - LLM Observability - x-menu-order: 2 + x-menu-order: 70 + x-permission: + operator: AND + permissions: + - llm_observability_read + - llm_observability_write + - feature_flag_config_read + - feature_flag_config_write + - feature_flag_environment_config_read x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/llm-obs/v1/projects/delete: - post: - description: Delete one or more LLM Observability projects. - operationId: DeleteLLMObsProjects - requestBody: - content: - application/json: - examples: - default: - value: - data: - attributes: - project_ids: - - a33671aa-24fd-4dcd-9b33-a8ec7dde7751 - type: projects - schema: - $ref: "#/components/schemas/LLMObsDeleteProjectsRequest" - description: Delete projects payload. - required: true + /api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version}: + get: + description: Get the full template of a single, specific version of an LLM Observability prompt. + operationId: GetLLMObsPromptVersion + parameters: + - $ref: "#/components/parameters/LLMObsPromptIDPathParameter" + - $ref: "#/components/parameters/LLMObsPromptVersionPathParameter" responses: - "204": - description: No Content + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-02-01T14:30:00Z" + description: "Give concise answers and cite relevant help-center articles." + prompt_id: "customer-support-assistant" + prompt_uuid: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + template: + - content: "You are a helpful customer support assistant for {{company_name}}." + role: "system" + - content: "Help {{customer_name}} with this question: {{question}}" + role: "user" + version: 2 + version_created_at: "2025-02-01T14:30:00Z" + id: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: prompt-template-versions + schema: + $ref: "#/components/schemas/LLMObsPromptVersionResponse" + description: OK "400": content: application/json: @@ -153043,24 +154467,35 @@ paths: schema: $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - summary: Delete LLM Observability projects + summary: Get a specific LLM Observability prompt version tags: - LLM Observability - x-menu-order: 4 + x-menu-order: 71 + x-permission: + operator: OR + permissions: + - llm_observability_read x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/llm-obs/v1/projects/{project_id}: patch: - description: Partially update an existing LLM Observability project. - operationId: UpdateLLMObsProject + description: >- + Update the description, the feature-flag environments, or both, for a specific version of an LLM Observability prompt. + operationId: UpdateLLMObsPromptVersion parameters: - - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" + - $ref: "#/components/parameters/LLMObsPromptIDPathParameter" + - $ref: "#/components/parameters/LLMObsPromptVersionPathParameter" requestBody: content: application/json: @@ -153068,10 +154503,12 @@ paths: default: value: data: - type: projects + attributes: + description: "Give concise answers and cite relevant help-center articles." + type: prompt-template-versions schema: - $ref: "#/components/schemas/LLMObsProjectUpdateRequest" - description: Update project payload. + $ref: "#/components/schemas/LLMObsUpdatePromptVersionRequest" + description: Update prompt version payload. required: true responses: "200": @@ -153082,14 +154519,22 @@ paths: value: data: attributes: - created_at: "2024-01-01T00:00:00+00:00" - description: "" - name: My LLM Project - updated_at: "2024-01-01T00:00:00+00:00" - id: 00000000-0000-0000-0000-000000000004 - type: projects + author: "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e" + created_at: "2025-02-01T14:30:00Z" + description: "Give concise answers and cite relevant help-center articles." + prompt_id: "customer-support-assistant" + prompt_uuid: "4a1a28ff-8a25-5f0f-946f-f48264d772eb" + template: + - content: "You are a helpful customer support assistant for {{company_name}}." + role: "system" + - content: "Help {{customer_name}} with this question: {{question}}" + role: "user" + version: 2 + version_created_at: "2025-02-01T14:30:00Z" + id: "d83ab666-61cc-5545-a83b-2424bb85467b" + type: prompt-template-versions schema: - $ref: "#/components/schemas/LLMObsProjectResponse" + $ref: "#/components/schemas/LLMObsPromptVersionResponse" description: OK "400": content: @@ -153120,10 +154565,18 @@ paths: security: - apiKeyAuth: [] appKeyAuth: [] - summary: Update an LLM Observability project + summary: Update a specific LLM Observability prompt version tags: - LLM Observability - x-menu-order: 3 + x-menu-order: 72 + x-permission: + operator: AND + permissions: + - llm_observability_read + - llm_observability_write + - feature_flag_config_read + - feature_flag_config_write + - feature_flag_environment_config_read x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). @@ -205298,7 +206751,8 @@ tags: description: Find out more at url: "https://docs.datadoghq.com/account_management/api-app-keys/" name: Key Management - - description: Manage LLM Observability spans, data, projects, datasets, dataset records, experiments, and annotations. + - description: >- + Manage LLM Observability spans, data, projects, datasets, dataset records, experiments, prompts, and annotations. name: LLM Observability - description: |- Search your logs and send them to your Datadog platform over HTTP. See the [Log Management page](https://docs.datadoghq.com/logs/) for more information. diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index c358ba5061b..d1227ec4017 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -3131,6 +3131,50 @@ "request_description": "Update project payload.", "request_schema_description": "Request to partially update an LLM Observability project." }, + "ListLLMObsPrompts": { + "description": "List all LLM Observability prompts in the prompt registry for the organization.", + "summary": "List LLM Observability prompts" + }, + "CreateLLMObsPrompt": { + "description": "Create a new prompt (and its first version) in the LLM Observability prompt registry.", + "summary": "Create an LLM Observability prompt", + "request_description": "Create prompt payload.", + "request_schema_description": "Request to create an LLM Observability prompt." + }, + "DeleteLLMObsPrompt": { + "description": "Soft-delete an LLM Observability prompt. The prompt's version rows are retained, but they are no longer accessible through the public prompt registry endpoints.", + "summary": "Delete an LLM Observability prompt" + }, + "GetLLMObsPrompt": { + "description": "Get the latest version of an LLM Observability prompt by prompt ID.", + "summary": "Get an LLM Observability prompt" + }, + "UpdateLLMObsPrompt": { + "description": "Update the title, the description, or both, for an LLM Observability prompt.", + "summary": "Update an LLM Observability prompt", + "request_description": "Update prompt payload.", + "request_schema_description": "Request to update an LLM Observability prompt's metadata." + }, + "ListLLMObsPromptVersions": { + "description": "List all versions of an LLM Observability prompt, ordered newest to oldest. If the prompt does not exist, is not registered, or is archived, the response contains an empty list.", + "summary": "List versions of an LLM Observability prompt" + }, + "CreateLLMObsPromptVersion": { + "description": "Create a new version of an existing LLM Observability prompt.", + "summary": "Create a new LLM Observability prompt version", + "request_description": "Create prompt version payload.", + "request_schema_description": "Request to create a new version of an LLM Observability prompt." + }, + "GetLLMObsPromptVersion": { + "description": "Get the full template of a single, specific version of an LLM Observability prompt.", + "summary": "Get a specific LLM Observability prompt version" + }, + "UpdateLLMObsPromptVersion": { + "description": "Update the description, the feature-flag environments, or both, for a specific version of an LLM Observability prompt.", + "summary": "Update a specific LLM Observability prompt version", + "request_description": "Update prompt version payload.", + "request_schema_description": "Request to update an LLM Observability prompt version's metadata or feature-flag environments." + }, "ListLLMObsSpans": { "description": "List LLM Observability spans matching the specified filters.", "summary": "List LLM Observability spans" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index 05a376b1bc8..c6fa75e4fdd 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -261,7 +261,7 @@ }, "llm-observability": { "name": "LLM Observability", - "description": "Manage LLM Observability spans, data, projects, datasets, dataset records, experiments, and annotations." + "description": "Manage LLM Observability spans, data, projects, datasets, dataset records, experiments, prompts, and annotations." }, "logs": { "name": "Logs",