diff --git a/hugo/config/_default/menus/api.en.yaml b/hugo/config/_default/menus/api.en.yaml index 00d6d42fd67..de9ea4cb64a 100644 --- a/hugo/config/_default/menus/api.en.yaml +++ b/hugo/config/_default/menus/api.en.yaml @@ -14445,7 +14445,7 @@ menu: - UploadLLMObsDatasetRecordsFile unstable: - v2 - order: 49 + order: 48 - name: List LLM Observability experiment events (v2) url: /api/latest/llm-observability/list-llm-observability-experiment-events-v2/ identifier: llm-observability-list-llm-observability-experiment-events-v2 @@ -14458,7 +14458,7 @@ menu: - ListLLMObsExperimentEventsV2 unstable: - v2 - order: 51 + order: 50 - name: List LLM Observability dataset versions url: /api/latest/llm-observability/list-llm-observability-dataset-versions/ identifier: llm-observability-list-llm-observability-dataset-versions @@ -14471,7 +14471,7 @@ menu: - ListLLMObsDatasetVersions unstable: - v2 - order: 44 + order: 43 - name: Restore an LLM Observability dataset version url: /api/latest/llm-observability/restore-an-llm-observability-dataset-version/ identifier: llm-observability-restore-an-llm-observability-dataset-version @@ -14484,7 +14484,7 @@ menu: - RestoreLLMObsDatasetVersion unstable: - v2 - order: 48 + order: 47 - name: Delete LLM Observability dataset records url: /api/latest/llm-observability/delete-llm-observability-dataset-records/ identifier: llm-observability-delete-llm-observability-dataset-records @@ -14549,7 +14549,7 @@ menu: - ExportLLMObsDataset unstable: - v2 - order: 45 + order: 44 - name: Unlock LLM Observability dataset draft state url: /api/latest/llm-observability/unlock-llm-observability-dataset-draft-state/ identifier: llm-observability-unlock-llm-observability-dataset-draft-state @@ -14562,7 +14562,7 @@ menu: - UnlockLLMObsDatasetDraftState unstable: - v2 - order: 43 + order: 42 - name: Lock LLM Observability dataset draft state url: /api/latest/llm-observability/lock-llm-observability-dataset-draft-state/ identifier: llm-observability-lock-llm-observability-dataset-draft-state @@ -14575,7 +14575,7 @@ menu: - LockLLMObsDatasetDraftState unstable: - v2 - order: 42 + order: 41 - name: Get LLM Observability dataset draft state url: /api/latest/llm-observability/get-llm-observability-dataset-draft-state/ identifier: llm-observability-get-llm-observability-dataset-draft-state @@ -14588,7 +14588,7 @@ menu: - GetLLMObsDatasetDraftState unstable: - v2 - order: 41 + order: 40 - name: Clone an LLM Observability dataset url: /api/latest/llm-observability/clone-an-llm-observability-dataset/ identifier: llm-observability-clone-an-llm-observability-dataset @@ -14601,7 +14601,7 @@ menu: - CloneLLMObsDataset unstable: - v2 - order: 47 + order: 46 - name: Batch update LLM Observability dataset records url: /api/latest/llm-observability/batch-update-llm-observability-dataset-records/ identifier: llm-observability-batch-update-llm-observability-dataset-records @@ -14614,7 +14614,7 @@ menu: - BatchUpdateLLMObsDataset unstable: - v2 - order: 46 + order: 45 - name: Update an LLM Observability dataset url: /api/latest/llm-observability/update-an-llm-observability-dataset/ identifier: llm-observability-update-an-llm-observability-dataset @@ -14679,7 +14679,7 @@ menu: - ListLLMObsPatternsTopicsWithClusteredPoints unstable: - v2 - order: 61 + order: 60 - name: List patterns topics url: /api/latest/llm-observability/list-patterns-topics/ identifier: llm-observability-list-patterns-topics @@ -14692,7 +14692,7 @@ menu: - ListLLMObsPatternsTopics unstable: - v2 - order: 59 + order: 58 - name: Get patterns run status url: /api/latest/llm-observability/get-patterns-run-status/ identifier: llm-observability-get-patterns-run-status @@ -14705,7 +14705,7 @@ menu: - GetLLMObsPatternsRunStatus unstable: - v2 - order: 57 + order: 56 - name: Trigger a patterns run url: /api/latest/llm-observability/trigger-a-patterns-run/ identifier: llm-observability-trigger-a-patterns-run @@ -14718,7 +14718,7 @@ menu: - TriggerLLMObsPatterns unstable: - v2 - order: 56 + order: 55 - name: List patterns runs url: /api/latest/llm-observability/list-patterns-runs/ identifier: llm-observability-list-patterns-runs @@ -14731,7 +14731,7 @@ menu: - ListLLMObsPatternsRuns unstable: - v2 - order: 58 + order: 57 - name: Delete a patterns configuration url: /api/latest/llm-observability/delete-a-patterns-configuration/ identifier: llm-observability-delete-a-patterns-configuration @@ -14744,7 +14744,7 @@ menu: - DeleteLLMObsPatternsConfig unstable: - v2 - order: 55 + order: 54 - name: Get a patterns configuration url: /api/latest/llm-observability/get-a-patterns-configuration/ identifier: llm-observability-get-a-patterns-configuration @@ -14757,7 +14757,7 @@ menu: - GetLLMObsPatternsConfig unstable: - v2 - order: 62 + order: 61 - name: Create or update a patterns configuration url: /api/latest/llm-observability/create-or-update-a-patterns-configuration/ identifier: llm-observability-create-or-update-a-patterns-configuration @@ -14770,7 +14770,7 @@ menu: - UpsertLLMObsPatternsConfig unstable: - v2 - order: 54 + order: 53 - name: List patterns configurations url: /api/latest/llm-observability/list-patterns-configurations/ identifier: llm-observability-list-patterns-configurations @@ -14783,7 +14783,7 @@ menu: - ListLLMObsPatternsConfigs unstable: - v2 - order: 63 + order: 62 - name: List patterns clustered points url: /api/latest/llm-observability/list-patterns-clustered-points/ identifier: llm-observability-list-patterns-clustered-points @@ -14796,7 +14796,7 @@ menu: - ListLLMObsPatternsClusteredPoints unstable: - v2 - order: 60 + order: 59 - name: Search LLM Observability spans url: /api/latest/llm-observability/search-llm-observability-spans/ identifier: llm-observability-search-llm-observability-spans @@ -14835,7 +14835,7 @@ menu: - UpdateLLMObsPromptVersion unstable: - v2 - order: 72 + order: 71 - 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 @@ -14848,7 +14848,7 @@ menu: - GetLLMObsPromptVersion unstable: - v2 - order: 71 + order: 70 - 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 @@ -14861,7 +14861,7 @@ menu: - CreateLLMObsPromptVersion unstable: - v2 - order: 70 + order: 69 - 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 @@ -14874,7 +14874,7 @@ menu: - ListLLMObsPromptVersions unstable: - v2 - order: 69 + order: 68 - name: Update an LLM Observability prompt url: /api/latest/llm-observability/update-an-llm-observability-prompt/ identifier: llm-observability-update-an-llm-observability-prompt @@ -14887,7 +14887,7 @@ menu: - UpdateLLMObsPrompt unstable: - v2 - order: 67 + order: 66 - name: Get an LLM Observability prompt url: /api/latest/llm-observability/get-an-llm-observability-prompt/ identifier: llm-observability-get-an-llm-observability-prompt @@ -14900,7 +14900,7 @@ menu: - GetLLMObsPrompt unstable: - v2 - order: 66 + order: 65 - name: Delete an LLM Observability prompt url: /api/latest/llm-observability/delete-an-llm-observability-prompt/ identifier: llm-observability-delete-an-llm-observability-prompt @@ -14913,7 +14913,7 @@ menu: - DeleteLLMObsPrompt unstable: - v2 - order: 68 + order: 67 - name: Create an LLM Observability prompt url: /api/latest/llm-observability/create-an-llm-observability-prompt/ identifier: llm-observability-create-an-llm-observability-prompt @@ -14926,7 +14926,7 @@ menu: - CreateLLMObsPrompt unstable: - v2 - order: 65 + order: 64 - name: List LLM Observability prompts url: /api/latest/llm-observability/list-llm-observability-prompts/ identifier: llm-observability-list-llm-observability-prompts @@ -14939,7 +14939,7 @@ menu: - ListLLMObsPrompts unstable: - v2 - order: 64 + order: 63 - name: Update an LLM Observability project url: /api/latest/llm-observability/update-an-llm-observability-project/ identifier: llm-observability-update-an-llm-observability-project @@ -15004,7 +15004,7 @@ menu: - ListLLMObsIntegrationModels unstable: - v2 - order: 38 + order: 37 - name: Run an LLM inference url: /api/latest/llm-observability/run-an-llm-inference/ identifier: llm-observability-run-an-llm-inference @@ -15017,7 +15017,7 @@ menu: - CreateLLMObsIntegrationInference unstable: - v2 - order: 39 + order: 38 - name: List LLM integration accounts url: /api/latest/llm-observability/list-llm-integration-accounts/ identifier: llm-observability-list-llm-integration-accounts @@ -15030,7 +15030,7 @@ menu: - ListLLMObsIntegrationAccounts unstable: - v2 - order: 37 + order: 36 - name: Push events for an LLM Observability experiment url: /api/latest/llm-observability/push-events-for-an-llm-observability-experiment/ identifier: llm-observability-push-events-for-an-llm-observability-experiment @@ -15056,7 +15056,7 @@ menu: - ListLLMObsExperimentEventsV1 unstable: - v2 - order: 50 + order: 49 - name: Update an LLM Observability experiment url: /api/latest/llm-observability/update-an-llm-observability-experiment/ identifier: llm-observability-update-an-llm-observability-experiment @@ -15160,7 +15160,7 @@ menu: - UpdateLLMObsAnnotationQueueLabelSchema unstable: - v2 - order: 53 + order: 52 - name: Get annotation queue label schema url: /api/latest/llm-observability/get-annotation-queue-label-schema/ identifier: llm-observability-get-annotation-queue-label-schema @@ -15173,7 +15173,7 @@ menu: - GetLLMObsAnnotationQueueLabelSchema unstable: - v2 - order: 52 + order: 51 - name: Delete annotation queue interactions url: /api/latest/llm-observability/delete-annotation-queue-interactions/ identifier: llm-observability-delete-annotation-queue-interactions @@ -15303,20 +15303,7 @@ menu: - GetLLMObsAnnotatedInteractionsByTraceIDs unstable: - v2 - order: 40 - - name: Delete LLM Observability data - url: /api/latest/llm-observability/delete-llm-observability-data/ - identifier: llm-observability-delete-llm-observability-data - parent: llm-observability - generated: true - params: - versions: - - v2 - operationids: - - DeleteLLMObsData - unstable: - - v2 - order: 36 + order: 39 - name: Create or update a custom evaluator configuration url: /api/latest/llm-observability/create-or-update-a-custom-evaluator-configuration/ identifier: llm-observability-create-or-update-a-custom-evaluator-configuration @@ -15368,7 +15355,7 @@ menu: - ListLLMObsCustomEvalConfigs unstable: - v2 - order: 73 + order: 72 - name: Logs Archives url: /api/latest/logs-archives/ identifier: logs-archives diff --git a/hugo/content/en/api/v2/llm-observability/examples.json b/hugo/content/en/api/v2/llm-observability/examples.json index d68c171c8aa..e3186ce4872 100644 --- a/hugo/content/en/api/v2/llm-observability/examples.json +++ b/hugo/content/en/api/v2/llm-observability/examples.json @@ -636,116 +636,6 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for creating or updating a custom LLM Observability evaluator configuration.

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

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a custom LLM Observability evaluator configuration.

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

