@arizeai/phoenix-client
Version:
A client for the Phoenix API
1,552 lines • 189 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/v1/annotation_configs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List annotation configurations
* @description Retrieve a paginated list of all annotation configurations in the system.
*/
get: operations["list_annotation_configs_v1_annotation_configs_get"];
put?: never;
/** Create an annotation configuration */
post: operations["create_annotation_config_v1_annotation_configs_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/annotation_configs/{config_identifier}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get an annotation configuration by ID or name */
get: operations["get_annotation_config_by_name_or_id_v1_annotation_configs__config_identifier__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/annotation_configs/{config_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Update an annotation configuration */
put: operations["update_annotation_config_v1_annotation_configs__config_id__put"];
post?: never;
/** Delete an annotation configuration */
delete: operations["delete_annotation_config_v1_annotation_configs__config_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/projects/{project_identifier}/span_annotations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get span annotations for a list of span_ids. */
get: operations["listSpanAnnotationsBySpanIds"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/projects/{project_identifier}/trace_annotations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get trace annotations for a list of trace_ids. */
get: operations["listTraceAnnotationsByTraceIds"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/projects/{project_identifier}/session_annotations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get session annotations for a list of session_ids. */
get: operations["listSessionAnnotationsBySessionIds"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List datasets */
get: operations["listDatasets"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get dataset by ID */
get: operations["getDataset"];
put?: never;
post?: never;
/** Delete dataset by ID */
delete: operations["deleteDatasetById"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets/{id}/versions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List dataset versions */
get: operations["listDatasetVersionsByDatasetId"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets/upload": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Upload dataset from JSON, CSV, or PyArrow */
post: operations["uploadDataset"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets/{id}/examples": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get examples from a dataset */
get: operations["getDatasetExamples"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets/{id}/csv": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Download dataset examples as CSV file */
get: operations["getDatasetCsv"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets/{id}/jsonl/openai_ft": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Download dataset examples as OpenAI fine-tuning JSONL file */
get: operations["getDatasetJSONLOpenAIFineTuning"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets/{id}/jsonl/openai_evals": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Download dataset examples as OpenAI evals JSONL file */
get: operations["getDatasetJSONLOpenAIEvals"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/datasets/{dataset_id}/experiments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List experiments by dataset
* @description Retrieve a paginated list of experiments for the specified dataset.
*/
get: operations["listExperiments"];
put?: never;
/** Create experiment on a dataset */
post: operations["createExperiment"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/experiments/{experiment_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get experiment by ID */
get: operations["getExperiment"];
put?: never;
post?: never;
/** Delete experiment by ID */
delete: operations["deleteExperiment"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/experiments/{experiment_id}/incomplete-runs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get incomplete runs for an experiment
* @description Get runs that need to be completed for this experiment.
*
* Returns all incomplete runs, including both missing runs (not yet attempted)
* and failed runs (attempted but have errors).
*
* Args:
* experiment_id: The ID of the experiment
* cursor: Cursor for pagination
* limit: Maximum number of results to return
*
* Returns:
* Paginated list of incomplete runs grouped by dataset example,
* with repetition numbers that need to be run
*/
get: operations["getIncompleteExperimentRuns"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/experiments/{experiment_id}/json": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Download experiment runs as a JSON file */
get: operations["getExperimentJSON"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/experiments/{experiment_id}/csv": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Download experiment runs as a CSV file */
get: operations["getExperimentCSV"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/experiments/{experiment_id}/runs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List runs for an experiment
* @description Retrieve a paginated list of runs for an experiment
*/
get: operations["listExperimentRuns"];
put?: never;
/** Create run for an experiment */
post: operations["createExperimentRun"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/experiments/{experiment_id}/incomplete-evaluations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get incomplete evaluations for an experiment
* @description Get experiment runs that have incomplete evaluations.
*
* Returns runs with:
* - Missing evaluations (evaluator has not been run)
* - Failed evaluations (evaluator ran but has errors)
*
* Args:
* experiment_id: The ID of the experiment
* evaluation_name: List of evaluation names to check (required, at least one)
* cursor: Cursor for pagination
* limit: Maximum number of results to return
*
* Returns:
* Paginated list of runs with incomplete evaluations
*/
get: operations["getIncompleteExperimentEvaluations"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/experiment_evaluations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create or update evaluation for an experiment run */
post: operations["upsertExperimentEvaluation"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/trace_annotations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create trace annotations */
post: operations["annotateTraces"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/traces/{trace_identifier}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete a trace by identifier
* @description Delete an entire trace by its identifier. The identifier can be either:
* 1. A Relay node ID (base64-encoded)
* 2. An OpenTelemetry trace_id (hex string)
*
* This will permanently remove all spans in the trace and their associated data.
*/
delete: operations["deleteTrace"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/projects/{project_identifier}/spans/otlpv1": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Search spans with simple filters (no DSL)
* @description Return spans within a project filtered by time range. Supports cursor-based pagination.
*/
get: operations["spanSearch"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/projects/{project_identifier}/spans": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List spans with simple filters (no DSL)
* @description Return spans within a project filtered by time range. Supports cursor-based pagination.
*/
get: operations["getSpans"];
put?: never;
/**
* Create spans
* @description Submit spans to be inserted into a project. If any spans are invalid or duplicates, no spans will be inserted.
*/
post: operations["createSpans"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/span_annotations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create span annotations */
post: operations["annotateSpans"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/spans/{span_identifier}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete a span by span_identifier
* @description Delete a single span by identifier.
*
* **Important**: This operation deletes ONLY the specified span itself and does NOT
* delete its descendants/children. All child spans will remain in the trace and
* become orphaned (their parent_id will point to a non-existent span).
*
* Behavior:
* - Deletes only the target span (preserves all descendant spans)
* - If this was the last span in the trace, the trace record is also deleted
* - If the deleted span had a parent, its cumulative metrics (error count, token counts)
* are subtracted from all ancestor spans in the chain
*
* **Note**: This operation is irreversible and may create orphaned spans.
*/
delete: operations["deleteSpan"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/evaluations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get span, trace, or document evaluations from a project */
get: operations["getEvaluations"];
put?: never;
/** Add span, trace, or document evaluations */
post: operations["addEvaluations"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/prompts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List all prompts
* @description Retrieve a paginated list of all prompts in the system. A prompt can have multiple versions.
*/
get: operations["getPrompts"];
put?: never;
/**
* Create a new prompt
* @description Create a new prompt and its initial version. A prompt can have multiple versions.
*/
post: operations["postPromptVersion"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/prompts/{prompt_identifier}/versions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List prompt versions
* @description Retrieve all versions of a specific prompt with pagination support. Each prompt can have multiple versions with different configurations.
*/
get: operations["listPromptVersions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/prompt_versions/{prompt_version_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get prompt version by ID
* @description Retrieve a specific prompt version using its unique identifier. A prompt version contains the actual template and configuration.
*/
get: operations["getPromptVersionByPromptVersionId"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/prompts/{prompt_identifier}/tags/{tag_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get prompt version by tag
* @description Retrieve a specific prompt version using its tag name. Tags are used to identify specific versions of a prompt.
*/
get: operations["getPromptVersionByTagName"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/prompts/{prompt_identifier}/latest": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get latest prompt version
* @description Retrieve the most recent version of a specific prompt.
*/
get: operations["getPromptVersionLatest"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/prompt_versions/{prompt_version_id}/tags": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List prompt version tags
* @description Retrieve all tags associated with a specific prompt version. Tags are used to identify and categorize different versions of a prompt.
*/
get: operations["getPromptVersionTags"];
put?: never;
/**
* Add tag to prompt version
* @description Add a new tag to a specific prompt version. Tags help identify and categorize different versions of a prompt.
*/
post: operations["createPromptVersionTag"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/projects": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List all projects
* @description Retrieve a paginated list of all projects in the system.
*/
get: operations["getProjects"];
put?: never;
/**
* Create a new project
* @description Create a new project with the specified configuration.
*/
post: operations["createProject"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/projects/{project_identifier}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get project by ID or name
* @description Retrieve a specific project using its unique identifier: either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
*/
get: operations["getProject"];
/**
* Update a project by ID or name
* @description Update an existing project with new configuration. Project names cannot be changed. The project identifier is either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
*/
put: operations["updateProject"];
post?: never;
/**
* Delete a project by ID or name
* @description Delete an existing project and all its associated data. The project identifier is either project ID or project name. The default project cannot be deleted. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.
*/
delete: operations["deleteProject"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/session_annotations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create session annotations */
post: operations["annotateSessions"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/document_annotations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Annotate Span Documents */
post: operations["annotateSpanDocuments"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List all users
* @description Retrieve a paginated list of all users in the system.
*/
get: operations["getUsers"];
put?: never;
/**
* Create a new user
* @description Create a new user with the specified configuration.
*/
post: operations["createUser"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/users/{user_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete a user by ID
* @description Delete an existing user by their unique GlobalID.
*/
delete: operations["deleteUser"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
/** AnnotateSessionsRequestBody */
AnnotateSessionsRequestBody: {
/** Data */
data: components["schemas"]["SessionAnnotationData"][];
};
/** AnnotateSessionsResponseBody */
AnnotateSessionsResponseBody: {
/** Data */
data: components["schemas"]["InsertedSessionAnnotation"][];
};
/** AnnotateSpanDocumentsRequestBody */
AnnotateSpanDocumentsRequestBody: {
/** Data */
data: components["schemas"]["SpanDocumentAnnotationData"][];
};
/** AnnotateSpanDocumentsResponseBody */
AnnotateSpanDocumentsResponseBody: {
/** Data */
data: components["schemas"]["InsertedSpanDocumentAnnotation"][];
};
/** AnnotateSpansRequestBody */
AnnotateSpansRequestBody: {
/** Data */
data: components["schemas"]["SpanAnnotationData"][];
};
/** AnnotateSpansResponseBody */
AnnotateSpansResponseBody: {
/** Data */
data: components["schemas"]["InsertedSpanAnnotation"][];
};
/** AnnotateTracesRequestBody */
AnnotateTracesRequestBody: {
/**
* Data
* @description The trace annotations to be upserted
*/
data: components["schemas"]["TraceAnnotationData"][];
};
/** AnnotateTracesResponseBody */
AnnotateTracesResponseBody: {
/** Data */
data: components["schemas"]["InsertedTraceAnnotation"][];
};
/** AnnotationResult */
AnnotationResult: {
/**
* Label
* @description The label assigned by the annotation
*/
label?: string | null;
/**
* Score
* @description The score assigned by the annotation
*/
score?: number | null;
/**
* Explanation
* @description Explanation of the annotation result
*/
explanation?: string | null;
};
/** CategoricalAnnotationConfig */
CategoricalAnnotationConfig: {
/** Name */
name: string;
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
type: "CATEGORICAL";
/** Description */
description?: string | null;
optimization_direction: components["schemas"]["OptimizationDirection"];
/** Values */
values: components["schemas"]["CategoricalAnnotationValue"][];
/** Id */
id: string;
};
/** CategoricalAnnotationConfigData */
CategoricalAnnotationConfigData: {
/** Name */
name: string;
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
type: "CATEGORICAL";
/** Description */
description?: string | null;
optimization_direction: components["schemas"]["OptimizationDirection"];
/** Values */
values: components["schemas"]["CategoricalAnnotationValue"][];
};
/** CategoricalAnnotationValue */
CategoricalAnnotationValue: {
/** Label */
label: string;
/** Score */
score?: number | null;
};
/** ContinuousAnnotationConfig */
ContinuousAnnotationConfig: {
/** Name */
name: string;
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
type: "CONTINUOUS";
/** Description */
description?: string | null;
optimization_direction: components["schemas"]["OptimizationDirection"];
/** Lower Bound */
lower_bound?: number | null;
/** Upper Bound */
upper_bound?: number | null;
/** Id */
id: string;
};
/** ContinuousAnnotationConfigData */
ContinuousAnnotationConfigData: {
/** Name */
name: string;
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
type: "CONTINUOUS";
/** Description */
description?: string | null;
optimization_direction: components["schemas"]["OptimizationDirection"];
/** Lower Bound */
lower_bound?: number | null;
/** Upper Bound */
upper_bound?: number | null;
};
/** CreateAnnotationConfigData */
CreateAnnotationConfigData: components["schemas"]["CategoricalAnnotationConfigData"] | components["schemas"]["ContinuousAnnotationConfigData"] | components["schemas"]["FreeformAnnotationConfigData"];
/** CreateAnnotationConfigResponseBody */
CreateAnnotationConfigResponseBody: {
/** Data */
data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
};
/**
* CreateExperimentRequestBody
* @description Details of the experiment to be created
*/
CreateExperimentRequestBody: {
/**
* Name
* @description Name of the experiment (if omitted, a random name will be generated)
*/
name?: string | null;
/**
* Description
* @description An optional description of the experiment
*/
description?: string | null;
/**
* Metadata
* @description Metadata for the experiment
*/
metadata?: {
[key: string]: unknown;
} | null;
/**
* Version Id
* @description ID of the dataset version over which the experiment will be run (if omitted, the latest version will be used)
*/
version_id?: string | null;
/**
* Splits
* @description List of dataset split identifiers (GlobalIDs or names) to filter by
*/
splits?: string[] | null;
/**
* Repetitions
* @description Number of times the experiment should be repeated for each example
* @default 1
*/
repetitions?: number;
};
/** CreateExperimentResponseBody */
CreateExperimentResponseBody: {
data: components["schemas"]["Experiment"];
};
/** CreateExperimentRunRequestBody */
CreateExperimentRunRequestBody: {
/**
* Dataset Example Id
* @description The ID of the dataset example used in the experiment run
*/
dataset_example_id: string;
/**
* Output
* @description The output of the experiment task
*/
output: unknown;
/**
* Repetition Number
* @description The repetition number of the experiment run
*/
repetition_number: number;
/**
* Start Time
* Format: date-time
* @description The start time of the experiment run
*/
start_time: string;
/**
* End Time
* Format: date-time
* @description The end time of the experiment run
*/
end_time: string;
/**
* Trace Id
* @description The ID of the corresponding trace (if one exists)
*/
trace_id?: string | null;
/**
* Error
* @description Optional error message if the experiment run encountered an error
*/
error?: string | null;
};
/** CreateExperimentRunResponseBody */
CreateExperimentRunResponseBody: {
data: components["schemas"]["CreateExperimentRunResponseBodyData"];
};
/** CreateExperimentRunResponseBodyData */
CreateExperimentRunResponseBodyData: {
/**
* Id
* @description The ID of the newly created experiment run
*/
id: string;
};
/** CreateProjectRequestBody */
CreateProjectRequestBody: {
/** Name */
name: string;
/** Description */
description?: string | null;
};
/** CreateProjectResponseBody */
CreateProjectResponseBody: {
data: components["schemas"]["Project"];
};
/** CreatePromptRequestBody */
CreatePromptRequestBody: {
prompt: components["schemas"]["PromptData"];
version: components["schemas"]["PromptVersionData"];
};
/** CreatePromptResponseBody */
CreatePromptResponseBody: {
data: components["schemas"]["PromptVersion"];
};
/** CreateSpansRequestBody */
CreateSpansRequestBody: {
/** Data */
data: components["schemas"]["Span"][];
};
/** CreateSpansResponseBody */
CreateSpansResponseBody: {
/**
* Total Received
* @description Total number of spans received
*/
total_received: number;
/**
* Total Queued
* @description Number of spans successfully queued for insertion
*/
total_queued: number;
};
/** CreateUserRequestBody */
CreateUserRequestBody: {
/** User */
user: components["schemas"]["LocalUserData"] | components["schemas"]["OAuth2UserData"];
/**
* Send Welcome Email
* @default true
*/
send_welcome_email?: boolean;
};
/** CreateUserResponseBody */
CreateUserResponseBody: {
/** Data */
data: components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"];
};
/** Dataset */
Dataset: {
/** Id */
id: string;
/** Name */
name: string;
/** Description */
description: string | null;
/** Metadata */
metadata: {
[key: string]: unknown;
};
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Example Count */
example_count: number;
};
/** DatasetExample */
DatasetExample: {
/** Id */
id: string;
/** Input */
input: {
[key: string]: unknown;
};
/** Output */
output: {
[key: string]: unknown;
};
/** Metadata */
metadata: {
[key: string]: unknown;
};
/**
* Updated At
* Format: date-time
*/
updated_at: string;
};
/** DatasetVersion */
DatasetVersion: {
/** Version Id */
version_id: string;
/** Description */
description: string | null;
/** Metadata */
metadata: {
[key: string]: unknown;
};
/**
* Created At
* Format: date-time
*/
created_at: string;
};
/** DatasetWithExampleCount */
DatasetWithExampleCount: {
/** Id */
id: string;
/** Name */
name: string;
/** Description */
description: string | null;
/** Metadata */
metadata: {
[key: string]: unknown;
};
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Example Count */
example_count: number;
};
/** DeleteAnnotationConfigResponseBody */
DeleteAnnotationConfigResponseBody: {
/** Data */
data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
};
/** Experiment */
Experiment: {
/**
* Id
* @description The ID of the experiment
*/
id: string;
/**
* Dataset Id
* @description The ID of the dataset associated with the experiment
*/
dataset_id: string;
/**
* Dataset Version Id
* @description The ID of the dataset version associated with the experiment
*/
dataset_version_id: string;
/**
* Repetitions
* @description Number of times the experiment is repeated
*/
repetitions: number;
/**
* Metadata
* @description Metadata of the experiment
*/
metadata: {
[key: string]: unknown;
};
/**
* Project Name
* @description The name of the project associated with the experiment
*/
project_name: string | null;
/**
* Created At
* Format: date-time
* @description The creation timestamp of the experiment
*/
created_at: string;
/**
* Updated At
* Format: date-time
* @description The last update timestamp of the experiment
*/
updated_at: string;
/**
* Example Count
* @description Number of examples in the experiment
*/
example_count: number;
/**
* Successful Run Count
* @description Number of successful runs in the experiment
*/
successful_run_count: number;
/**
* Failed Run Count
* @description Number of failed runs in the experiment
*/
failed_run_count: number;
/**
* Missing Run Count
* @description Number of missing (not yet executed) runs in the experiment
*/
missing_run_count: number;
};
/** ExperimentEvaluationResult */
ExperimentEvaluationResult: {
/**
* Label
* @description The label assigned by the evaluation
*/
label?: string | null;
/**
* Score
* @description The score assigned by the evaluation
*/
score?: number | null;
/**
* Explanation
* @description Explanation of the evaluation result
*/
explanation?: string | null;
};
/** ExperimentRun */
ExperimentRun: {
/**
* Dataset Example Id
* @description The ID of the dataset example used in the experiment run
*/
dataset_example_id: string;
/**
* Output
* @description The output of the experiment task
*/
output: unknown;
/**
* Repetition Number
* @description The repetition number of the experiment run
*/
repetition_number: number;
/**
* Start Time
* Format: date-time
* @description The start time of the experiment run
*/
start_time: string;
/**
* End Time
* Format: date-time
* @description The end time of the experiment run
*/
end_time: string;
/**
* Trace Id
* @description The ID of the corresponding trace (if one exists)
*/
trace_id?: string | null;
/**
* Error
* @description Optional error message if the experiment run encountered an error
*/
error?: string | null;
/**
* Id
* @description The ID of the experiment run
*/
id: string;
/**
* Experiment Id
* @description The ID of the experiment
*/
experiment_id: string;
};
/** FreeformAnnotationConfig */
FreeformAnnotationConfig: {
/** Name */
name: string;
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
type: "FREEFORM";
/** Description */
description?: string | null;
/** Id */
id: string;
};
/** FreeformAnnotationConfigData */
FreeformAnnotationConfigData: {
/** Name */
name: string;
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
type: "FREEFORM";
/** Description */
description?: string | null;
};
/** GetAnnotationConfigResponseBody */
GetAnnotationConfigResponseBody: {
/** Data */
data: components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
};
/** GetAnnotationConfigsResponseBody */
GetAnnotationConfigsResponseBody: {
/** Data */
data: (components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"])[];
/** Next Cursor */
next_cursor: string | null;
};
/** GetDatasetResponseBody */
GetDatasetResponseBody: {
data: components["schemas"]["DatasetWithExampleCount"];
};
/** GetExperimentResponseBody */
GetExperimentResponseBody: {
data: components["schemas"]["Experiment"];
};
/** GetIncompleteEvaluationsResponseBody */
GetIncompleteEvaluationsResponseBody: {
/** Data */
data: components["schemas"]["IncompleteExperimentEvaluation"][];
/** Next Cursor */
next_cursor: string | null;
};
/** GetIncompleteExperimentRunsResponseBody */
GetIncompleteExperimentRunsResponseBody: {
/** Data */
data: components["schemas"]["IncompleteExperimentRun"][];
/** Next Cursor */
next_cursor: string | null;
};
/** GetProjectResponseBody */
GetProjectResponseBody: {
data: components["schemas"]["Project"];
};
/** GetProjectsResponseBody */
GetProjectsResponseBody: {
/** Data */
data: components["schemas"]["Project"][];
/** Next Cursor */
next_cursor: string | null;
};
/** GetPromptResponseBody */
GetPromptResponseBody: {
data: components["schemas"]["PromptVersion"];
};
/** GetPromptVersionTagsResponseBody */
GetPromptVersionTagsResponseBody: {
/** Data */
data: components["schemas"]["PromptVersionTag"][];
/** Next Cursor */
next_cursor: string | null;
};
/** GetPromptVersionsResponseBody */
GetPromptVersionsResponseBody: {
/** Data */
data: components["schemas"]["PromptVersion"][];
/** Next Cursor */
next_cursor: string | null;
};
/** GetPromptsResponseBody */
GetPromptsResponseBody: {
/** Data */
data: components["schemas"]["Prompt"][];
/** Next Cursor */
next_cursor: string | null;
};
/** GetUsersResponseBody */
GetUsersResponseBody: {
/** Data */
data: (components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"])[];
/** Next Cursor */
next_cursor: string | null;
};
/** HTTPValidationError */
HTTPValidationError: {
/** Detail */
detail?: components["schemas"]["ValidationError"][];
};
/** Identifier */
Identifier: string;
/**
* IncompleteExperimentEvaluation
* @description Information about an experiment run with incomplete evaluations
*/
IncompleteExperimentEvaluation: {
/** @description The experiment run */
experiment_run: components["schemas"]["ExperimentRun"];
/** @description The dataset example */
dataset_example: components["schemas"]["DatasetExample"];
/**
* Evaluation Names
* @description List of evaluation names that are incomplete (either missing or failed)
*/
evaluation_names: string[];
};
/**
* IncompleteExperimentRun
* @description Information about incomplete runs for a dataset example
*/
IncompleteExperimentRun: {
/** @description The dataset example */
dataset_example: components["schemas"]["DatasetExample"];
/**
* Repetition Numbers
* @description List of repetition numbers that need to be run
*/
repetition_numbers: number[];
};
/** InsertedSessionAnnotation */
InsertedSessionAnnotation: {
/**
* Id
* @description The ID of the inserted session annotation
*/
id: string;
};
/** InsertedSpanAnnotation */
InsertedSpanAnnotation: {
/**
* Id
* @description The ID of the inserted span annotation
*/
id: string;
};
/** InsertedSpanDocumentAnnotation */
InsertedSpanDocumentAnnotation: {
/**
* Id
* @description The ID of the inserted span document annotation
*/
id: string;
};
/** InsertedTraceAnnotation */
InsertedTraceAnnotation: {
/**
* Id
* @description The ID of the inserted trace annotation
*/
id: string;
};
/** ListDatasetExamplesData */
ListDatasetExamplesData: {
/** Dataset Id */
dataset_id: string;
/** Version Id */
version_id: string;
/** Filtered Splits */
filtered_splits?: string[];
/** Examples */
examples: components["schemas"]["DatasetExample"][];
};
/** ListDatasetExamplesResponseBody */
ListDatasetExamplesResponseBody: {
data: components["schemas"]["ListDatasetExamplesData"];
};
/** ListDatasetVersionsResponseBody */
ListDatasetVersionsResponseBody: {
/** Data */
data: components["schemas"]["DatasetVersion"][];
/** Next Cursor */
next_cursor: string | null;
};
/** ListDatasetsResponseBody */
ListDatasetsRe