@arizeai/phoenix-client
Version:
A client for the Phoenix API
1,478 lines • 151 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/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 */
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?: 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 */
get: operations["listExperimentRuns"];
put?: never;
/** Create run for an experiment */
post: operations["createExperimentRun"];
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/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/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/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: {
/** AnnotateSpansRequestBody */
AnnotateSpansRequestBody: {
/** Data */
data: components["schemas"]["SpanAnnotationData"][];
};
/** AnnotateSpansResponseBody */
AnnotateSpansResponseBody: {
/** Data */
data: components["schemas"]["InsertedSpanAnnotation"][];
};
/** 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;
/**
* 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;
};
/** 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;
};
/** 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;
};
/** ExperimentRunResponse */
ExperimentRunResponse: {
/**
* 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"];
};
/** 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;
/** InsertedSpanAnnotation */
InsertedSpanAnnotation: {
/**
* Id
* @description The ID of the inserted span annotation
*/
id: string;
};
/** ListDatasetExamplesData */
ListDatasetExamplesData: {
/** Dataset Id */
dataset_id: string;
/** Version Id */
version_id: 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 */
ListDatasetsResponseBody: {
/** Data */
data: components["schemas"]["Dataset"][];
/** Next Cursor */
next_cursor: string | null;
};
/** ListExperimentRunsResponseBody */
ListExperimentRunsResponseBody: {
/** Data */
data: components["schemas"]["ExperimentRunResponse"][];
};
/** ListExperimentsResponseBody */
ListExperimentsResponseBody: {
/** Data */
data: components["schemas"]["Experiment"][];
};
/** LocalUser */
LocalUser: {
/** Id */
id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Email */
email: string;
/** Username */
username: string;
/**
* Role
* @enum {string}
*/
role: "SYSTEM" | "ADMIN" | "MEMBER";
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
auth_method: "LOCAL";
/** Password */
password?: string;
/** Password Needs Reset */
password_needs_reset: boolean;
};
/** LocalUserData */
LocalUserData: {
/** Email */
email: string;
/** Username */
username: string;
/**
* Role
* @enum {string}
*/
role: "SYSTEM" | "ADMIN" | "MEMBER";
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
auth_method: "LOCAL";
/** Password */
password?: string;
};
/**
* ModelProvider
* @enum {string}
*/
ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS";
/** OAuth2User */
OAuth2User: {
/** Id */
id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Email */
email: string;
/** Username */
username: string;
/**
* Role
* @enum {string}
*/
role: "SYSTEM" | "ADMIN" | "MEMBER";
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
auth_method: "OAUTH2";
/** Oauth2 Client Id */
oauth2_client_id?: string;
/** Oauth2 User Id */
oauth2_user_id?: string;
/** Profile Picture Url */
profile_picture_url?: string;
};
/** OAuth2UserData */
OAuth2UserData: {
/** Email */
email: string;
/** Username */
username: string;
/**
* Role
* @enum {string}
*/
role: "SYSTEM" | "ADMIN" | "MEMBER";
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
auth_method: "OAUTH2";
/** Oauth2 Client Id */
oauth2_client_id?: string;
/** Oauth2 User Id */
oauth2_user_id?: string;
};
/**
* OptimizationDirection
* @enum {string}
*/
OptimizationDirection: "MINIMIZE" | "MAXIMIZE" | "NONE";
/** OtlpAnyValue */
OtlpAnyValue: {
array_value?: components["schemas"]["OtlpArrayValue"] | null;
/** Bool Value */
bool_value?: boolean | null;
/** Bytes Value */
bytes_value?: string | null;
/** Double Value */
double_value?: number | components["schemas"]["OtlpDoubleValue"] | string | null;
/** Int Value */
int_value?: number | string | null;
/** Kvlist Value */
kvlist_value?: null;
/** String Value */
string_value?: string | null;
};
/** OtlpArrayValue */
OtlpArrayValue: {
/**
* Values
* @description Array of values. The array may be empty (contain 0 elements).
*/
values?: components["schemas"]["OtlpAnyValue"][] | null;
};
/**
* OtlpDoubleValue
* @enum {string}
*/
OtlpDoubleValue: "Infinity" | "-Infinity" | "NaN";
/** OtlpEvent */
OtlpEvent: {
/**
* Attributes
* @description attributes is a collection of attribute key/value pairs on the event. Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
*/
attributes?: components["schemas"]["OtlpKeyValue"][] | null;
/**
* Dropped Attributes Count
* @description dropped_attributes_count is the number of dropped attributes. If the value is 0, then no attributes were dropped.
*/
dropped_attributes_count?: number | null;
/**
* Name
* @description name of the event. This field is semantically required to be set to non-empty string.
*/
name?: string | null;
/**
* Time Unix Nano
* @description time_unix_nano is the time the event occurred. Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
*/
time_unix_nano?: number | string | null;
};
/** OtlpKeyValue */
OtlpKeyValue: {
/** Key */
key?: string | null;
value?: components["schemas"]["OtlpAnyValue"] | null;
};
/**
* OtlpKind
* @enum {string}
*/
OtlpKind: "SPAN_KIND_UNSPECIFIED" | "SPAN_KIND_INTERNAL" | "SPAN_KIND_SERVER" | "SPAN_KIND_CLIENT" | "SPAN_KIND_PRODUCER" | "SPAN_KIND_CONSUMER";
/** OtlpSpan */
OtlpSpan: {
/**
* Attributes
* @description attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes:
*
* "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
* "/http/server_latency": 300
* "example.com/myattribute": true
* "example.com/score": 10.239
*
* The OpenTelemetry API specification further restricts the allowed value types:
* https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
* Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
*/
attributes?: components["schemas"]["OtlpKeyValue"][] | null;
/**
* Dropped Attributes Count
* @description dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.
*/
dropped_attributes_count?: number | null;
/**
* Dropped Events Count
* @description dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.
*/
dropped_events_count?: number | null;
/**
* Dropped Links Count
* @description dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
*/
dropped_links_count?: number | null;
/**
* End Time Unix Nano
* @description end_time_unix_nano is the end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
* Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
*
* This field is semantically required and it is expected that end_time >= start_time.
*/
end_time_unix_nano?: number | string | null;
/**
* Events
* @description events is a collection of Event items. A span with no events is valid.
*/
events?: components["schemas"]["OtlpEvent"][] | null;
/**
* Flags
* @description Flags, a bit field.
*
* Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace Context specification. To read the 8-bit W3C trace flag, use `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.
*
* See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.
*
* Bits 8 and 9 represent the 3 states of whether a span's parent is remote. The states are (unknown, is not remote, is remote).
* To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
* To read whether the span is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.
*
* When creating span messages, if the message is logically forwarded from another source with an equivalent flags fields (i.e., usually another OTLP span message), the field SHOULD be copied as-is. If creating from a source that does not have an equivalent flags field (such as a runtime representation of an OpenTelemetry span), the high 22 bits MUST be set to zero.
* Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
*
* [Optional].
*/
flags?: number | null;
/**
* Kind
* @description Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify queueing latency associated with the span.
* @default SPAN_KIND_INTERNAL
*/
kind?: components["schemas"]["OtlpKind"] | number | null;
/** Links */
links?: null;
/**
* Name
* @description A description of the span's operation.
*
* For example, the name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name at the same call point in an application. This makes it easier to correlate spans in different traces.
*
* This field is semantically required to be set to non-empty string. Empty value is equivalent to an unknown span name.
*
* This field is required.
*/
name?: string | null;
/**
* Parent Span Id
* @description The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.
*/
parent_span_id?: string | null;
/**
* Span Id
*