category

\n
\n

string

\n

Category of the evaluator.

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

eval_name

\n
\n

string

\n

Name of the custom evaluator. If provided, must match the eval_name path parameter.

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

llm_judge_config

\n
\n

object

\n

LLM judge configuration for a custom evaluator.

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

assessment_criteria

\n
\n

object

\n

Criteria used to assess the pass/fail result of a custom evaluator.

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

max_threshold

\n
\n

double

\n

Maximum numeric threshold for a passing result.

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

min_threshold

\n
\n

double

\n

Minimum numeric threshold for a passing result.

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

pass_values

\n
\n

[string]

\n

Specific output values considered as a passing result.

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

pass_when

\n
\n

boolean

\n

When true, a boolean output of true is treated as passing.

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

context_query

\n
\n

string

\n

Query used to extract additional context for the evaluation.

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

inference_params [required]

\n
\n

object

\n

LLM inference parameters for a custom evaluator.

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

frequency_penalty

\n
\n

double

\n

Frequency penalty to reduce repetition.

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

max_tokens

\n
\n

int64

\n

Maximum number of tokens to generate.

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

presence_penalty

\n
\n

double

\n

Presence penalty to reduce repetition.

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

temperature

\n
\n

double

\n

Sampling temperature for the LLM.

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

top_k

