diff --git a/content/en/api/v2/llm-observability/examples.json b/content/en/api/v2/llm-observability/examples.json index 88c14e4d073..5694cf1f8ef 100644 --- a/content/en/api/v2/llm-observability/examples.json +++ b/content/en/api/v2/llm-observability/examples.json @@ -1025,7 +1025,7 @@ "type": "annotated_interactions" } }, - "html": "
data [required]
\nobject
Data object for annotated interactions.
attributes [required]
\nobject
Attributes containing the list of annotated interactions.
annotated_interactions [required]
\n[object]
List of interactions with their annotations.
annotations [required]
\n[object]
List of annotations for this interaction.
created_at [required]
\ndate-time
Timestamp when the annotation was created.
created_by [required]
\nstring
Identifier of the user who created the annotation.
id [required]
\nstring
Unique identifier of the annotation.
interaction_id [required]
\nstring
Identifier of the interaction this annotation belongs to.
label_values [required]
\nobject
The label values for this annotation.
modified_at [required]
\ndate-time
Timestamp when the annotation was last modified.
modified_by [required]
\nstring
Identifier of the user who last modified the annotation.
content_id [required]
\nstring
Identifier of the content (trace ID or session ID) for this interaction.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type of interaction in an annotation queue. \nAllowed enum values: trace,experiment_trace,session
id [required]
\nstring
The queue ID.
type [required]
\nenum
Resource type for annotated interactions. \nAllowed enum values: annotated_interactions
data [required]
\nobject
Data object for annotated interactions.
attributes [required]
\nobject
Attributes containing the list of annotated interactions.
annotated_interactions [required]
\n[ <oneOf>]
List of interactions with their annotations.
Option 1
\nobject
A trace, experiment trace, or session interaction with its associated annotations.
annotations [required]
\n[object]
List of annotations for this interaction.
created_at [required]
\ndate-time
Timestamp when the annotation was created.
created_by [required]
\nstring
Identifier of the user who created the annotation.
id [required]
\nstring
Unique identifier of the annotation.
interaction_id [required]
\nstring
Identifier of the interaction this annotation belongs to.
label_values [required]
\nobject
The label values for this annotation.
modified_at [required]
\ndate-time
Timestamp when the annotation was last modified.
modified_by [required]
\nstring
Identifier of the user who last modified the annotation.
content_id [required]
\nstring
Upstream entity identifier supplied by the caller.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type of an upstream-entity interaction. \nAllowed enum values: trace,experiment_trace,session
Option 2
\nobject
A display_block interaction with its associated annotations.
annotations [required]
\n[object]
List of annotations for this interaction.
created_at [required]
\ndate-time
Timestamp when the annotation was created.
created_by [required]
\nstring
Identifier of the user who created the annotation.
id [required]
\nstring
Unique identifier of the annotation.
interaction_id [required]
\nstring
Identifier of the interaction this annotation belongs to.
label_values [required]
\nobject
The label values for this annotation.
modified_at [required]
\ndate-time
Timestamp when the annotation was last modified.
modified_by [required]
\nstring
Identifier of the user who last modified the annotation.
content_id [required]
\nstring
Server-generated deterministic identifier derived from the block list.
display_block [required]
\n[object]
List of content blocks that make up a display_block interaction.\nMust contain at least one block.
alt
\nstring
Alternative text for an image block.
content
\nBlock payload. A string for markdown, header, and text; an\narbitrary JSON value (object, array, or scalar) for json. Omitted\nfor image, widget, and llmobs_trace.
height
\nint64
Optional rendered height. Must be positive when set.
interactionType
\nenum
Upstream interaction type referenced by an llmobs_trace block.\nRestricted to trace or experiment_trace. \nAllowed enum values: trace,experiment_trace
label
\nstring
Optional label rendered alongside the block.
level
\nenum
Visual size for a header block. \nAllowed enum values: sm,md,lg,xl
tileDef
\nTile definition for a widget block. Required for widget. The\nschema is owned by the frontend renderer.
timeFrame
\nobject
Unix-millis time range used by chart blocks.
end [required]
\nint64
End of the range, in Unix milliseconds.
start [required]
\nint64
Start of the range, in Unix milliseconds.
traceId
\nstring
Trace identifier. Required for llmobs_trace blocks.
type [required]
\nenum
Discriminator for a single display_block content block. Adding a\nvariant requires coordinated changes in the frontend renderer. \nAllowed enum values: markdown,header,text,json,image,widget,llmobs_trace
url
\nstring
URL of the image. Required for image blocks.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type discriminator for a display_block interaction. \nAllowed enum values: display_block
id [required]
\nstring
The queue ID.
type [required]
\nenum
Resource type for annotated interactions. \nAllowed enum values: annotated_interactions
data [required]
\nobject
Data object for the interaction addition response.
attributes [required]
\nobject
Attributes of the interaction addition response.
interactions [required]
\n[object]
List of interactions that were processed.
already_existed [required]
\nboolean
Whether this interaction already existed in the queue.
content_id [required]
\nstring
Identifier of the content (trace ID or session ID) for this interaction.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type of interaction in an annotation queue. \nAllowed enum values: trace,experiment_trace,session
id [required]
\nstring
The queue ID the interactions were added to.
type [required]
\nenum
Resource type for annotation queue interactions. \nAllowed enum values: interactions
data [required]
\nobject
Data object for the interaction addition response.
attributes [required]
\nobject
Attributes of the interaction addition response.
interactions [required]
\n[ <oneOf>]
List of interactions that were processed.
Option 1
\nobject
A trace, experiment trace, or session interaction result.
already_existed [required]
\nboolean
Whether this interaction already existed in the queue.
content_id [required]
\nstring
Upstream entity identifier supplied by the caller.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type of an upstream-entity interaction. \nAllowed enum values: trace,experiment_trace,session
Option 2
\nobject
A display_block interaction result.
already_existed [required]
\nboolean
Whether this interaction already existed in the queue.
content_id [required]
\nstring
Server-generated deterministic identifier derived from the block list.
display_block [required]
\n[object]
List of content blocks that make up a display_block interaction.\nMust contain at least one block.
alt
\nstring
Alternative text for an image block.
content
\nBlock payload. A string for markdown, header, and text; an\narbitrary JSON value (object, array, or scalar) for json. Omitted\nfor image, widget, and llmobs_trace.
height
\nint64
Optional rendered height. Must be positive when set.
interactionType
\nenum
Upstream interaction type referenced by an llmobs_trace block.\nRestricted to trace or experiment_trace. \nAllowed enum values: trace,experiment_trace
label
\nstring
Optional label rendered alongside the block.
level
\nenum
Visual size for a header block. \nAllowed enum values: sm,md,lg,xl
tileDef
\nTile definition for a widget block. Required for widget. The\nschema is owned by the frontend renderer.
timeFrame
\nobject
Unix-millis time range used by chart blocks.
end [required]
\nint64
End of the range, in Unix milliseconds.
start [required]
\nint64
Start of the range, in Unix milliseconds.
traceId
\nstring
Trace identifier. Required for llmobs_trace blocks.
type [required]
\nenum
Discriminator for a single display_block content block. Adding a\nvariant requires coordinated changes in the frontend renderer. \nAllowed enum values: markdown,header,text,json,image,widget,llmobs_trace
url
\nstring
URL of the image. Required for image blocks.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type discriminator for a display_block interaction. \nAllowed enum values: display_block
id [required]
\nstring
The queue ID the interactions were added to.
type [required]
\nenum
Resource type for annotation queue interactions. \nAllowed enum values: interactions
data [required]
\nobject
Data object for adding interactions to an annotation queue.
attributes [required]
\nobject
Attributes for adding interactions to an annotation queue.
interactions [required]
\n[object]
List of interactions to add to the queue. Must contain at least one item.
content_id [required]
\nstring
Identifier of the content (trace ID or session ID) for this interaction.
type [required]
\nenum
Type of interaction in an annotation queue. \nAllowed enum values: trace,experiment_trace,session
type [required]
\nenum
Resource type for annotation queue interactions. \nAllowed enum values: interactions
data [required]
\nobject
Data object for adding interactions to an annotation queue.
attributes [required]
\nobject
Attributes for adding interactions to an annotation queue.
interactions [required]
\n[ <oneOf>]
List of interactions to add to the queue. Must contain at least one item.
Option 1
\nobject
An interaction that references an upstream trace, experiment trace, or session.
content_id [required]
\nstring
Upstream entity identifier (trace, experiment trace, or session ID).
type [required]
\nenum
Type of an upstream-entity interaction. \nAllowed enum values: trace,experiment_trace,session
Option 2
\nobject
An interaction whose rendered content is supplied directly as a list\nof display blocks. The server generates content_id deterministically\nfrom the block list.
display_block [required]
\n[object]
List of content blocks that make up a display_block interaction.\nMust contain at least one block.
alt
\nstring
Alternative text for an image block.
content
\nBlock payload. A string for markdown, header, and text; an\narbitrary JSON value (object, array, or scalar) for json. Omitted\nfor image, widget, and llmobs_trace.
height
\nint64
Optional rendered height. Must be positive when set.
interactionType
\nenum
Upstream interaction type referenced by an llmobs_trace block.\nRestricted to trace or experiment_trace. \nAllowed enum values: trace,experiment_trace
label
\nstring
Optional label rendered alongside the block.
level
\nenum
Visual size for a header block. \nAllowed enum values: sm,md,lg,xl
tileDef
\nTile definition for a widget block. Required for widget. The\nschema is owned by the frontend renderer.
timeFrame
\nobject
Unix-millis time range used by chart blocks.
end [required]
\nint64
End of the range, in Unix milliseconds.
start [required]
\nint64
Start of the range, in Unix milliseconds.
traceId
\nstring
Trace identifier. Required for llmobs_trace blocks.
type [required]
\nenum
Discriminator for a single display_block content block. Adding a\nvariant requires coordinated changes in the frontend renderer. \nAllowed enum values: markdown,header,text,json,image,widget,llmobs_trace
url
\nstring
URL of the image. Required for image blocks.
type [required]
\nenum
Type discriminator for a display_block interaction. \nAllowed enum values: display_block
type [required]
\nenum
Resource type for annotation queue interactions. \nAllowed enum values: interactions