Optional requestFactory: LLMObservabilityApiRequestFactoryOptional responseProcessor: LLMObservabilityApiResponseProcessorPrivate configurationPrivate requestPrivate responseThe request object
Optional options: ConfigurationInsert, update, and delete records in a single dataset operation. By default, a new dataset version is created when the batch is applied.
The request object
Optional options: ConfigurationClone a dataset, copying its current records into a new dataset within the same project.
The request object
Optional options: ConfigurationCreate an annotation queue. The name and project_id fields are required.
An optional annotation_schema can be provided to define the labels for the queue.
Fields such as created_by, owned_by, created_at, modified_by,
and modified_at are inferred by the backend.
The request object
Optional options: ConfigurationAdd one or more interactions to an annotation queue. At least one
interaction must be provided. Each interaction has a type:
trace, experiment_trace, session: content_id references the
upstream entity; the server fetches the actual content.display_block: omit content_id and provide the rendered content
in display_block. The server generates content_id as a
deterministic hash of the block list.Items of different types can be mixed in a single request.
The request object
Optional options: ConfigurationCreate a new LLM Observability dataset within the specified project.
The request object
Optional options: ConfigurationAppend one or more records to an LLM Observability dataset.
The request object
Optional options: ConfigurationCreate a new LLM Observability experiment.
The request object
Optional options: ConfigurationPush spans and metrics for an LLM Observability experiment.
The request object
Optional options: ConfigurationRun an LLM inference request through the specified integration and account, returning the model response and token usage.
The request object
Optional options: ConfigurationCreate a new LLM Observability project. Returns the existing project if a name conflict occurs.
The request object
Optional options: ConfigurationDelete an annotation queue by its ID.
The request object
Optional options: ConfigurationDelete one or more interactions from an annotation queue.
The request object
Optional options: ConfigurationDelete a custom LLM Observability evaluator configuration by its name.
The request object
Optional options: ConfigurationSubmit a request to delete LLM Observability span data matching a trace ID filter within a specified time range.
The request object
Optional options: ConfigurationDelete one or more records from an LLM Observability dataset.
The request object
Optional options: ConfigurationDelete one or more LLM Observability datasets within the specified project.
The request object
Optional options: ConfigurationDelete one or more LLM Observability experiments.
The request object
Optional options: ConfigurationDelete one or more LLM Observability projects.
The request object
Optional options: ConfigurationDownload the contents of a dataset as a CSV file. The download is streamed and includes one row per dataset record.
The request object
Optional options: ConfigurationRetrieve all interactions (traces and sessions) and their annotations for a given annotation queue.
The request object
Optional options: ConfigurationReturns annotated interactions across all annotation queues for the given content IDs. Results include queue metadata (ID and name) for each interaction.
The request object
Optional options: ConfigurationRetrieve the label schema for a given annotation queue.
The request object
Optional options: ConfigurationRetrieve a custom LLM Observability evaluator configuration by its name.
The request object
Optional options: ConfigurationRetrieve the draft state of a dataset, including whether it is currently locked for editing and which user holds the lock.
The request object
Optional options: ConfigurationList annotation queues. Optionally filter by project ID or queue IDs. These parameters are mutually exclusive. If neither is provided, all queues in the organization are returned.
The request object
Optional options: ConfigurationList all records in an LLM Observability dataset, sorted by creation date, newest first.
The request object
Optional options: ConfigurationList the active versions of a dataset. A version is created each time a dataset is referenced by an experiment run.
The request object
Optional options: ConfigurationList all LLM Observability datasets for a project, sorted by creation date, newest first.
The request object
Optional options: ConfigurationRetrieve spans and experiment-level summary metrics for a given experiment with cursor-based pagination.
The request object
Optional options: ConfigurationList all LLM Observability experiments sorted by creation date, newest first.
The request object
Optional options: ConfigurationRetrieve the list of configured accounts for the specified LLM provider integration.
The request object
Optional options: ConfigurationRetrieve the list of models available for the specified LLM provider integration and account.
The request object
Optional options: ConfigurationList all LLM Observability projects sorted by creation date, newest first.
The request object
Optional options: ConfigurationList LLM Observability spans matching the specified filters.
The request object
Optional options: ConfigurationAcquire the draft lock on a dataset for the calling user. The lock prevents other users from concurrently editing the dataset draft.
The request object
Optional options: ConfigurationRestore a dataset to a previous version. The dataset's current version is bumped, and its records are replaced with the records from the specified prior version.
The request object
Optional options: ConfigurationSearch across LLM Observability experimentation entities — projects, datasets, dataset records, experiments, and experiment runs — using cursor-based pagination.
The filter.scope field controls which entity types are returned. At least one valid scope must be provided.
Returns 200 OK when all results fit in a single page. Returns 206 Partial Content with a cursor in meta.after when additional pages are available.
The request object
Optional options: ConfigurationSearch LLM Observability spans using structured filters in the request body.
The request object
Optional options: ConfigurationSearch across LLM Observability experimentation entities using offset-based (page-number) pagination. Use this endpoint when you need total page count or want to navigate to a specific page number.
The filter.scope field controls which entity types are returned. At least one valid scope must be provided.
The request object
Optional options: ConfigurationRelease the draft lock on a dataset held by the calling user, allowing other users to edit the dataset draft.
The request object
Optional options: ConfigurationPartially update an annotation queue. The name, description, and annotation_schema fields can be updated.
The request object
Optional options: ConfigurationCreate or replace the label schema for a given annotation queue.
The label schema defines the labels annotators can apply to interactions in the queue.
Label names must be unique within the queue and match the pattern ^[a-zA-Z0-9_-]+$.
Each label must have a valid type: score, categorical, boolean, or text.
The request object
Optional options: ConfigurationCreate or update a custom LLM Observability evaluator configuration by its name.
The request object
Optional options: ConfigurationPartially update an existing LLM Observability dataset within the specified project.
The request object
Optional options: ConfigurationUpdate one or more existing records in an LLM Observability dataset.
The request object
Optional options: ConfigurationPartially update an existing LLM Observability experiment.
The request object
Optional options: ConfigurationPartially update an existing LLM Observability project.
The request object
Optional options: ConfigurationUpload records to a dataset from a file. The request is a multipart/form-data upload containing a single file part.
Currently only CSV is supported. The CSV must include an input column. Optional columns are id, expected_output, metadata, and tags.
The response is a Server-Sent Events stream (text/event-stream) emitting progress updates while records are processed. The stream emits the following named events:
progress: incremental record counts written so far.completed: terminal event with a JSON body containing records_created.error: terminal event with a JSON body containing an error message.The request object
Optional options: ConfigurationGenerated using TypeDoc
Execute an analytics aggregation over LLM Observability experimentation data. Use this endpoint to compute metrics (for example average eval scores) grouped by fields such as
span_idorexperiment_id.At least one
computedefinition and oneindexmust be provided.