\n
\n

int64

\n

Top-k sampling parameter.

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

top_p

\n
\n

double

\n

Top-p (nucleus) sampling parameter.

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

last_used_library_prompt_template_name

\n
\n

string

\n

Name of the last library prompt template used.

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

modified_library_prompt_template

\n
\n

boolean

\n

Whether the library prompt template was modified.

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

output_schema

\n
\n

object

\n

JSON schema describing the expected output format of the LLM judge.

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

parsing_type

\n
\n

enum

\n

Output parsing type for a custom LLM judge evaluator. \nAllowed enum values: structured_output,json,keyword_search

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

prompt_template

\n
\n

[object]

\n

List of messages forming the LLM judge prompt template.

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

content

\n
\n

string

\n

Text content of the message.

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

contents

\n
\n

[object]

\n

Multi-part content blocks for the message.

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

type [required]

\n
\n

string

\n

Content block type.

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

value [required]

\n
\n

object

\n

Value of a prompt message content block.

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

text

\n
\n

string

\n

Text content of the message block.

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

tool_call

\n
\n

object

\n

A tool call within a prompt message.

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

arguments

\n
\n

string

\n

JSON-encoded arguments for the tool call.

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

id

\n
\n

string

\n

Unique identifier of the tool call.

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

name

\n
\n

string

\n

Name of the tool being called.

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

type

\n
\n

string

\n

Type of the tool call.

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

tool_call_result

\n
\n

object

\n

A tool call result within a prompt message.

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

name

\n
\n

string

\n

Name of the tool that produced this result.

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

result

\n
\n

string

\n

The result returned by the tool.

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

tool_id

\n
\n

string

\n

Identifier of the tool call this result corresponds to.

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

type

\n
\n

string

\n

Type of the tool result.

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

role [required]

\n
\n

string

\n

Role of the message author.

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

target_query

\n
\n

string

\n

Query used to extract the target value to evaluate.

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

user_specified_json_post_processing_function

\n
\n

string

\n

User-provided function applied to post-process the JSON output of the LLM judge.

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

llm_provider

\n
\n

object

\n

LLM provider configuration for a custom evaluator.

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

bedrock

\n
\n

object

\n

AWS Bedrock-specific options for LLM provider configuration.

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

inference_profile

\n
\n

string

\n

Bedrock inference profile identifier, such as an application inference profile ARN.

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

region

\n
\n

string

\n

AWS region for Bedrock.

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

integration_account_id

\n
\n

string

\n

Integration account identifier.

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

integration_provider

\n
\n

enum

\n

Name of the LLM integration provider. \nAllowed enum values: openai,amazon-bedrock,anthropic,azure-openai,vertex-ai,llm-proxy

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

model_name

\n
\n

string

\n

Name of the LLM model.

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

vertex_ai

\n
\n

object

\n

Google Vertex AI-specific options for LLM provider configuration.

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

location

\n
\n

string

\n

Google Cloud region.

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

project

\n
\n

string

\n

Google Cloud project ID.

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

target [required]

\n
\n

object

\n

Target application configuration for a custom evaluator.

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

application_name [required]

\n
\n

string

\n

Name of the ML application this evaluator targets.

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

enabled [required]

\n
\n

boolean

\n

Whether the evaluator is active for the target application.

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

eval_scope

\n
\n

enum

\n

Scope at which to evaluate spans. \nAllowed enum values: span,trace,session

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

experiment_project_ids

\n
\n

[string]

\n

Experiment project IDs this evaluator is scoped to.

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

filter

\n
\n

string

\n

Filter expression to select which spans to evaluate.

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

root_spans_only

\n
\n

boolean

\n

When true, only root spans are evaluated.

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

sampling_percentage

\n
\n

double

\n

Percentage of traces to evaluate. Must be greater than 0 and at most 100.

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

id

\n
\n

string

\n

Name of the evaluator. If provided, must match the eval_name path parameter.

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

type [required]

\n
\n

enum

\n

Type of the custom LLM Observability evaluator configuration resource. \nAllowed enum values: evaluator_config

\n
\n \n
\n
\n
\n
" } }, - "DeleteLLMObsData": { - "responses": { - "202": { - "json": { - "data": { - "attributes": { - "created_at": "2024-01-15T10:30:00Z", - "created_by": "user-uuid-1234", - "from_time": 1705314600000, - "org_id": 12345, - "product": "llmobs", - "query": "@trace_id:abc123def456", - "to_time": 1705315200000 - }, - "id": "msg-abc123", - "type": "deletion_request" - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an LLM Observability data deletion response.

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

attributes [required]

\n
\n

object

\n

Attributes of a submitted LLM Observability data deletion request.

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

created_at [required]

\n
\n

date-time

\n

Timestamp when the deletion request was created.

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

created_by [required]

\n
\n

string

\n

UUID of the user who created the deletion request.

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

from_time [required]

\n
\n

int64

\n

Start of the deletion time range in milliseconds since Unix epoch.

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

org_id [required]

\n
\n

int64

\n

ID of the organization that submitted the deletion request.

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

product [required]

\n
\n

string

\n

Product name for the deletion request.

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

query [required]

\n
\n

string

\n

The query string used to select data for deletion.

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

to_time [required]

\n
\n

int64

\n

End of the deletion time range in milliseconds since Unix epoch.

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

id [required]

\n
\n

string

\n

Unique identifier of the deletion request.

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

type [required]

\n
\n

enum

\n

Resource type for an LLM Observability data deletion response. \nAllowed enum values: deletion_request

\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
" - }, - "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": { - "from": 1705314600000, - "query": {}, - "to": 1705315200000 - }, - "type": "create_deletion_req" - } - }, - "json": { - "data": { - "attributes": { - "delay": 0, - "from": 1705314600000, - "query": { - "": "string" - }, - "to": 1705315200000 - }, - "type": "create_deletion_req" - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an LLM Observability data deletion request.

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

attributes [required]

\n
\n

object

\n

Attributes for an LLM Observability data deletion request.

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

delay

\n
\n

int64

\n

Optional delay in seconds before the deletion is executed.

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

from [required]

\n
\n

int64

\n

Start of the deletion time range in milliseconds since Unix epoch.

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

query [required]

\n
\n

object

\n

Query filters selecting the data to delete. Must include a query key with an @trace_id filter.

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

<any-key>

\n
\n

string

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

to [required]

\n
\n

int64

\n

End of the deletion time range in milliseconds since Unix epoch.

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

type [required]

\n
\n

enum

\n

Resource type for an LLM Observability data deletion request. \nAllowed enum values: create_deletion_req

\n
\n \n
\n
\n
\n
" - } - }, "GetLLMObsAnnotatedInteractionsByTraceIDs": { "responses": { "200": { diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index f7698a2fd21..289262f0f6c 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -56803,139 +56803,6 @@ components: example: "my-gcp-project" type: string type: object - LLMObsDataDeletionRequest: - description: Request to delete LLM Observability data. - properties: - data: - $ref: "#/components/schemas/LLMObsDataDeletionRequestData" - required: - - data - type: object - LLMObsDataDeletionRequestAttributes: - description: Attributes for an LLM Observability data deletion request. - properties: - delay: - description: Optional delay in seconds before the deletion is executed. - example: 0 - format: int64 - type: integer - from: - description: Start of the deletion time range in milliseconds since Unix epoch. - example: 1705314600000 - format: int64 - type: integer - query: - additionalProperties: - type: string - description: Query filters selecting the data to delete. Must include a `query` key with an `@trace_id` filter. - example: - query: "@trace_id:abc123def456" - type: object - to: - description: End of the deletion time range in milliseconds since Unix epoch. - example: 1705315200000 - format: int64 - type: integer - required: - - query - - from - - to - type: object - LLMObsDataDeletionRequestData: - description: Data object for an LLM Observability data deletion request. - properties: - attributes: - $ref: "#/components/schemas/LLMObsDataDeletionRequestAttributes" - type: - $ref: "#/components/schemas/LLMObsDataDeletionRequestType" - required: - - type - - attributes - type: object - LLMObsDataDeletionRequestType: - description: Resource type for an LLM Observability data deletion request. - enum: - - create_deletion_req - example: create_deletion_req - type: string - x-enum-varnames: - - CREATE_DELETION_REQ - LLMObsDataDeletionResponse: - description: Response containing details of a submitted LLM Observability data deletion request. - properties: - data: - $ref: "#/components/schemas/LLMObsDataDeletionResponseData" - required: - - data - type: object - LLMObsDataDeletionResponseAttributes: - description: Attributes of a submitted LLM Observability data deletion request. - properties: - created_at: - description: Timestamp when the deletion request was created. - example: "2024-01-15T10:30:00Z" - format: date-time - type: string - created_by: - description: UUID of the user who created the deletion request. - example: "user-uuid-1234" - type: string - from_time: - description: Start of the deletion time range in milliseconds since Unix epoch. - example: 1705314600000 - format: int64 - type: integer - org_id: - description: ID of the organization that submitted the deletion request. - example: 12345 - format: int64 - type: integer - product: - description: Product name for the deletion request. - example: "llmobs" - type: string - query: - description: The query string used to select data for deletion. - example: "@trace_id:abc123def456" - type: string - to_time: - description: End of the deletion time range in milliseconds since Unix epoch. - example: 1705315200000 - format: int64 - type: integer - required: - - org_id - - product - - created_at - - created_by - - from_time - - to_time - - query - type: object - LLMObsDataDeletionResponseData: - description: Data object for an LLM Observability data deletion response. - properties: - attributes: - $ref: "#/components/schemas/LLMObsDataDeletionResponseAttributes" - id: - description: Unique identifier of the deletion request. - example: "msg-abc123" - type: string - type: - $ref: "#/components/schemas/LLMObsDataDeletionResponseType" - required: - - id - - type - - attributes - type: object - LLMObsDataDeletionResponseType: - description: Resource type for an LLM Observability data deletion response. - enum: - - deletion_request - example: deletion_request - type: string - x-enum-varnames: - - DELETION_REQUEST LLMObsDatasetBatchUpdateDataAttributesRequest: description: Attributes for batch-updating records in an LLM Observability dataset. properties: @@ -121578,7 +121445,7 @@ paths: summary: List custom evaluator configurations tags: - LLM Observability - x-menu-order: 73 + x-menu-order: 72 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/). @@ -160137,78 +160004,6 @@ paths: operator: OR permissions: - org_management - /api/v2/llm-obs/deletion/data/llmobs: - post: - description: Submit a request to delete LLM Observability span data matching a trace ID filter within a specified time range. - operationId: DeleteLLMObsData - requestBody: - content: - application/json: - examples: - default: - value: - data: - attributes: - from: 1705314600000 - query: - query: "@trace_id:abc123def456" - to: 1705315200000 - type: create_deletion_req - schema: - $ref: "#/components/schemas/LLMObsDataDeletionRequest" - description: Data deletion request payload. - required: true - responses: - "202": - content: - application/json: - examples: - default: - value: - data: - attributes: - created_at: "2024-01-15T10:30:00Z" - created_by: "user-uuid-1234" - from_time: 1705314600000 - org_id: 12345 - product: llmobs - query: "@trace_id:abc123def456" - to_time: 1705315200000 - id: msg-abc123 - type: deletion_request - schema: - $ref: "#/components/schemas/LLMObsDataDeletionResponse" - description: Accepted - "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 data - tags: - - LLM Observability - x-menu-order: 36 - 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/annotated-interactions: get: description: |- @@ -160307,7 +160102,7 @@ paths: summary: Get annotated interactions by content IDs tags: - LLM Observability - x-menu-order: 40 + 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/). @@ -161084,7 +160879,7 @@ paths: summary: Get annotation queue label schema tags: - LLM Observability - x-menu-order: 52 + x-menu-order: 51 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/). @@ -161230,7 +161025,7 @@ paths: summary: Update annotation queue label schema tags: - LLM Observability - x-menu-order: 53 + x-menu-order: 52 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/). @@ -161941,7 +161736,7 @@ paths: summary: List LLM Observability experiment spans (v1) tags: - LLM Observability - x-menu-order: 50 + x-menu-order: 49 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/). @@ -162066,7 +161861,7 @@ paths: summary: List LLM integration accounts tags: - LLM Observability - x-menu-order: 37 + x-menu-order: 36 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/). @@ -162151,7 +161946,7 @@ paths: summary: Run an LLM inference tags: - LLM Observability - x-menu-order: 39 + 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/). @@ -162209,7 +162004,7 @@ paths: summary: List LLM integration models tags: - LLM Observability - x-menu-order: 38 + 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/). @@ -162548,7 +162343,7 @@ paths: summary: List LLM Observability prompts tags: - LLM Observability - x-menu-order: 64 + x-menu-order: 63 x-permission: operator: OR permissions: @@ -162636,7 +162431,7 @@ paths: summary: Create an LLM Observability prompt tags: - LLM Observability - x-menu-order: 65 + x-menu-order: 64 x-permission: operator: AND permissions: @@ -162697,7 +162492,7 @@ paths: summary: Delete an LLM Observability prompt tags: - LLM Observability - x-menu-order: 68 + x-menu-order: 67 x-permission: operator: AND permissions: @@ -162763,7 +162558,7 @@ paths: summary: Get an LLM Observability prompt tags: - LLM Observability - x-menu-order: 66 + x-menu-order: 65 x-permission: operator: OR permissions: @@ -162847,7 +162642,7 @@ paths: summary: Update an LLM Observability prompt tags: - LLM Observability - x-menu-order: 67 + x-menu-order: 66 x-permission: operator: AND permissions: @@ -162917,7 +162712,7 @@ paths: summary: List versions of an LLM Observability prompt tags: - LLM Observability - x-menu-order: 69 + x-menu-order: 68 x-permission: operator: OR permissions: @@ -163007,7 +162802,7 @@ paths: summary: Create a new LLM Observability prompt version tags: - LLM Observability - x-menu-order: 70 + x-menu-order: 69 x-permission: operator: AND permissions: @@ -163084,7 +162879,7 @@ paths: summary: Get a specific LLM Observability prompt version tags: - LLM Observability - x-menu-order: 71 + x-menu-order: 70 x-permission: operator: OR permissions: @@ -163171,7 +162966,7 @@ paths: summary: Update a specific LLM Observability prompt version tags: - LLM Observability - x-menu-order: 72 + x-menu-order: 71 x-permission: operator: AND permissions: @@ -163508,7 +163303,7 @@ paths: summary: List patterns clustered points tags: - LLM Observability - x-menu-order: 60 + x-menu-order: 59 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/). @@ -163572,7 +163367,7 @@ paths: summary: List patterns configurations tags: - LLM Observability - x-menu-order: 63 + x-menu-order: 62 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/). @@ -163657,7 +163452,7 @@ paths: summary: Create or update a patterns configuration tags: - LLM Observability - x-menu-order: 54 + x-menu-order: 53 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/). @@ -163725,7 +163520,7 @@ paths: summary: Get a patterns configuration tags: - LLM Observability - x-menu-order: 62 + x-menu-order: 61 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/). @@ -163776,7 +163571,7 @@ paths: summary: Delete a patterns configuration tags: - LLM Observability - x-menu-order: 55 + x-menu-order: 54 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/). @@ -163843,7 +163638,7 @@ paths: summary: List patterns runs tags: - LLM Observability - x-menu-order: 58 + x-menu-order: 57 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/). @@ -163919,7 +163714,7 @@ paths: summary: Trigger a patterns run tags: - LLM Observability - x-menu-order: 56 + x-menu-order: 55 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/). @@ -163993,7 +163788,7 @@ paths: summary: Get patterns run status tags: - LLM Observability - x-menu-order: 57 + x-menu-order: 56 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/). @@ -164074,7 +163869,7 @@ paths: summary: List patterns topics tags: - LLM Observability - x-menu-order: 59 + x-menu-order: 58 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/). @@ -164167,7 +163962,7 @@ paths: summary: List patterns topics with clustered points tags: - LLM Observability - x-menu-order: 61 + x-menu-order: 60 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/). @@ -164595,7 +164390,7 @@ paths: summary: Batch update LLM Observability dataset records tags: - LLM Observability - x-menu-order: 46 + x-menu-order: 45 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/). @@ -164692,7 +164487,7 @@ paths: summary: Clone an LLM Observability dataset tags: - LLM Observability - x-menu-order: 47 + x-menu-order: 46 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/). @@ -164773,7 +164568,7 @@ paths: summary: Get LLM Observability dataset draft state tags: - LLM Observability - x-menu-order: 41 + x-menu-order: 40 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/). @@ -164854,7 +164649,7 @@ paths: summary: Lock LLM Observability dataset draft state tags: - LLM Observability - x-menu-order: 42 + x-menu-order: 41 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/). @@ -164918,7 +164713,7 @@ paths: summary: Unlock LLM Observability dataset draft state tags: - LLM Observability - x-menu-order: 43 + x-menu-order: 42 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/). @@ -165001,7 +164796,7 @@ paths: summary: Export an LLM Observability dataset tags: - LLM Observability - x-menu-order: 45 + x-menu-order: 44 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/). @@ -165394,7 +165189,7 @@ paths: summary: Restore an LLM Observability dataset version tags: - LLM Observability - x-menu-order: 48 + x-menu-order: 47 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/). @@ -165478,7 +165273,7 @@ paths: summary: List LLM Observability dataset versions tags: - LLM Observability - x-menu-order: 44 + x-menu-order: 43 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/). @@ -165553,7 +165348,7 @@ paths: summary: List LLM Observability experiment events (v2) tags: - LLM Observability - x-menu-order: 51 + x-menu-order: 50 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/). @@ -165659,7 +165454,7 @@ paths: summary: Upload records to an LLM Observability dataset tags: - LLM Observability - x-menu-order: 49 + x-menu-order: 48 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/). diff --git a/hugo/data/api/v2/translate_actions.json b/hugo/data/api/v2/translate_actions.json index eb9bbbe4438..998195e1519 100644 --- a/hugo/data/api/v2/translate_actions.json +++ b/hugo/data/api/v2/translate_actions.json @@ -3227,12 +3227,6 @@ "request_description": "", "request_schema_description": "Update the IP allowlist." }, - "DeleteLLMObsData": { - "description": "Submit a request to delete LLM Observability span data matching a trace ID filter within a specified time range.", - "summary": "Delete LLM Observability data", - "request_description": "Data deletion request payload.", - "request_schema_description": "Request to delete LLM Observability data." - }, "GetLLMObsAnnotatedInteractionsByTraceIDs": { "description": "Returns annotated interactions across all annotation queues for the given content IDs.\nResults include queue metadata (ID and name) for each interaction.", "summary": "Get annotated interactions by content IDs"