mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-03 18:00:36 +00:00
f648cacdad
FastAPI generator now only unwraps body params explicitly marked with Body(embed=False) so the /eval run_eval schema once again exposes RunEvalRequest, matching our integration tests and the server's request parsing. Regenerated the OpenAPI specs to capture the restored wrapper. CI on the Stainless preview builds should be green.
10409 lines
329 KiB
YAML
10409 lines
329 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: Llama Stack Specification - Deprecated APIs
|
|
description: |-
|
|
This is the specification of the Llama Stack that provides
|
|
a set of endpoints and their corresponding interfaces that are
|
|
tailored to
|
|
best leverage Llama Models.
|
|
|
|
**⚠️ DEPRECATED**: Legacy APIs that may be removed in future versions. Use for
|
|
migration reference only.
|
|
version: v1
|
|
servers:
|
|
- url: http://any-hosted-llama-stack.com
|
|
paths:
|
|
/v1/models:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A OpenAIListModelsResponse.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIListModelsResponse'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Models
|
|
summary: Openai List Models
|
|
description: List models using the OpenAI API.
|
|
operationId: openai_list_models_v1_models_get
|
|
post:
|
|
responses:
|
|
'200':
|
|
description: A Model.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Model'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Models
|
|
summary: Register Model
|
|
description: |-
|
|
Register model.
|
|
|
|
Register a model.
|
|
operationId: register_model_v1_models_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterModelRequest'
|
|
required: true
|
|
deprecated: true
|
|
/v1/models/{model_id}:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A Model.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Model'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Models
|
|
summary: Get Model
|
|
description: |-
|
|
Get model.
|
|
|
|
Get a model by its identifier.
|
|
operationId: get_model_v1_models__model_id__get
|
|
parameters:
|
|
- name: model_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: model_id'
|
|
delete:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Models
|
|
summary: Unregister Model
|
|
description: |-
|
|
Unregister model.
|
|
|
|
Unregister a model.
|
|
operationId: unregister_model_v1_models__model_id__delete
|
|
parameters:
|
|
- name: model_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: model_id'
|
|
deprecated: true
|
|
/v1/scoring-functions:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A ListScoringFunctionsResponse.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListScoringFunctionsResponse'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Scoring Functions
|
|
summary: List Scoring Functions
|
|
description: List all scoring functions.
|
|
operationId: list_scoring_functions_v1_scoring_functions_get
|
|
post:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Scoring Functions
|
|
summary: Register Scoring Function
|
|
description: Register a scoring function.
|
|
operationId: register_scoring_function_v1_scoring_functions_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterScoringFunctionRequest'
|
|
required: true
|
|
deprecated: true
|
|
/v1/scoring-functions/{scoring_fn_id}:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A ScoringFn.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoringFn'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Scoring Functions
|
|
summary: Get Scoring Function
|
|
description: Get a scoring function by its ID.
|
|
operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get
|
|
parameters:
|
|
- name: scoring_fn_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: scoring_fn_id'
|
|
delete:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Scoring Functions
|
|
summary: Unregister Scoring Function
|
|
description: Unregister a scoring function.
|
|
operationId: unregister_scoring_function_v1_scoring_functions__scoring_fn_id__delete
|
|
parameters:
|
|
- name: scoring_fn_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: scoring_fn_id'
|
|
deprecated: true
|
|
/v1/shields:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A ListShieldsResponse.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListShieldsResponse'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Shields
|
|
summary: List Shields
|
|
description: List all shields.
|
|
operationId: list_shields_v1_shields_get
|
|
post:
|
|
responses:
|
|
'200':
|
|
description: A Shield.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Shield'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Shields
|
|
summary: Register Shield
|
|
description: Register a shield.
|
|
operationId: register_shield_v1_shields_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterShieldRequest'
|
|
required: true
|
|
deprecated: true
|
|
/v1/shields/{identifier}:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A Shield.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Shield'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Shields
|
|
summary: Get Shield
|
|
description: Get a shield by its identifier.
|
|
operationId: get_shield_v1_shields__identifier__get
|
|
parameters:
|
|
- name: identifier
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: identifier'
|
|
delete:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Shields
|
|
summary: Unregister Shield
|
|
description: Unregister a shield.
|
|
operationId: unregister_shield_v1_shields__identifier__delete
|
|
parameters:
|
|
- name: identifier
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: identifier'
|
|
deprecated: true
|
|
/v1/toolgroups:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A ListToolGroupsResponse.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListToolGroupsResponse'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Tool Groups
|
|
summary: List Tool Groups
|
|
description: List tool groups with optional provider.
|
|
operationId: list_tool_groups_v1_toolgroups_get
|
|
post:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Tool Groups
|
|
summary: Register Tool Group
|
|
description: Register a tool group.
|
|
operationId: register_tool_group_v1_toolgroups_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterToolGroupRequest'
|
|
required: true
|
|
deprecated: true
|
|
/v1/toolgroups/{toolgroup_id}:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A ToolGroup.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ToolGroup'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Tool Groups
|
|
summary: Get Tool Group
|
|
description: Get a tool group by its ID.
|
|
operationId: get_tool_group_v1_toolgroups__toolgroup_id__get
|
|
parameters:
|
|
- name: toolgroup_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: toolgroup_id'
|
|
delete:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Tool Groups
|
|
summary: Unregister Toolgroup
|
|
description: Unregister a tool group.
|
|
operationId: unregister_toolgroup_v1_toolgroups__toolgroup_id__delete
|
|
parameters:
|
|
- name: toolgroup_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: toolgroup_id'
|
|
deprecated: true
|
|
/v1beta/datasets:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A ListDatasetsResponse.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListDatasetsResponse'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Datasets
|
|
summary: List Datasets
|
|
description: List all datasets.
|
|
operationId: list_datasets_v1beta_datasets_get
|
|
post:
|
|
responses:
|
|
'200':
|
|
description: A Dataset.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Dataset'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Datasets
|
|
summary: Register Dataset
|
|
description: Register a new dataset.
|
|
operationId: register_dataset_v1beta_datasets_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterDatasetRequest'
|
|
required: true
|
|
deprecated: true
|
|
/v1beta/datasets/{dataset_id}:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A Dataset.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Dataset'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Datasets
|
|
summary: Get Dataset
|
|
description: Get a dataset by its ID.
|
|
operationId: get_dataset_v1beta_datasets__dataset_id__get
|
|
parameters:
|
|
- name: dataset_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: dataset_id'
|
|
delete:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Datasets
|
|
summary: Unregister Dataset
|
|
description: Unregister a dataset by its ID.
|
|
operationId: unregister_dataset_v1beta_datasets__dataset_id__delete
|
|
parameters:
|
|
- name: dataset_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: dataset_id'
|
|
deprecated: true
|
|
/v1alpha/eval/benchmarks:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A ListBenchmarksResponse.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListBenchmarksResponse'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Benchmarks
|
|
summary: List Benchmarks
|
|
description: List all benchmarks.
|
|
operationId: list_benchmarks_v1alpha_eval_benchmarks_get
|
|
post:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Benchmarks
|
|
summary: Register Benchmark
|
|
description: Register a benchmark.
|
|
operationId: register_benchmark_v1alpha_eval_benchmarks_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterBenchmarkRequest'
|
|
required: true
|
|
deprecated: true
|
|
/v1alpha/eval/benchmarks/{benchmark_id}:
|
|
get:
|
|
responses:
|
|
'200':
|
|
description: A Benchmark.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Benchmark'
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
tags:
|
|
- Benchmarks
|
|
summary: Get Benchmark
|
|
description: Get a benchmark by its ID.
|
|
operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get
|
|
parameters:
|
|
- name: benchmark_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: benchmark_id'
|
|
delete:
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
$ref: '#/components/responses/BadRequest400'
|
|
'429':
|
|
description: Too Many Requests
|
|
$ref: '#/components/responses/TooManyRequests429'
|
|
'500':
|
|
description: Internal Server Error
|
|
$ref: '#/components/responses/InternalServerError500'
|
|
default:
|
|
description: Default Response
|
|
$ref: '#/components/responses/DefaultError'
|
|
'204':
|
|
description: Successful Response
|
|
tags:
|
|
- Benchmarks
|
|
summary: Unregister Benchmark
|
|
description: Unregister a benchmark.
|
|
operationId: unregister_benchmark_v1alpha_eval_benchmarks__benchmark_id__delete
|
|
parameters:
|
|
- name: benchmark_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 'Path parameter: benchmark_id'
|
|
deprecated: true
|
|
components:
|
|
schemas:
|
|
Error:
|
|
description: Error response from the API. Roughly follows RFC 7807.
|
|
properties:
|
|
status:
|
|
title: Status
|
|
type: integer
|
|
title:
|
|
title: Title
|
|
type: string
|
|
detail:
|
|
title: Detail
|
|
type: string
|
|
instance:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
required:
|
|
- status
|
|
- title
|
|
- detail
|
|
title: Error
|
|
type: object
|
|
ListBatchesResponse:
|
|
properties:
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
default: list
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Batch'
|
|
type: array
|
|
title: Data
|
|
description: List of batch objects
|
|
first_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: ID of the first batch in the list
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: ID of the last batch in the list
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
description: Whether there are more batches available
|
|
default: false
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListBatchesResponse
|
|
description: Response containing a list of batch objects.
|
|
CreateBatchRequest:
|
|
properties:
|
|
input_file_id:
|
|
type: string
|
|
title: Input File Id
|
|
endpoint:
|
|
type: string
|
|
title: Endpoint
|
|
completion_window:
|
|
type: string
|
|
const: 24h
|
|
title: Completion Window
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: string
|
|
type: object
|
|
- type: 'null'
|
|
idempotency_key:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- input_file_id
|
|
- endpoint
|
|
- completion_window
|
|
title: CreateBatchRequest
|
|
Batch:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
completion_window:
|
|
type: string
|
|
title: Completion Window
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
endpoint:
|
|
type: string
|
|
title: Endpoint
|
|
input_file_id:
|
|
type: string
|
|
title: Input File Id
|
|
object:
|
|
type: string
|
|
const: batch
|
|
title: Object
|
|
status:
|
|
type: string
|
|
enum:
|
|
- validating
|
|
- failed
|
|
- in_progress
|
|
- finalizing
|
|
- completed
|
|
- expired
|
|
- cancelling
|
|
- cancelled
|
|
title: Status
|
|
cancelled_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
cancelling_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
completed_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
error_file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
errors:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/Errors'
|
|
title: Errors
|
|
- type: 'null'
|
|
title: Errors
|
|
expired_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
expires_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
failed_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
finalizing_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
in_progress_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: string
|
|
type: object
|
|
- type: 'null'
|
|
model:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
output_file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
request_counts:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/BatchRequestCounts'
|
|
title: BatchRequestCounts
|
|
- type: 'null'
|
|
title: BatchRequestCounts
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/BatchUsage'
|
|
title: BatchUsage
|
|
- type: 'null'
|
|
title: BatchUsage
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- id
|
|
- completion_window
|
|
- created_at
|
|
- endpoint
|
|
- input_file_id
|
|
- object
|
|
- status
|
|
title: Batch
|
|
Order:
|
|
type: string
|
|
enum:
|
|
- asc
|
|
- desc
|
|
title: Order
|
|
description: Sort order for paginated responses.
|
|
ListOpenAIChatCompletionResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAICompletionWithInputMessages'
|
|
type: array
|
|
title: Data
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
first_id:
|
|
type: string
|
|
title: First Id
|
|
last_id:
|
|
type: string
|
|
title: Last Id
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
default: list
|
|
type: object
|
|
required:
|
|
- data
|
|
- has_more
|
|
- first_id
|
|
- last_id
|
|
title: ListOpenAIChatCompletionResponse
|
|
description: Response from listing OpenAI-compatible chat completions.
|
|
OpenAIAssistantMessageParam:
|
|
description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request.
|
|
properties:
|
|
role:
|
|
const: assistant
|
|
default: assistant
|
|
title: Role
|
|
type: string
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam]
|
|
- type: 'null'
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam]
|
|
nullable: true
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
tool_calls:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
|
|
type: array
|
|
- type: 'null'
|
|
nullable: true
|
|
title: OpenAIAssistantMessageParam
|
|
type: object
|
|
OpenAIChatCompletionContentPartImageParam:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: image_url
|
|
title: Type
|
|
default: image_url
|
|
image_url:
|
|
$ref: '#/components/schemas/OpenAIImageURL'
|
|
type: object
|
|
required:
|
|
- image_url
|
|
title: OpenAIChatCompletionContentPartImageParam
|
|
description: Image content part for OpenAI-compatible chat completion messages.
|
|
OpenAIChatCompletionContentPartParam:
|
|
discriminator:
|
|
mapping:
|
|
file: '#/components/schemas/OpenAIFile'
|
|
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
title: OpenAIChatCompletionContentPartTextParam
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
title: OpenAIChatCompletionContentPartImageParam
|
|
- $ref: '#/components/schemas/OpenAIFile'
|
|
title: OpenAIFile
|
|
title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile
|
|
OpenAIChatCompletionContentPartTextParam:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: text
|
|
title: Type
|
|
default: text
|
|
text:
|
|
type: string
|
|
title: Text
|
|
type: object
|
|
required:
|
|
- text
|
|
title: OpenAIChatCompletionContentPartTextParam
|
|
description: Text content part for OpenAI-compatible chat completion messages.
|
|
OpenAIChatCompletionToolCall:
|
|
properties:
|
|
index:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type:
|
|
type: string
|
|
const: function
|
|
title: Type
|
|
default: function
|
|
function:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction'
|
|
title: OpenAIChatCompletionToolCallFunction
|
|
- type: 'null'
|
|
title: OpenAIChatCompletionToolCallFunction
|
|
type: object
|
|
title: OpenAIChatCompletionToolCall
|
|
description: Tool call specification for OpenAI-compatible chat completion responses.
|
|
OpenAIChatCompletionToolCallFunction:
|
|
properties:
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
arguments:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIChatCompletionToolCallFunction
|
|
description: Function call details for OpenAI-compatible tool calls.
|
|
OpenAIChatCompletionUsage:
|
|
properties:
|
|
prompt_tokens:
|
|
type: integer
|
|
title: Prompt Tokens
|
|
completion_tokens:
|
|
type: integer
|
|
title: Completion Tokens
|
|
total_tokens:
|
|
type: integer
|
|
title: Total Tokens
|
|
prompt_tokens_details:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails'
|
|
title: OpenAIChatCompletionUsagePromptTokensDetails
|
|
- type: 'null'
|
|
title: OpenAIChatCompletionUsagePromptTokensDetails
|
|
completion_tokens_details:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails'
|
|
title: OpenAIChatCompletionUsageCompletionTokensDetails
|
|
- type: 'null'
|
|
title: OpenAIChatCompletionUsageCompletionTokensDetails
|
|
type: object
|
|
required:
|
|
- prompt_tokens
|
|
- completion_tokens
|
|
- total_tokens
|
|
title: OpenAIChatCompletionUsage
|
|
description: Usage information for OpenAI chat completion.
|
|
OpenAIChoice:
|
|
properties:
|
|
message:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIUserMessageParam-Output'
|
|
title: OpenAIUserMessageParam-Output
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
title: OpenAISystemMessageParam
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output'
|
|
title: OpenAIAssistantMessageParam-Output
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
title: OpenAIToolMessageParam
|
|
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
title: OpenAIDeveloperMessageParam
|
|
title: OpenAIUserMessageParam-Output | ... (5 variants)
|
|
discriminator:
|
|
propertyName: role
|
|
mapping:
|
|
assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output'
|
|
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
system: '#/components/schemas/OpenAISystemMessageParam'
|
|
tool: '#/components/schemas/OpenAIToolMessageParam'
|
|
user: '#/components/schemas/OpenAIUserMessageParam-Output'
|
|
finish_reason:
|
|
type: string
|
|
title: Finish Reason
|
|
index:
|
|
type: integer
|
|
title: Index
|
|
logprobs:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChoiceLogprobs'
|
|
title: OpenAIChoiceLogprobs
|
|
- type: 'null'
|
|
title: OpenAIChoiceLogprobs
|
|
type: object
|
|
required:
|
|
- message
|
|
- finish_reason
|
|
- index
|
|
title: OpenAIChoice
|
|
description: A choice from an OpenAI-compatible chat completion response.
|
|
OpenAIChoiceLogprobs:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAITokenLogProb'
|
|
type: array
|
|
- type: 'null'
|
|
refusal:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAITokenLogProb'
|
|
type: array
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIChoiceLogprobs
|
|
description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response.
|
|
OpenAIDeveloperMessageParam:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: developer
|
|
title: Role
|
|
default: developer
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam]
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam]
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- content
|
|
title: OpenAIDeveloperMessageParam
|
|
description: A message from the developer in an OpenAI-compatible chat completion request.
|
|
OpenAIFile:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: file
|
|
title: Type
|
|
default: file
|
|
file:
|
|
$ref: '#/components/schemas/OpenAIFileFile'
|
|
type: object
|
|
required:
|
|
- file
|
|
title: OpenAIFile
|
|
OpenAIFileFile:
|
|
properties:
|
|
file_data:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
filename:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIFileFile
|
|
OpenAIImageURL:
|
|
properties:
|
|
url:
|
|
type: string
|
|
title: Url
|
|
detail:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- url
|
|
title: OpenAIImageURL
|
|
description: Image URL specification for OpenAI-compatible chat completion messages.
|
|
OpenAIMessageParam:
|
|
discriminator:
|
|
mapping:
|
|
assistant: '#/components/schemas/OpenAIAssistantMessageParam'
|
|
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
system: '#/components/schemas/OpenAISystemMessageParam'
|
|
tool: '#/components/schemas/OpenAIToolMessageParam'
|
|
user: '#/components/schemas/OpenAIUserMessageParam'
|
|
propertyName: role
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIUserMessageParam'
|
|
title: OpenAIUserMessageParam
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
title: OpenAISystemMessageParam
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam'
|
|
title: OpenAIAssistantMessageParam
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
title: OpenAIToolMessageParam
|
|
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
title: OpenAIDeveloperMessageParam
|
|
title: OpenAIUserMessageParam | ... (5 variants)
|
|
OpenAISystemMessageParam:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: system
|
|
title: Role
|
|
default: system
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam]
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam]
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- content
|
|
title: OpenAISystemMessageParam
|
|
description: A system message providing instructions or context to the model.
|
|
OpenAITokenLogProb:
|
|
properties:
|
|
token:
|
|
type: string
|
|
title: Token
|
|
bytes:
|
|
anyOf:
|
|
- items:
|
|
type: integer
|
|
type: array
|
|
- type: 'null'
|
|
logprob:
|
|
type: number
|
|
title: Logprob
|
|
top_logprobs:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAITopLogProb'
|
|
type: array
|
|
title: Top Logprobs
|
|
type: object
|
|
required:
|
|
- token
|
|
- logprob
|
|
- top_logprobs
|
|
title: OpenAITokenLogProb
|
|
description: |-
|
|
The log probability for a token from an OpenAI-compatible chat completion response.
|
|
|
|
:token: The token
|
|
:bytes: (Optional) The bytes for the token
|
|
:logprob: The log probability of the token
|
|
:top_logprobs: The top log probabilities for the token
|
|
OpenAIToolMessageParam:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: tool
|
|
title: Role
|
|
default: tool
|
|
tool_call_id:
|
|
type: string
|
|
title: Tool Call Id
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam]
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam]
|
|
type: object
|
|
required:
|
|
- tool_call_id
|
|
- content
|
|
title: OpenAIToolMessageParam
|
|
description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request.
|
|
OpenAITopLogProb:
|
|
properties:
|
|
token:
|
|
type: string
|
|
title: Token
|
|
bytes:
|
|
anyOf:
|
|
- items:
|
|
type: integer
|
|
type: array
|
|
- type: 'null'
|
|
logprob:
|
|
type: number
|
|
title: Logprob
|
|
type: object
|
|
required:
|
|
- token
|
|
- logprob
|
|
title: OpenAITopLogProb
|
|
description: |-
|
|
The top log probability for a token from an OpenAI-compatible chat completion response.
|
|
|
|
:token: The token
|
|
:bytes: (Optional) The bytes for the token
|
|
:logprob: The log probability of the token
|
|
OpenAIUserMessageParam:
|
|
description: A message from the user in an OpenAI-compatible chat completion request.
|
|
properties:
|
|
role:
|
|
const: user
|
|
default: user
|
|
title: Role
|
|
type: string
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
discriminator:
|
|
mapping:
|
|
file: '#/components/schemas/OpenAIFile'
|
|
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
title: OpenAIChatCompletionContentPartTextParam
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
title: OpenAIChatCompletionContentPartImageParam
|
|
- $ref: '#/components/schemas/OpenAIFile'
|
|
title: OpenAIFile
|
|
title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile]
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile]
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
required:
|
|
- content
|
|
title: OpenAIUserMessageParam
|
|
type: object
|
|
OpenAIJSONSchema:
|
|
properties:
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
strict:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
schema:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIJSONSchema
|
|
description: JSON schema specification for OpenAI-compatible structured response format.
|
|
OpenAIResponseFormatJSONObject:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: json_object
|
|
title: Type
|
|
default: json_object
|
|
type: object
|
|
title: OpenAIResponseFormatJSONObject
|
|
description: JSON object response format for OpenAI-compatible chat completion requests.
|
|
OpenAIResponseFormatJSONSchema:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: json_schema
|
|
title: Type
|
|
default: json_schema
|
|
json_schema:
|
|
$ref: '#/components/schemas/OpenAIJSONSchema'
|
|
type: object
|
|
required:
|
|
- json_schema
|
|
title: OpenAIResponseFormatJSONSchema
|
|
description: JSON schema response format for OpenAI-compatible chat completion requests.
|
|
OpenAIResponseFormatParam:
|
|
discriminator:
|
|
mapping:
|
|
json_object: '#/components/schemas/OpenAIResponseFormatJSONObject'
|
|
json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema'
|
|
text: '#/components/schemas/OpenAIResponseFormatText'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatText'
|
|
title: OpenAIResponseFormatText
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema'
|
|
title: OpenAIResponseFormatJSONSchema
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatJSONObject'
|
|
title: OpenAIResponseFormatJSONObject
|
|
title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject
|
|
OpenAIResponseFormatText:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: text
|
|
title: Type
|
|
default: text
|
|
type: object
|
|
title: OpenAIResponseFormatText
|
|
description: Text response format for OpenAI-compatible chat completion requests.
|
|
OpenAIChatCompletionRequestWithExtraBody:
|
|
properties:
|
|
model:
|
|
type: string
|
|
title: Model
|
|
messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIUserMessageParam-Input'
|
|
title: OpenAIUserMessageParam-Input
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
title: OpenAISystemMessageParam
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input'
|
|
title: OpenAIAssistantMessageParam-Input
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
title: OpenAIToolMessageParam
|
|
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
title: OpenAIDeveloperMessageParam
|
|
discriminator:
|
|
propertyName: role
|
|
mapping:
|
|
assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input'
|
|
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
system: '#/components/schemas/OpenAISystemMessageParam'
|
|
tool: '#/components/schemas/OpenAIToolMessageParam'
|
|
user: '#/components/schemas/OpenAIUserMessageParam-Input'
|
|
title: OpenAIUserMessageParam-Input | ... (5 variants)
|
|
type: array
|
|
minItems: 1
|
|
title: Messages
|
|
frequency_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
function_call:
|
|
anyOf:
|
|
- type: string
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: string | object
|
|
functions:
|
|
anyOf:
|
|
- items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
- type: 'null'
|
|
logit_bias:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: number
|
|
type: object
|
|
- type: 'null'
|
|
logprobs:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
max_completion_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
max_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
n:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
parallel_tool_calls:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
presence_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
response_format:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatText'
|
|
title: OpenAIResponseFormatText
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema'
|
|
title: OpenAIResponseFormatJSONSchema
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatJSONObject'
|
|
title: OpenAIResponseFormatJSONObject
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
json_object: '#/components/schemas/OpenAIResponseFormatJSONObject'
|
|
json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema'
|
|
text: '#/components/schemas/OpenAIResponseFormatText'
|
|
title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject
|
|
- type: 'null'
|
|
title: Response Format
|
|
seed:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
stop:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
- type: 'null'
|
|
title: string | list[string]
|
|
stream:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
stream_options:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
tool_choice:
|
|
anyOf:
|
|
- type: string
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: string | object
|
|
tools:
|
|
anyOf:
|
|
- items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
- type: 'null'
|
|
top_logprobs:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
user:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- model
|
|
- messages
|
|
title: OpenAIChatCompletionRequestWithExtraBody
|
|
description: Request parameters for OpenAI-compatible chat completion endpoint.
|
|
OpenAIChatCompletion:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
choices:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAIChoice'
|
|
type: array
|
|
title: Choices
|
|
object:
|
|
type: string
|
|
const: chat.completion
|
|
title: Object
|
|
default: chat.completion
|
|
created:
|
|
type: integer
|
|
title: Created
|
|
model:
|
|
type: string
|
|
title: Model
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionUsage'
|
|
title: OpenAIChatCompletionUsage
|
|
- type: 'null'
|
|
title: OpenAIChatCompletionUsage
|
|
type: object
|
|
required:
|
|
- id
|
|
- choices
|
|
- created
|
|
- model
|
|
title: OpenAIChatCompletion
|
|
description: Response from an OpenAI-compatible chat completion request.
|
|
OpenAIChatCompletionChunk:
|
|
description: Chunk from a streaming response to an OpenAI-compatible chat completion request.
|
|
properties:
|
|
id:
|
|
title: Id
|
|
type: string
|
|
choices:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAIChunkChoice'
|
|
title: Choices
|
|
type: array
|
|
object:
|
|
const: chat.completion.chunk
|
|
default: chat.completion.chunk
|
|
title: Object
|
|
type: string
|
|
created:
|
|
title: Created
|
|
type: integer
|
|
model:
|
|
title: Model
|
|
type: string
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionUsage'
|
|
title: OpenAIChatCompletionUsage
|
|
- type: 'null'
|
|
nullable: true
|
|
title: OpenAIChatCompletionUsage
|
|
required:
|
|
- id
|
|
- choices
|
|
- created
|
|
- model
|
|
title: OpenAIChatCompletionChunk
|
|
type: object
|
|
OpenAIChoiceDelta:
|
|
description: A delta from an OpenAI-compatible chat completion streaming response.
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
refusal:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
role:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
tool_calls:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
|
|
type: array
|
|
- type: 'null'
|
|
nullable: true
|
|
reasoning_content:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
title: OpenAIChoiceDelta
|
|
type: object
|
|
OpenAIChunkChoice:
|
|
description: A chunk choice from an OpenAI-compatible chat completion streaming response.
|
|
properties:
|
|
delta:
|
|
$ref: '#/components/schemas/OpenAIChoiceDelta'
|
|
finish_reason:
|
|
title: Finish Reason
|
|
type: string
|
|
index:
|
|
title: Index
|
|
type: integer
|
|
logprobs:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChoiceLogprobs'
|
|
title: OpenAIChoiceLogprobs
|
|
- type: 'null'
|
|
nullable: true
|
|
title: OpenAIChoiceLogprobs
|
|
required:
|
|
- delta
|
|
- finish_reason
|
|
- index
|
|
title: OpenAIChunkChoice
|
|
type: object
|
|
OpenAICompletionWithInputMessages:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
choices:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAIChoice'
|
|
type: array
|
|
title: Choices
|
|
object:
|
|
type: string
|
|
const: chat.completion
|
|
title: Object
|
|
default: chat.completion
|
|
created:
|
|
type: integer
|
|
title: Created
|
|
model:
|
|
type: string
|
|
title: Model
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionUsage'
|
|
title: OpenAIChatCompletionUsage
|
|
- type: 'null'
|
|
title: OpenAIChatCompletionUsage
|
|
input_messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIUserMessageParam-Output'
|
|
title: OpenAIUserMessageParam-Output
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
title: OpenAISystemMessageParam
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output'
|
|
title: OpenAIAssistantMessageParam-Output
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
title: OpenAIToolMessageParam
|
|
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
title: OpenAIDeveloperMessageParam
|
|
discriminator:
|
|
propertyName: role
|
|
mapping:
|
|
assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output'
|
|
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
system: '#/components/schemas/OpenAISystemMessageParam'
|
|
tool: '#/components/schemas/OpenAIToolMessageParam'
|
|
user: '#/components/schemas/OpenAIUserMessageParam-Output'
|
|
title: OpenAIUserMessageParam-Output | ... (5 variants)
|
|
type: array
|
|
title: Input Messages
|
|
type: object
|
|
required:
|
|
- id
|
|
- choices
|
|
- created
|
|
- model
|
|
- input_messages
|
|
title: OpenAICompletionWithInputMessages
|
|
OpenAICompletionRequestWithExtraBody:
|
|
properties:
|
|
model:
|
|
type: string
|
|
title: Model
|
|
prompt:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
- items:
|
|
type: integer
|
|
type: array
|
|
title: list[integer]
|
|
- items:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
type: array
|
|
title: list[array]
|
|
title: string | ... (4 variants)
|
|
best_of:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
echo:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
frequency_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
logit_bias:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: number
|
|
type: object
|
|
- type: 'null'
|
|
logprobs:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
max_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
n:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
presence_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
seed:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
stop:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
- type: 'null'
|
|
title: string | list[string]
|
|
stream:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
stream_options:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
user:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
suffix:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- model
|
|
- prompt
|
|
title: OpenAICompletionRequestWithExtraBody
|
|
description: Request parameters for OpenAI-compatible completion endpoint.
|
|
OpenAICompletion:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
choices:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAICompletionChoice'
|
|
type: array
|
|
title: Choices
|
|
created:
|
|
type: integer
|
|
title: Created
|
|
model:
|
|
type: string
|
|
title: Model
|
|
object:
|
|
type: string
|
|
const: text_completion
|
|
title: Object
|
|
default: text_completion
|
|
type: object
|
|
required:
|
|
- id
|
|
- choices
|
|
- created
|
|
- model
|
|
title: OpenAICompletion
|
|
description: |-
|
|
Response from an OpenAI-compatible completion request.
|
|
|
|
:id: The ID of the completion
|
|
:choices: List of choices
|
|
:created: The Unix timestamp in seconds when the completion was created
|
|
:model: The model that was used to generate the completion
|
|
:object: The object type, which will be "text_completion"
|
|
OpenAICompletionChoice:
|
|
properties:
|
|
finish_reason:
|
|
type: string
|
|
title: Finish Reason
|
|
text:
|
|
type: string
|
|
title: Text
|
|
index:
|
|
type: integer
|
|
title: Index
|
|
logprobs:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChoiceLogprobs'
|
|
title: OpenAIChoiceLogprobs
|
|
- type: 'null'
|
|
title: OpenAIChoiceLogprobs
|
|
type: object
|
|
required:
|
|
- finish_reason
|
|
- text
|
|
- index
|
|
title: OpenAICompletionChoice
|
|
description: |-
|
|
A choice from an OpenAI-compatible completion response.
|
|
|
|
:finish_reason: The reason the model stopped generating
|
|
:text: The text of the choice
|
|
:index: The index of the choice
|
|
:logprobs: (Optional) The log probabilities for the tokens in the choice
|
|
ConversationItem:
|
|
discriminator:
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage'
|
|
title: OpenAIResponseMessage
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
title: OpenAIResponseMessage | ... (9 variants)
|
|
OpenAIResponseAnnotationCitation:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: url_citation
|
|
title: Type
|
|
default: url_citation
|
|
end_index:
|
|
type: integer
|
|
title: End Index
|
|
start_index:
|
|
type: integer
|
|
title: Start Index
|
|
title:
|
|
type: string
|
|
title: Title
|
|
url:
|
|
type: string
|
|
title: Url
|
|
type: object
|
|
required:
|
|
- end_index
|
|
- start_index
|
|
- title
|
|
- url
|
|
title: OpenAIResponseAnnotationCitation
|
|
description: URL citation annotation for referencing external web resources.
|
|
OpenAIResponseAnnotationContainerFileCitation:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: container_file_citation
|
|
title: Type
|
|
default: container_file_citation
|
|
container_id:
|
|
type: string
|
|
title: Container Id
|
|
end_index:
|
|
type: integer
|
|
title: End Index
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
start_index:
|
|
type: integer
|
|
title: Start Index
|
|
type: object
|
|
required:
|
|
- container_id
|
|
- end_index
|
|
- file_id
|
|
- filename
|
|
- start_index
|
|
title: OpenAIResponseAnnotationContainerFileCitation
|
|
OpenAIResponseAnnotationFileCitation:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: file_citation
|
|
title: Type
|
|
default: file_citation
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
index:
|
|
type: integer
|
|
title: Index
|
|
type: object
|
|
required:
|
|
- file_id
|
|
- filename
|
|
- index
|
|
title: OpenAIResponseAnnotationFileCitation
|
|
description: File citation annotation for referencing specific files in response content.
|
|
OpenAIResponseAnnotationFilePath:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: file_path
|
|
title: Type
|
|
default: file_path
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
index:
|
|
type: integer
|
|
title: Index
|
|
type: object
|
|
required:
|
|
- file_id
|
|
- index
|
|
title: OpenAIResponseAnnotationFilePath
|
|
OpenAIResponseAnnotations:
|
|
discriminator:
|
|
mapping:
|
|
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
|
|
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
|
|
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
|
|
title: OpenAIResponseAnnotationFileCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
title: OpenAIResponseAnnotationCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
title: OpenAIResponseAnnotationContainerFileCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
|
|
title: OpenAIResponseAnnotationFilePath
|
|
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
|
|
OpenAIResponseContentPartRefusal:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: refusal
|
|
title: Type
|
|
default: refusal
|
|
refusal:
|
|
type: string
|
|
title: Refusal
|
|
type: object
|
|
required:
|
|
- refusal
|
|
title: OpenAIResponseContentPartRefusal
|
|
description: Refusal content within a streamed response part.
|
|
OpenAIResponseInputFunctionToolCallOutput:
|
|
properties:
|
|
call_id:
|
|
type: string
|
|
title: Call Id
|
|
output:
|
|
type: string
|
|
title: Output
|
|
type:
|
|
type: string
|
|
const: function_call_output
|
|
title: Type
|
|
default: function_call_output
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- call_id
|
|
- output
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
description: This represents the output of a function call that gets passed back to the model.
|
|
OpenAIResponseInputMessageContent:
|
|
discriminator:
|
|
mapping:
|
|
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
title: OpenAIResponseInputMessageContentText
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
title: OpenAIResponseInputMessageContentImage
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
title: OpenAIResponseInputMessageContentFile
|
|
title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile
|
|
OpenAIResponseInputMessageContentFile:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: input_file
|
|
title: Type
|
|
default: input_file
|
|
file_data:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
file_url:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
filename:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIResponseInputMessageContentFile
|
|
description: File content for input messages in OpenAI response format.
|
|
OpenAIResponseInputMessageContentImage:
|
|
properties:
|
|
detail:
|
|
title: Detail
|
|
default: auto
|
|
type: string
|
|
enum:
|
|
- low
|
|
- high
|
|
- auto
|
|
type:
|
|
type: string
|
|
const: input_image
|
|
title: Type
|
|
default: input_image
|
|
file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
image_url:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIResponseInputMessageContentImage
|
|
description: Image content for input messages in OpenAI response format.
|
|
OpenAIResponseInputMessageContentText:
|
|
properties:
|
|
text:
|
|
type: string
|
|
title: Text
|
|
type:
|
|
type: string
|
|
const: input_text
|
|
title: Type
|
|
default: input_text
|
|
type: object
|
|
required:
|
|
- text
|
|
title: OpenAIResponseInputMessageContentText
|
|
description: Text content for input messages in OpenAI response format.
|
|
OpenAIResponseMCPApprovalRequest:
|
|
properties:
|
|
arguments:
|
|
type: string
|
|
title: Arguments
|
|
id:
|
|
type: string
|
|
title: Id
|
|
name:
|
|
type: string
|
|
title: Name
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
type:
|
|
type: string
|
|
const: mcp_approval_request
|
|
title: Type
|
|
default: mcp_approval_request
|
|
type: object
|
|
required:
|
|
- arguments
|
|
- id
|
|
- name
|
|
- server_label
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
description: A request for human approval of a tool invocation.
|
|
OpenAIResponseMCPApprovalResponse:
|
|
properties:
|
|
approval_request_id:
|
|
type: string
|
|
title: Approval Request Id
|
|
approve:
|
|
type: boolean
|
|
title: Approve
|
|
type:
|
|
type: string
|
|
const: mcp_approval_response
|
|
title: Type
|
|
default: mcp_approval_response
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
reason:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- approval_request_id
|
|
- approve
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
description: A response to an MCP approval request.
|
|
OpenAIResponseMessage:
|
|
description: |-
|
|
Corresponds to the various Message types in the Responses API.
|
|
They are all under one type because the Responses API gives them all
|
|
the same "type" value, and there is no way to tell them apart in certain
|
|
scenarios.
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
discriminator:
|
|
mapping:
|
|
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
title: OpenAIResponseInputMessageContentText
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
title: OpenAIResponseInputMessageContentImage
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
title: OpenAIResponseInputMessageContentFile
|
|
title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile
|
|
type: array
|
|
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
|
|
- items:
|
|
discriminator:
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
title: OpenAIResponseOutputMessageContentOutputText
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseContentPartRefusal
|
|
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal
|
|
type: array
|
|
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
|
|
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
|
|
role:
|
|
title: Role
|
|
type: string
|
|
enum:
|
|
- system
|
|
- developer
|
|
- user
|
|
- assistant
|
|
default: system
|
|
type:
|
|
const: message
|
|
default: message
|
|
title: Type
|
|
type: string
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
required:
|
|
- content
|
|
- role
|
|
title: OpenAIResponseMessage
|
|
type: object
|
|
OpenAIResponseOutputMessageContent:
|
|
discriminator:
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
title: OpenAIResponseOutputMessageContentOutputText
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseContentPartRefusal
|
|
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal
|
|
OpenAIResponseOutputMessageContentOutputText:
|
|
properties:
|
|
text:
|
|
type: string
|
|
title: Text
|
|
type:
|
|
type: string
|
|
const: output_text
|
|
title: Type
|
|
default: output_text
|
|
annotations:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
|
|
title: OpenAIResponseAnnotationFileCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
title: OpenAIResponseAnnotationCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
title: OpenAIResponseAnnotationContainerFileCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
|
|
title: OpenAIResponseAnnotationFilePath
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
|
|
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
|
|
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
|
|
type: array
|
|
title: Annotations
|
|
type: object
|
|
required:
|
|
- text
|
|
title: OpenAIResponseOutputMessageContentOutputText
|
|
OpenAIResponseOutputMessageFileSearchToolCall:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
queries:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Queries
|
|
status:
|
|
type: string
|
|
title: Status
|
|
type:
|
|
type: string
|
|
const: file_search_call
|
|
title: Type
|
|
default: file_search_call
|
|
results:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults'
|
|
type: array
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- id
|
|
- queries
|
|
- status
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
description: File search tool call output message for OpenAI responses.
|
|
OpenAIResponseOutputMessageFunctionToolCall:
|
|
properties:
|
|
call_id:
|
|
type: string
|
|
title: Call Id
|
|
name:
|
|
type: string
|
|
title: Name
|
|
arguments:
|
|
type: string
|
|
title: Arguments
|
|
type:
|
|
type: string
|
|
const: function_call
|
|
title: Type
|
|
default: function_call
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- call_id
|
|
- name
|
|
- arguments
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
description: Function tool call output message for OpenAI responses.
|
|
OpenAIResponseOutputMessageMCPCall:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
type:
|
|
type: string
|
|
const: mcp_call
|
|
title: Type
|
|
default: mcp_call
|
|
arguments:
|
|
type: string
|
|
title: Arguments
|
|
name:
|
|
type: string
|
|
title: Name
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
error:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
output:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- id
|
|
- arguments
|
|
- name
|
|
- server_label
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
description: Model Context Protocol (MCP) call output message for OpenAI responses.
|
|
OpenAIResponseOutputMessageMCPListTools:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
type:
|
|
type: string
|
|
const: mcp_list_tools
|
|
title: Type
|
|
default: mcp_list_tools
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
tools:
|
|
items:
|
|
$ref: '#/components/schemas/MCPListToolsTool'
|
|
type: array
|
|
title: Tools
|
|
type: object
|
|
required:
|
|
- id
|
|
- server_label
|
|
- tools
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
description: MCP list tools output message containing available tools from an MCP server.
|
|
OpenAIResponseOutputMessageWebSearchToolCall:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
status:
|
|
type: string
|
|
title: Status
|
|
type:
|
|
type: string
|
|
const: web_search_call
|
|
title: Type
|
|
default: web_search_call
|
|
type: object
|
|
required:
|
|
- id
|
|
- status
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
description: Web search tool call output message for OpenAI responses.
|
|
CreateConversationRequest:
|
|
properties:
|
|
items:
|
|
anyOf:
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
title: OpenAIResponseMessage-Input
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseMessage-Input | ... (9 variants)
|
|
type: array
|
|
- type: 'null'
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: string
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
title: CreateConversationRequest
|
|
Conversation:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: The unique ID of the conversation.
|
|
object:
|
|
type: string
|
|
const: conversation
|
|
title: Object
|
|
description: The object type, which is always conversation.
|
|
default: conversation
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
description: The time at which the conversation was created, measured in seconds since the Unix epoch.
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: string
|
|
type: object
|
|
- type: 'null'
|
|
description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
|
|
items:
|
|
anyOf:
|
|
- items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
- type: 'null'
|
|
description: Initial items to include in the conversation context. You may add up to 20 items at a time.
|
|
type: object
|
|
required:
|
|
- id
|
|
- created_at
|
|
title: Conversation
|
|
description: OpenAI-compatible conversation object.
|
|
UpdateConversationRequest:
|
|
properties:
|
|
metadata:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
title: Metadata
|
|
type: object
|
|
required:
|
|
- metadata
|
|
title: UpdateConversationRequest
|
|
ConversationDeletedResource:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: The deleted conversation identifier
|
|
object:
|
|
type: string
|
|
title: Object
|
|
description: Object type
|
|
default: conversation.deleted
|
|
deleted:
|
|
type: boolean
|
|
title: Deleted
|
|
description: Whether the object was deleted
|
|
default: true
|
|
type: object
|
|
required:
|
|
- id
|
|
title: ConversationDeletedResource
|
|
description: Response for deleted conversation.
|
|
ConversationItemList:
|
|
properties:
|
|
object:
|
|
type: string
|
|
title: Object
|
|
description: Object type
|
|
default: list
|
|
data:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
title: OpenAIResponseMessage-Output
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseMessage-Output | ... (9 variants)
|
|
type: array
|
|
title: Data
|
|
description: List of conversation items
|
|
first_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: The ID of the first item in the list
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: The ID of the last item in the list
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
description: Whether there are more items available
|
|
default: false
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ConversationItemList
|
|
description: List of conversation items with pagination.
|
|
AddItemsRequest:
|
|
properties:
|
|
items:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
title: OpenAIResponseMessage-Input
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseMessage-Input | ... (9 variants)
|
|
type: array
|
|
title: Items
|
|
type: object
|
|
required:
|
|
- items
|
|
title: AddItemsRequest
|
|
ConversationItemDeletedResource:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: The deleted item identifier
|
|
object:
|
|
type: string
|
|
title: Object
|
|
description: Object type
|
|
default: conversation.item.deleted
|
|
deleted:
|
|
type: boolean
|
|
title: Deleted
|
|
description: Whether the object was deleted
|
|
default: true
|
|
type: object
|
|
required:
|
|
- id
|
|
title: ConversationItemDeletedResource
|
|
description: Response for deleted conversation item.
|
|
OpenAIEmbeddingsRequestWithExtraBody:
|
|
properties:
|
|
model:
|
|
type: string
|
|
title: Model
|
|
input:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
title: string | list[string]
|
|
encoding_format:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
default: float
|
|
dimensions:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
user:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- model
|
|
- input
|
|
title: OpenAIEmbeddingsRequestWithExtraBody
|
|
description: Request parameters for OpenAI-compatible embeddings endpoint.
|
|
OpenAIEmbeddingData:
|
|
properties:
|
|
object:
|
|
type: string
|
|
const: embedding
|
|
title: Object
|
|
default: embedding
|
|
embedding:
|
|
anyOf:
|
|
- items:
|
|
type: number
|
|
type: array
|
|
title: list[number]
|
|
- type: string
|
|
title: list[number] | string
|
|
index:
|
|
type: integer
|
|
title: Index
|
|
type: object
|
|
required:
|
|
- embedding
|
|
- index
|
|
title: OpenAIEmbeddingData
|
|
description: A single embedding data object from an OpenAI-compatible embeddings response.
|
|
OpenAIEmbeddingUsage:
|
|
properties:
|
|
prompt_tokens:
|
|
type: integer
|
|
title: Prompt Tokens
|
|
total_tokens:
|
|
type: integer
|
|
title: Total Tokens
|
|
type: object
|
|
required:
|
|
- prompt_tokens
|
|
- total_tokens
|
|
title: OpenAIEmbeddingUsage
|
|
description: Usage information for an OpenAI-compatible embeddings response.
|
|
OpenAIEmbeddingsResponse:
|
|
properties:
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
default: list
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAIEmbeddingData'
|
|
type: array
|
|
title: Data
|
|
model:
|
|
type: string
|
|
title: Model
|
|
usage:
|
|
$ref: '#/components/schemas/OpenAIEmbeddingUsage'
|
|
type: object
|
|
required:
|
|
- data
|
|
- model
|
|
- usage
|
|
title: OpenAIEmbeddingsResponse
|
|
description: Response from an OpenAI-compatible embeddings request.
|
|
OpenAIFilePurpose:
|
|
type: string
|
|
enum:
|
|
- assistants
|
|
- batch
|
|
title: OpenAIFilePurpose
|
|
description: Valid purpose values for OpenAI Files API.
|
|
ListOpenAIFileResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAIFileObject'
|
|
type: array
|
|
title: Data
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
first_id:
|
|
type: string
|
|
title: First Id
|
|
last_id:
|
|
type: string
|
|
title: Last Id
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
default: list
|
|
type: object
|
|
required:
|
|
- data
|
|
- has_more
|
|
- first_id
|
|
- last_id
|
|
title: ListOpenAIFileResponse
|
|
description: Response for listing files in OpenAI Files API.
|
|
OpenAIFileObject:
|
|
properties:
|
|
object:
|
|
type: string
|
|
const: file
|
|
title: Object
|
|
default: file
|
|
id:
|
|
type: string
|
|
title: Id
|
|
bytes:
|
|
type: integer
|
|
title: Bytes
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
expires_at:
|
|
type: integer
|
|
title: Expires At
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
purpose:
|
|
$ref: '#/components/schemas/OpenAIFilePurpose'
|
|
type: object
|
|
required:
|
|
- id
|
|
- bytes
|
|
- created_at
|
|
- expires_at
|
|
- filename
|
|
- purpose
|
|
title: OpenAIFileObject
|
|
description: OpenAI File object as defined in the OpenAI Files API.
|
|
ExpiresAfter:
|
|
properties:
|
|
anchor:
|
|
type: string
|
|
const: created_at
|
|
title: Anchor
|
|
seconds:
|
|
type: integer
|
|
maximum: 2592000.0
|
|
minimum: 3600.0
|
|
title: Seconds
|
|
type: object
|
|
required:
|
|
- anchor
|
|
- seconds
|
|
title: ExpiresAfter
|
|
description: |-
|
|
Control expiration of uploaded files.
|
|
|
|
Params:
|
|
- anchor, must be "created_at"
|
|
- seconds, must be int between 3600 and 2592000 (1 hour to 30 days)
|
|
OpenAIFileDeleteResponse:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
object:
|
|
type: string
|
|
const: file
|
|
title: Object
|
|
default: file
|
|
deleted:
|
|
type: boolean
|
|
title: Deleted
|
|
type: object
|
|
required:
|
|
- id
|
|
- deleted
|
|
title: OpenAIFileDeleteResponse
|
|
description: Response for deleting a file in OpenAI Files API.
|
|
Response:
|
|
title: Response
|
|
type: object
|
|
HealthInfo:
|
|
properties:
|
|
status:
|
|
$ref: '#/components/schemas/HealthStatus'
|
|
type: object
|
|
required:
|
|
- status
|
|
title: HealthInfo
|
|
description: Health status information for the service.
|
|
RouteInfo:
|
|
properties:
|
|
route:
|
|
type: string
|
|
title: Route
|
|
method:
|
|
type: string
|
|
title: Method
|
|
provider_types:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Provider Types
|
|
type: object
|
|
required:
|
|
- route
|
|
- method
|
|
- provider_types
|
|
title: RouteInfo
|
|
description: Information about an API route including its path, method, and implementing providers.
|
|
ListRoutesResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/RouteInfo'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListRoutesResponse
|
|
description: Response containing a list of all available API routes.
|
|
OpenAIModel:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
object:
|
|
type: string
|
|
const: model
|
|
title: Object
|
|
default: model
|
|
created:
|
|
type: integer
|
|
title: Created
|
|
owned_by:
|
|
type: string
|
|
title: Owned By
|
|
custom_metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- id
|
|
- created
|
|
- owned_by
|
|
title: OpenAIModel
|
|
description: |-
|
|
A model from OpenAI.
|
|
|
|
:id: The ID of the model
|
|
:object: The object type, which will be "model"
|
|
:created: The Unix timestamp in seconds when the model was created
|
|
:owned_by: The owner of the model
|
|
:custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata
|
|
OpenAIListModelsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAIModel'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: OpenAIListModelsResponse
|
|
Model:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
description: Unique identifier for this resource in llama stack
|
|
provider_resource_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Unique identifier for this resource in the provider
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
description: ID of the provider that owns this resource
|
|
type:
|
|
type: string
|
|
const: model
|
|
title: Type
|
|
default: model
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
description: Any additional metadata for this model
|
|
model_type:
|
|
$ref: '#/components/schemas/ModelType'
|
|
default: llm
|
|
type: object
|
|
required:
|
|
- identifier
|
|
- provider_id
|
|
title: Model
|
|
description: A model resource representing an AI model registered in Llama Stack.
|
|
ModelType:
|
|
type: string
|
|
enum:
|
|
- llm
|
|
- embedding
|
|
- rerank
|
|
title: ModelType
|
|
description: Enumeration of supported model types in Llama Stack.
|
|
RunModerationRequest:
|
|
properties:
|
|
input:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
title: string | list[string]
|
|
model:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- input
|
|
title: RunModerationRequest
|
|
ModerationObject:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
model:
|
|
type: string
|
|
title: Model
|
|
results:
|
|
items:
|
|
$ref: '#/components/schemas/ModerationObjectResults'
|
|
type: array
|
|
title: Results
|
|
type: object
|
|
required:
|
|
- id
|
|
- model
|
|
- results
|
|
title: ModerationObject
|
|
description: A moderation object.
|
|
ModerationObjectResults:
|
|
properties:
|
|
flagged:
|
|
type: boolean
|
|
title: Flagged
|
|
categories:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: boolean
|
|
type: object
|
|
- type: 'null'
|
|
category_applied_input_types:
|
|
anyOf:
|
|
- additionalProperties:
|
|
items:
|
|
type: string
|
|
type: array
|
|
type: object
|
|
- type: 'null'
|
|
category_scores:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: number
|
|
type: object
|
|
- type: 'null'
|
|
user_message:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
type: object
|
|
required:
|
|
- flagged
|
|
title: ModerationObjectResults
|
|
description: A moderation object.
|
|
Prompt:
|
|
properties:
|
|
prompt:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: The system prompt with variable placeholders
|
|
version:
|
|
type: integer
|
|
minimum: 1.0
|
|
title: Version
|
|
description: Version (integer starting at 1, incremented on save)
|
|
prompt_id:
|
|
type: string
|
|
title: Prompt Id
|
|
description: Unique identifier in format 'pmpt_<48-digit-hash>'
|
|
variables:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Variables
|
|
description: List of variable names that can be used in the prompt template
|
|
is_default:
|
|
type: boolean
|
|
title: Is Default
|
|
description: Boolean indicating whether this version is the default version
|
|
default: false
|
|
type: object
|
|
required:
|
|
- version
|
|
- prompt_id
|
|
title: Prompt
|
|
description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack.
|
|
ListPromptsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Prompt'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListPromptsResponse
|
|
description: Response model to list prompts.
|
|
CreatePromptRequest:
|
|
properties:
|
|
prompt:
|
|
type: string
|
|
title: Prompt
|
|
variables:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- prompt
|
|
title: CreatePromptRequest
|
|
UpdatePromptRequest:
|
|
properties:
|
|
prompt:
|
|
type: string
|
|
title: Prompt
|
|
version:
|
|
type: integer
|
|
title: Version
|
|
variables:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
set_as_default:
|
|
type: boolean
|
|
title: Set As Default
|
|
default: true
|
|
type: object
|
|
required:
|
|
- prompt
|
|
- version
|
|
title: UpdatePromptRequest
|
|
SetDefaultVersionRequest:
|
|
properties:
|
|
version:
|
|
type: integer
|
|
title: Version
|
|
type: object
|
|
required:
|
|
- version
|
|
title: SetDefaultVersionRequest
|
|
ProviderInfo:
|
|
properties:
|
|
api:
|
|
type: string
|
|
title: Api
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
provider_type:
|
|
type: string
|
|
title: Provider Type
|
|
config:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Config
|
|
health:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Health
|
|
type: object
|
|
required:
|
|
- api
|
|
- provider_id
|
|
- provider_type
|
|
- config
|
|
- health
|
|
title: ProviderInfo
|
|
description: Information about a registered provider including its configuration and health status.
|
|
ListProvidersResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/ProviderInfo'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListProvidersResponse
|
|
description: Response containing a list of all available providers.
|
|
ListOpenAIResponseObject:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAIResponseObjectWithInput'
|
|
type: array
|
|
title: Data
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
first_id:
|
|
type: string
|
|
title: First Id
|
|
last_id:
|
|
type: string
|
|
title: Last Id
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
default: list
|
|
type: object
|
|
required:
|
|
- data
|
|
- has_more
|
|
- first_id
|
|
- last_id
|
|
title: ListOpenAIResponseObject
|
|
description: Paginated list of OpenAI response objects with navigation metadata.
|
|
OpenAIResponseError:
|
|
properties:
|
|
code:
|
|
type: string
|
|
title: Code
|
|
message:
|
|
type: string
|
|
title: Message
|
|
type: object
|
|
required:
|
|
- code
|
|
- message
|
|
title: OpenAIResponseError
|
|
description: Error details for failed OpenAI response requests.
|
|
OpenAIResponseInput:
|
|
anyOf:
|
|
- discriminator:
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage'
|
|
title: OpenAIResponseMessage
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
title: OpenAIResponseMessage | ... (7 variants)
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage'
|
|
title: OpenAIResponseMessage
|
|
title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage
|
|
OpenAIResponseInputToolFileSearch:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: file_search
|
|
title: Type
|
|
default: file_search
|
|
vector_store_ids:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Vector Store Ids
|
|
filters:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
max_num_results:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 50.0
|
|
minimum: 1.0
|
|
- type: 'null'
|
|
default: 10
|
|
ranking_options:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/SearchRankingOptions'
|
|
title: SearchRankingOptions
|
|
- type: 'null'
|
|
title: SearchRankingOptions
|
|
type: object
|
|
required:
|
|
- vector_store_ids
|
|
title: OpenAIResponseInputToolFileSearch
|
|
description: File search tool configuration for OpenAI response inputs.
|
|
OpenAIResponseInputToolFunction:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: function
|
|
title: Type
|
|
default: function
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
parameters:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
strict:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- name
|
|
- parameters
|
|
title: OpenAIResponseInputToolFunction
|
|
description: Function tool configuration for OpenAI response inputs.
|
|
OpenAIResponseInputToolWebSearch:
|
|
properties:
|
|
type:
|
|
title: Type
|
|
default: web_search
|
|
type: string
|
|
enum:
|
|
- web_search
|
|
- web_search_preview
|
|
- web_search_preview_2025_03_11
|
|
- web_search_2025_08_26
|
|
search_context_size:
|
|
anyOf:
|
|
- type: string
|
|
pattern: ^low|medium|high$
|
|
- type: 'null'
|
|
default: medium
|
|
type: object
|
|
title: OpenAIResponseInputToolWebSearch
|
|
description: Web search tool configuration for OpenAI response inputs.
|
|
OpenAIResponseObjectWithInput:
|
|
properties:
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
error:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseError'
|
|
title: OpenAIResponseError
|
|
- type: 'null'
|
|
title: OpenAIResponseError
|
|
id:
|
|
type: string
|
|
title: Id
|
|
model:
|
|
type: string
|
|
title: Model
|
|
object:
|
|
type: string
|
|
const: response
|
|
title: Object
|
|
default: response
|
|
output:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
title: OpenAIResponseMessage-Output
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseMessage-Output | ... (7 variants)
|
|
type: array
|
|
title: Output
|
|
parallel_tool_calls:
|
|
type: boolean
|
|
title: Parallel Tool Calls
|
|
default: false
|
|
previous_response_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
prompt:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponsePrompt'
|
|
title: OpenAIResponsePrompt
|
|
- type: 'null'
|
|
title: OpenAIResponsePrompt
|
|
status:
|
|
type: string
|
|
title: Status
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
text:
|
|
$ref: '#/components/schemas/OpenAIResponseText'
|
|
default:
|
|
format:
|
|
type: text
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
tools:
|
|
anyOf:
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
title: OpenAIResponseInputToolWebSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
title: OpenAIResponseInputToolFileSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
title: OpenAIResponseInputToolFunction
|
|
- $ref: '#/components/schemas/OpenAIResponseToolMCP'
|
|
title: OpenAIResponseToolMCP
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
function: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
mcp: '#/components/schemas/OpenAIResponseToolMCP'
|
|
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
title: OpenAIResponseInputToolWebSearch | ... (4 variants)
|
|
type: array
|
|
- type: 'null'
|
|
truncation:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseUsage'
|
|
title: OpenAIResponseUsage
|
|
- type: 'null'
|
|
title: OpenAIResponseUsage
|
|
instructions:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
max_tool_calls:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
input:
|
|
items:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
title: OpenAIResponseMessage-Output
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseMessage-Output | ... (7 variants)
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
title: OpenAIResponseMessage-Output
|
|
title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output
|
|
type: array
|
|
title: Input
|
|
type: object
|
|
required:
|
|
- created_at
|
|
- id
|
|
- model
|
|
- output
|
|
- status
|
|
- input
|
|
title: OpenAIResponseObjectWithInput
|
|
description: OpenAI response object extended with input context information.
|
|
OpenAIResponseOutput:
|
|
discriminator:
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage'
|
|
title: OpenAIResponseMessage
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
title: OpenAIResponseMessage | ... (7 variants)
|
|
OpenAIResponsePrompt:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
variables:
|
|
anyOf:
|
|
- additionalProperties:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
title: OpenAIResponseInputMessageContentText
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
title: OpenAIResponseInputMessageContentImage
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
title: OpenAIResponseInputMessageContentFile
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile
|
|
type: object
|
|
- type: 'null'
|
|
version:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- id
|
|
title: OpenAIResponsePrompt
|
|
description: OpenAI compatible Prompt object that is used in OpenAI responses.
|
|
OpenAIResponseText:
|
|
properties:
|
|
format:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseTextFormat'
|
|
title: OpenAIResponseTextFormat
|
|
- type: 'null'
|
|
title: OpenAIResponseTextFormat
|
|
type: object
|
|
title: OpenAIResponseText
|
|
description: Text response configuration for OpenAI responses.
|
|
OpenAIResponseTool:
|
|
discriminator:
|
|
mapping:
|
|
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
function: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
mcp: '#/components/schemas/OpenAIResponseToolMCP'
|
|
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
title: OpenAIResponseInputToolWebSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
title: OpenAIResponseInputToolFileSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
title: OpenAIResponseInputToolFunction
|
|
- $ref: '#/components/schemas/OpenAIResponseToolMCP'
|
|
title: OpenAIResponseToolMCP
|
|
title: OpenAIResponseInputToolWebSearch | ... (4 variants)
|
|
OpenAIResponseToolMCP:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: mcp
|
|
title: Type
|
|
default: mcp
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
allowed_tools:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
- $ref: '#/components/schemas/AllowedToolsFilter'
|
|
title: AllowedToolsFilter
|
|
- type: 'null'
|
|
title: list[string] | AllowedToolsFilter
|
|
type: object
|
|
required:
|
|
- server_label
|
|
title: OpenAIResponseToolMCP
|
|
description: Model Context Protocol (MCP) tool configuration for OpenAI response object.
|
|
OpenAIResponseUsage:
|
|
properties:
|
|
input_tokens:
|
|
type: integer
|
|
title: Input Tokens
|
|
output_tokens:
|
|
type: integer
|
|
title: Output Tokens
|
|
total_tokens:
|
|
type: integer
|
|
title: Total Tokens
|
|
input_tokens_details:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails'
|
|
title: OpenAIResponseUsageInputTokensDetails
|
|
- type: 'null'
|
|
title: OpenAIResponseUsageInputTokensDetails
|
|
output_tokens_details:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails'
|
|
title: OpenAIResponseUsageOutputTokensDetails
|
|
- type: 'null'
|
|
title: OpenAIResponseUsageOutputTokensDetails
|
|
type: object
|
|
required:
|
|
- input_tokens
|
|
- output_tokens
|
|
- total_tokens
|
|
title: OpenAIResponseUsage
|
|
description: Usage information for OpenAI response.
|
|
ResponseGuardrailSpec:
|
|
description: Specification for a guardrail to apply during response generation.
|
|
properties:
|
|
type:
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- type
|
|
title: ResponseGuardrailSpec
|
|
type: object
|
|
OpenAIResponseInputTool:
|
|
discriminator:
|
|
mapping:
|
|
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
function: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
mcp: '#/components/schemas/OpenAIResponseInputToolMCP'
|
|
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
title: OpenAIResponseInputToolWebSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
title: OpenAIResponseInputToolFileSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
title: OpenAIResponseInputToolFunction
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolMCP'
|
|
title: OpenAIResponseInputToolMCP
|
|
title: OpenAIResponseInputToolWebSearch | ... (4 variants)
|
|
OpenAIResponseInputToolMCP:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: mcp
|
|
title: Type
|
|
default: mcp
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
server_url:
|
|
type: string
|
|
title: Server Url
|
|
headers:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
authorization:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
require_approval:
|
|
anyOf:
|
|
- type: string
|
|
const: always
|
|
- type: string
|
|
const: never
|
|
- $ref: '#/components/schemas/ApprovalFilter'
|
|
title: ApprovalFilter
|
|
title: string | ApprovalFilter
|
|
default: never
|
|
allowed_tools:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
- $ref: '#/components/schemas/AllowedToolsFilter'
|
|
title: AllowedToolsFilter
|
|
- type: 'null'
|
|
title: list[string] | AllowedToolsFilter
|
|
type: object
|
|
required:
|
|
- server_label
|
|
- server_url
|
|
title: OpenAIResponseInputToolMCP
|
|
description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs.
|
|
CreateOpenaiResponseRequest:
|
|
properties:
|
|
input:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
title: OpenAIResponseMessage-Input
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseMessage-Input | ... (7 variants)
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
title: OpenAIResponseMessage-Input
|
|
title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Input
|
|
type: array
|
|
title: list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...]
|
|
title: string | list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...]
|
|
model:
|
|
type: string
|
|
title: Model
|
|
prompt:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponsePrompt'
|
|
title: OpenAIResponsePrompt
|
|
- type: 'null'
|
|
title: OpenAIResponsePrompt
|
|
instructions:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
previous_response_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
conversation:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
store:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: true
|
|
stream:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
text:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseText'
|
|
title: OpenAIResponseText
|
|
- type: 'null'
|
|
title: OpenAIResponseText
|
|
tools:
|
|
anyOf:
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
title: OpenAIResponseInputToolWebSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
title: OpenAIResponseInputToolFileSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
title: OpenAIResponseInputToolFunction
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolMCP'
|
|
title: OpenAIResponseInputToolMCP
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
function: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
mcp: '#/components/schemas/OpenAIResponseInputToolMCP'
|
|
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
title: OpenAIResponseInputToolWebSearch | ... (4 variants)
|
|
type: array
|
|
- type: 'null'
|
|
include:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
max_infer_iters:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
default: 10
|
|
max_tool_calls:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- input
|
|
- model
|
|
title: CreateOpenaiResponseRequest
|
|
OpenAIResponseObject:
|
|
properties:
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
error:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseError'
|
|
title: OpenAIResponseError
|
|
- type: 'null'
|
|
title: OpenAIResponseError
|
|
id:
|
|
type: string
|
|
title: Id
|
|
model:
|
|
type: string
|
|
title: Model
|
|
object:
|
|
type: string
|
|
const: response
|
|
title: Object
|
|
default: response
|
|
output:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
title: OpenAIResponseMessage-Output
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseMessage-Output | ... (7 variants)
|
|
type: array
|
|
title: Output
|
|
parallel_tool_calls:
|
|
type: boolean
|
|
title: Parallel Tool Calls
|
|
default: false
|
|
previous_response_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
prompt:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponsePrompt'
|
|
title: OpenAIResponsePrompt
|
|
- type: 'null'
|
|
title: OpenAIResponsePrompt
|
|
status:
|
|
type: string
|
|
title: Status
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
text:
|
|
$ref: '#/components/schemas/OpenAIResponseText'
|
|
default:
|
|
format:
|
|
type: text
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
tools:
|
|
anyOf:
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
title: OpenAIResponseInputToolWebSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
title: OpenAIResponseInputToolFileSearch
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
title: OpenAIResponseInputToolFunction
|
|
- $ref: '#/components/schemas/OpenAIResponseToolMCP'
|
|
title: OpenAIResponseToolMCP
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
function: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
mcp: '#/components/schemas/OpenAIResponseToolMCP'
|
|
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
title: OpenAIResponseInputToolWebSearch | ... (4 variants)
|
|
type: array
|
|
- type: 'null'
|
|
truncation:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseUsage'
|
|
title: OpenAIResponseUsage
|
|
- type: 'null'
|
|
title: OpenAIResponseUsage
|
|
instructions:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
max_tool_calls:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- created_at
|
|
- id
|
|
- model
|
|
- output
|
|
- status
|
|
title: OpenAIResponseObject
|
|
description: Complete OpenAI response object containing generation results and metadata.
|
|
OpenAIResponseContentPartOutputText:
|
|
description: Text content within a streamed response part.
|
|
properties:
|
|
type:
|
|
const: output_text
|
|
default: output_text
|
|
title: Type
|
|
type: string
|
|
text:
|
|
title: Text
|
|
type: string
|
|
annotations:
|
|
items:
|
|
discriminator:
|
|
mapping:
|
|
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
|
|
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
|
|
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
|
|
title: OpenAIResponseAnnotationFileCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
title: OpenAIResponseAnnotationCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
title: OpenAIResponseAnnotationContainerFileCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
|
|
title: OpenAIResponseAnnotationFilePath
|
|
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
|
|
title: Annotations
|
|
type: array
|
|
logprobs:
|
|
anyOf:
|
|
- items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
- type: 'null'
|
|
nullable: true
|
|
required:
|
|
- text
|
|
title: OpenAIResponseContentPartOutputText
|
|
type: object
|
|
OpenAIResponseContentPartReasoningSummary:
|
|
description: Reasoning summary part in a streamed response.
|
|
properties:
|
|
type:
|
|
const: summary_text
|
|
default: summary_text
|
|
title: Type
|
|
type: string
|
|
text:
|
|
title: Text
|
|
type: string
|
|
required:
|
|
- text
|
|
title: OpenAIResponseContentPartReasoningSummary
|
|
type: object
|
|
OpenAIResponseContentPartReasoningText:
|
|
description: Reasoning text emitted as part of a streamed response.
|
|
properties:
|
|
type:
|
|
const: reasoning_text
|
|
default: reasoning_text
|
|
title: Type
|
|
type: string
|
|
text:
|
|
title: Text
|
|
type: string
|
|
required:
|
|
- text
|
|
title: OpenAIResponseContentPartReasoningText
|
|
type: object
|
|
OpenAIResponseObjectStream:
|
|
discriminator:
|
|
mapping:
|
|
response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
|
|
response.content_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
|
|
response.content_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
|
|
response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
|
|
response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
|
|
response.file_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted'
|
|
response.file_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress'
|
|
response.file_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching'
|
|
response.function_call_arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta'
|
|
response.function_call_arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone'
|
|
response.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
|
|
response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
|
|
response.mcp_call.arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta'
|
|
response.mcp_call.arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone'
|
|
response.mcp_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
|
|
response.mcp_call.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed'
|
|
response.mcp_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress'
|
|
response.mcp_list_tools.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted'
|
|
response.mcp_list_tools.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed'
|
|
response.mcp_list_tools.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress'
|
|
response.output_item.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
|
|
response.output_item.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
|
|
response.output_text.annotation.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded'
|
|
response.output_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
|
|
response.output_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone'
|
|
response.reasoning_summary_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded'
|
|
response.reasoning_summary_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone'
|
|
response.reasoning_summary_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta'
|
|
response.reasoning_summary_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone'
|
|
response.reasoning_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta'
|
|
response.reasoning_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone'
|
|
response.refusal.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta'
|
|
response.refusal.done: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone'
|
|
response.web_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted'
|
|
response.web_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress'
|
|
response.web_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
|
|
title: OpenAIResponseObjectStreamResponseCreated
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
|
|
title: OpenAIResponseObjectStreamResponseInProgress
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
|
|
title: OpenAIResponseObjectStreamResponseOutputItemAdded
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
|
|
title: OpenAIResponseObjectStreamResponseOutputItemDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
|
|
title: OpenAIResponseObjectStreamResponseOutputTextDelta
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone'
|
|
title: OpenAIResponseObjectStreamResponseOutputTextDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta'
|
|
title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone'
|
|
title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress'
|
|
title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching'
|
|
title: OpenAIResponseObjectStreamResponseWebSearchCallSearching
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted'
|
|
title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress'
|
|
title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed'
|
|
title: OpenAIResponseObjectStreamResponseMcpListToolsFailed
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted'
|
|
title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta'
|
|
title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone'
|
|
title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress'
|
|
title: OpenAIResponseObjectStreamResponseMcpCallInProgress
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed'
|
|
title: OpenAIResponseObjectStreamResponseMcpCallFailed
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
|
|
title: OpenAIResponseObjectStreamResponseMcpCallCompleted
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
|
|
title: OpenAIResponseObjectStreamResponseContentPartAdded
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
|
|
title: OpenAIResponseObjectStreamResponseContentPartDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta'
|
|
title: OpenAIResponseObjectStreamResponseReasoningTextDelta
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone'
|
|
title: OpenAIResponseObjectStreamResponseReasoningTextDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded'
|
|
title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone'
|
|
title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta'
|
|
title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone'
|
|
title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta'
|
|
title: OpenAIResponseObjectStreamResponseRefusalDelta
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone'
|
|
title: OpenAIResponseObjectStreamResponseRefusalDone
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded'
|
|
title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress'
|
|
title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching'
|
|
title: OpenAIResponseObjectStreamResponseFileSearchCallSearching
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted'
|
|
title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
|
|
title: OpenAIResponseObjectStreamResponseIncomplete
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
|
|
title: OpenAIResponseObjectStreamResponseFailed
|
|
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
|
|
title: OpenAIResponseObjectStreamResponseCompleted
|
|
title: OpenAIResponseObjectStreamResponseCreated | ... (36 variants)
|
|
OpenAIResponseObjectStreamResponseCompleted:
|
|
description: Streaming event indicating a response has been completed.
|
|
properties:
|
|
response:
|
|
$ref: '#/components/schemas/OpenAIResponseObject'
|
|
type:
|
|
const: response.completed
|
|
default: response.completed
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- response
|
|
title: OpenAIResponseObjectStreamResponseCompleted
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseContentPartAdded:
|
|
description: Streaming event for when a new content part is added to a response item.
|
|
properties:
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
response_id:
|
|
title: Response Id
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
part:
|
|
discriminator:
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
|
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
|
title: OpenAIResponseContentPartOutputText
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseContentPartRefusal
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
|
title: OpenAIResponseContentPartReasoningText
|
|
title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.content_part.added
|
|
default: response.content_part.added
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- content_index
|
|
- response_id
|
|
- item_id
|
|
- output_index
|
|
- part
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseContentPartAdded
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseContentPartDone:
|
|
description: Streaming event for when a content part is completed.
|
|
properties:
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
response_id:
|
|
title: Response Id
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
part:
|
|
discriminator:
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
|
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
|
title: OpenAIResponseContentPartOutputText
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseContentPartRefusal
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
|
title: OpenAIResponseContentPartReasoningText
|
|
title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.content_part.done
|
|
default: response.content_part.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- content_index
|
|
- response_id
|
|
- item_id
|
|
- output_index
|
|
- part
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseContentPartDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseCreated:
|
|
description: Streaming event indicating a new response has been created.
|
|
properties:
|
|
response:
|
|
$ref: '#/components/schemas/OpenAIResponseObject'
|
|
type:
|
|
const: response.created
|
|
default: response.created
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- response
|
|
title: OpenAIResponseObjectStreamResponseCreated
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseFailed:
|
|
description: Streaming event emitted when a response fails.
|
|
properties:
|
|
response:
|
|
$ref: '#/components/schemas/OpenAIResponseObject'
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.failed
|
|
default: response.failed
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- response
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseFailed
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseFileSearchCallCompleted:
|
|
description: Streaming event for completed file search calls.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.file_search_call.completed
|
|
default: response.file_search_call.completed
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseFileSearchCallInProgress:
|
|
description: Streaming event for file search calls in progress.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.file_search_call.in_progress
|
|
default: response.file_search_call.in_progress
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseFileSearchCallSearching:
|
|
description: Streaming event for file search currently searching.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.file_search_call.searching
|
|
default: response.file_search_call.searching
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseFileSearchCallSearching
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta:
|
|
description: Streaming event for incremental function call argument updates.
|
|
properties:
|
|
delta:
|
|
title: Delta
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.function_call_arguments.delta
|
|
default: response.function_call_arguments.delta
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- delta
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone:
|
|
description: Streaming event for when function call arguments are completed.
|
|
properties:
|
|
arguments:
|
|
title: Arguments
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.function_call_arguments.done
|
|
default: response.function_call_arguments.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- arguments
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseInProgress:
|
|
description: Streaming event indicating the response remains in progress.
|
|
properties:
|
|
response:
|
|
$ref: '#/components/schemas/OpenAIResponseObject'
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.in_progress
|
|
default: response.in_progress
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- response
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseInProgress
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseIncomplete:
|
|
description: Streaming event emitted when a response ends in an incomplete state.
|
|
properties:
|
|
response:
|
|
$ref: '#/components/schemas/OpenAIResponseObject'
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.incomplete
|
|
default: response.incomplete
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- response
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseIncomplete
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta:
|
|
properties:
|
|
delta:
|
|
title: Delta
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.mcp_call.arguments.delta
|
|
default: response.mcp_call.arguments.delta
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- delta
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseMcpCallArgumentsDone:
|
|
properties:
|
|
arguments:
|
|
title: Arguments
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.mcp_call.arguments.done
|
|
default: response.mcp_call.arguments.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- arguments
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseMcpCallCompleted:
|
|
description: Streaming event for completed MCP calls.
|
|
properties:
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.mcp_call.completed
|
|
default: response.mcp_call.completed
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseMcpCallCompleted
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseMcpCallFailed:
|
|
description: Streaming event for failed MCP calls.
|
|
properties:
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.mcp_call.failed
|
|
default: response.mcp_call.failed
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseMcpCallFailed
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseMcpCallInProgress:
|
|
description: Streaming event for MCP calls in progress.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.mcp_call.in_progress
|
|
default: response.mcp_call.in_progress
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseMcpCallInProgress
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseMcpListToolsCompleted:
|
|
properties:
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.mcp_list_tools.completed
|
|
default: response.mcp_list_tools.completed
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseMcpListToolsFailed:
|
|
properties:
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.mcp_list_tools.failed
|
|
default: response.mcp_list_tools.failed
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseMcpListToolsFailed
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseMcpListToolsInProgress:
|
|
properties:
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.mcp_list_tools.in_progress
|
|
default: response.mcp_list_tools.in_progress
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseOutputItemAdded:
|
|
description: Streaming event for when a new output item is added to the response.
|
|
properties:
|
|
response_id:
|
|
title: Response Id
|
|
type: string
|
|
item:
|
|
discriminator:
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage'
|
|
title: OpenAIResponseMessage
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
title: OpenAIResponseMessage | ... (7 variants)
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.output_item.added
|
|
default: response.output_item.added
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- response_id
|
|
- item
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseOutputItemAdded
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseOutputItemDone:
|
|
description: Streaming event for when an output item is completed.
|
|
properties:
|
|
response_id:
|
|
title: Response Id
|
|
type: string
|
|
item:
|
|
discriminator:
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage'
|
|
title: OpenAIResponseMessage
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
title: OpenAIResponseMessage | ... (7 variants)
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.output_item.done
|
|
default: response.output_item.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- response_id
|
|
- item
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseOutputItemDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded:
|
|
description: Streaming event for when an annotation is added to output text.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
annotation_index:
|
|
title: Annotation Index
|
|
type: integer
|
|
annotation:
|
|
discriminator:
|
|
mapping:
|
|
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
|
|
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
|
|
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
|
|
title: OpenAIResponseAnnotationFileCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
title: OpenAIResponseAnnotationCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
title: OpenAIResponseAnnotationContainerFileCitation
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
|
|
title: OpenAIResponseAnnotationFilePath
|
|
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.output_text.annotation.added
|
|
default: response.output_text.annotation.added
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- content_index
|
|
- annotation_index
|
|
- annotation
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseOutputTextDelta:
|
|
description: Streaming event for incremental text content updates.
|
|
properties:
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
delta:
|
|
title: Delta
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.output_text.delta
|
|
default: response.output_text.delta
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- content_index
|
|
- delta
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseOutputTextDelta
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseOutputTextDone:
|
|
description: Streaming event for when text output is completed.
|
|
properties:
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
text:
|
|
title: Text
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.output_text.done
|
|
default: response.output_text.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- content_index
|
|
- text
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseOutputTextDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded:
|
|
description: Streaming event for when a new reasoning summary part is added.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
part:
|
|
$ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary'
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
summary_index:
|
|
title: Summary Index
|
|
type: integer
|
|
type:
|
|
const: response.reasoning_summary_part.added
|
|
default: response.reasoning_summary_part.added
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- part
|
|
- sequence_number
|
|
- summary_index
|
|
title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseReasoningSummaryPartDone:
|
|
description: Streaming event for when a reasoning summary part is completed.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
part:
|
|
$ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary'
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
summary_index:
|
|
title: Summary Index
|
|
type: integer
|
|
type:
|
|
const: response.reasoning_summary_part.done
|
|
default: response.reasoning_summary_part.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- part
|
|
- sequence_number
|
|
- summary_index
|
|
title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta:
|
|
description: Streaming event for incremental reasoning summary text updates.
|
|
properties:
|
|
delta:
|
|
title: Delta
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
summary_index:
|
|
title: Summary Index
|
|
type: integer
|
|
type:
|
|
const: response.reasoning_summary_text.delta
|
|
default: response.reasoning_summary_text.delta
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- delta
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
- summary_index
|
|
title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseReasoningSummaryTextDone:
|
|
description: Streaming event for when reasoning summary text is completed.
|
|
properties:
|
|
text:
|
|
title: Text
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
summary_index:
|
|
title: Summary Index
|
|
type: integer
|
|
type:
|
|
const: response.reasoning_summary_text.done
|
|
default: response.reasoning_summary_text.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- text
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
- summary_index
|
|
title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseReasoningTextDelta:
|
|
description: Streaming event for incremental reasoning text updates.
|
|
properties:
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
delta:
|
|
title: Delta
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.reasoning_text.delta
|
|
default: response.reasoning_text.delta
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- content_index
|
|
- delta
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseReasoningTextDelta
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseReasoningTextDone:
|
|
description: Streaming event for when reasoning text is completed.
|
|
properties:
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
text:
|
|
title: Text
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.reasoning_text.done
|
|
default: response.reasoning_text.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- content_index
|
|
- text
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseReasoningTextDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseRefusalDelta:
|
|
description: Streaming event for incremental refusal text updates.
|
|
properties:
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
delta:
|
|
title: Delta
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.refusal.delta
|
|
default: response.refusal.delta
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- content_index
|
|
- delta
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseRefusalDelta
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseRefusalDone:
|
|
description: Streaming event for when refusal text is completed.
|
|
properties:
|
|
content_index:
|
|
title: Content Index
|
|
type: integer
|
|
refusal:
|
|
title: Refusal
|
|
type: string
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.refusal.done
|
|
default: response.refusal.done
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- content_index
|
|
- refusal
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseRefusalDone
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseWebSearchCallCompleted:
|
|
description: Streaming event for completed web search calls.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.web_search_call.completed
|
|
default: response.web_search_call.completed
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseWebSearchCallInProgress:
|
|
description: Streaming event for web search calls in progress.
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.web_search_call.in_progress
|
|
default: response.web_search_call.in_progress
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress
|
|
type: object
|
|
OpenAIResponseObjectStreamResponseWebSearchCallSearching:
|
|
properties:
|
|
item_id:
|
|
title: Item Id
|
|
type: string
|
|
output_index:
|
|
title: Output Index
|
|
type: integer
|
|
sequence_number:
|
|
title: Sequence Number
|
|
type: integer
|
|
type:
|
|
const: response.web_search_call.searching
|
|
default: response.web_search_call.searching
|
|
title: Type
|
|
type: string
|
|
required:
|
|
- item_id
|
|
- output_index
|
|
- sequence_number
|
|
title: OpenAIResponseObjectStreamResponseWebSearchCallSearching
|
|
type: object
|
|
OpenAIDeleteResponseObject:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
object:
|
|
type: string
|
|
const: response
|
|
title: Object
|
|
default: response
|
|
deleted:
|
|
type: boolean
|
|
title: Deleted
|
|
default: true
|
|
type: object
|
|
required:
|
|
- id
|
|
title: OpenAIDeleteResponseObject
|
|
description: Response object confirming deletion of an OpenAI response.
|
|
ListOpenAIResponseInputItem:
|
|
properties:
|
|
data:
|
|
items:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
title: OpenAIResponseMessage-Output
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseMessage-Output | ... (7 variants)
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
title: OpenAIResponseMessage-Output
|
|
title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output
|
|
type: array
|
|
title: Data
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
default: list
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListOpenAIResponseInputItem
|
|
description: List container for OpenAI response input items.
|
|
RunShieldRequest:
|
|
properties:
|
|
shield_id:
|
|
type: string
|
|
title: Shield Id
|
|
messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIUserMessageParam-Input'
|
|
title: OpenAIUserMessageParam-Input
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
title: OpenAISystemMessageParam
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input'
|
|
title: OpenAIAssistantMessageParam-Input
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
title: OpenAIToolMessageParam
|
|
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
title: OpenAIDeveloperMessageParam
|
|
discriminator:
|
|
propertyName: role
|
|
mapping:
|
|
assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input'
|
|
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
system: '#/components/schemas/OpenAISystemMessageParam'
|
|
tool: '#/components/schemas/OpenAIToolMessageParam'
|
|
user: '#/components/schemas/OpenAIUserMessageParam-Input'
|
|
title: OpenAIUserMessageParam-Input | ... (5 variants)
|
|
type: array
|
|
title: Messages
|
|
params:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Params
|
|
type: object
|
|
required:
|
|
- shield_id
|
|
- messages
|
|
- params
|
|
title: RunShieldRequest
|
|
RunShieldResponse:
|
|
properties:
|
|
violation:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/SafetyViolation'
|
|
title: SafetyViolation
|
|
- type: 'null'
|
|
title: SafetyViolation
|
|
type: object
|
|
title: RunShieldResponse
|
|
description: Response from running a safety shield.
|
|
SafetyViolation:
|
|
properties:
|
|
violation_level:
|
|
$ref: '#/components/schemas/ViolationLevel'
|
|
user_message:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
type: object
|
|
required:
|
|
- violation_level
|
|
title: SafetyViolation
|
|
description: Details of a safety violation detected by content moderation.
|
|
ViolationLevel:
|
|
type: string
|
|
enum:
|
|
- info
|
|
- warn
|
|
- error
|
|
title: ViolationLevel
|
|
description: Severity level of a safety violation.
|
|
AggregationFunctionType:
|
|
type: string
|
|
enum:
|
|
- average
|
|
- weighted_average
|
|
- median
|
|
- categorical_count
|
|
- accuracy
|
|
title: AggregationFunctionType
|
|
description: Types of aggregation functions for scoring results.
|
|
ArrayType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: array
|
|
title: Type
|
|
default: array
|
|
type: object
|
|
title: ArrayType
|
|
description: Parameter type for array values.
|
|
BasicScoringFnParams:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: basic
|
|
title: Type
|
|
default: basic
|
|
aggregation_functions:
|
|
items:
|
|
$ref: '#/components/schemas/AggregationFunctionType'
|
|
type: array
|
|
title: Aggregation Functions
|
|
description: Aggregation functions to apply to the scores of each row
|
|
type: object
|
|
title: BasicScoringFnParams
|
|
description: Parameters for basic scoring function configuration.
|
|
BooleanType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: boolean
|
|
title: Type
|
|
default: boolean
|
|
type: object
|
|
title: BooleanType
|
|
description: Parameter type for boolean values.
|
|
ChatCompletionInputType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: chat_completion_input
|
|
title: Type
|
|
default: chat_completion_input
|
|
type: object
|
|
title: ChatCompletionInputType
|
|
description: Parameter type for chat completion input.
|
|
CompletionInputType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: completion_input
|
|
title: Type
|
|
default: completion_input
|
|
type: object
|
|
title: CompletionInputType
|
|
description: Parameter type for completion input.
|
|
JsonType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: json
|
|
title: Type
|
|
default: json
|
|
type: object
|
|
title: JsonType
|
|
description: Parameter type for JSON values.
|
|
LLMAsJudgeScoringFnParams:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: llm_as_judge
|
|
title: Type
|
|
default: llm_as_judge
|
|
judge_model:
|
|
type: string
|
|
title: Judge Model
|
|
prompt_template:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
judge_score_regexes:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Judge Score Regexes
|
|
description: Regexes to extract the answer from generated response
|
|
aggregation_functions:
|
|
items:
|
|
$ref: '#/components/schemas/AggregationFunctionType'
|
|
type: array
|
|
title: Aggregation Functions
|
|
description: Aggregation functions to apply to the scores of each row
|
|
type: object
|
|
required:
|
|
- judge_model
|
|
title: LLMAsJudgeScoringFnParams
|
|
description: Parameters for LLM-as-judge scoring function configuration.
|
|
NumberType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: number
|
|
title: Type
|
|
default: number
|
|
type: object
|
|
title: NumberType
|
|
description: Parameter type for numeric values.
|
|
ObjectType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: object
|
|
title: Type
|
|
default: object
|
|
type: object
|
|
title: ObjectType
|
|
description: Parameter type for object values.
|
|
RegexParserScoringFnParams:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: regex_parser
|
|
title: Type
|
|
default: regex_parser
|
|
parsing_regexes:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Parsing Regexes
|
|
description: Regex to extract the answer from generated response
|
|
aggregation_functions:
|
|
items:
|
|
$ref: '#/components/schemas/AggregationFunctionType'
|
|
type: array
|
|
title: Aggregation Functions
|
|
description: Aggregation functions to apply to the scores of each row
|
|
type: object
|
|
title: RegexParserScoringFnParams
|
|
description: Parameters for regex parser scoring function configuration.
|
|
ScoringFn:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
description: Unique identifier for this resource in llama stack
|
|
provider_resource_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Unique identifier for this resource in the provider
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
description: ID of the provider that owns this resource
|
|
type:
|
|
type: string
|
|
const: scoring_function
|
|
title: Type
|
|
default: scoring_function
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
description: Any additional metadata for this definition
|
|
return_type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/StringType'
|
|
title: StringType
|
|
- $ref: '#/components/schemas/NumberType'
|
|
title: NumberType
|
|
- $ref: '#/components/schemas/BooleanType'
|
|
title: BooleanType
|
|
- $ref: '#/components/schemas/ArrayType'
|
|
title: ArrayType
|
|
- $ref: '#/components/schemas/ObjectType'
|
|
title: ObjectType
|
|
- $ref: '#/components/schemas/JsonType'
|
|
title: JsonType
|
|
- $ref: '#/components/schemas/UnionType'
|
|
title: UnionType
|
|
- $ref: '#/components/schemas/ChatCompletionInputType'
|
|
title: ChatCompletionInputType
|
|
- $ref: '#/components/schemas/CompletionInputType'
|
|
title: CompletionInputType
|
|
title: StringType | ... (9 variants)
|
|
description: The return type of the deterministic function
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
array: '#/components/schemas/ArrayType'
|
|
boolean: '#/components/schemas/BooleanType'
|
|
chat_completion_input: '#/components/schemas/ChatCompletionInputType'
|
|
completion_input: '#/components/schemas/CompletionInputType'
|
|
json: '#/components/schemas/JsonType'
|
|
number: '#/components/schemas/NumberType'
|
|
object: '#/components/schemas/ObjectType'
|
|
string: '#/components/schemas/StringType'
|
|
union: '#/components/schemas/UnionType'
|
|
params:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: RegexParserScoringFnParams
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
title: BasicScoringFnParams
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams
|
|
- type: 'null'
|
|
title: Params
|
|
description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval
|
|
type: object
|
|
required:
|
|
- identifier
|
|
- provider_id
|
|
- return_type
|
|
title: ScoringFn
|
|
description: A scoring function resource for evaluating model outputs.
|
|
ScoringFnParams:
|
|
discriminator:
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: RegexParserScoringFnParams
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
title: BasicScoringFnParams
|
|
title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams
|
|
ScoringFnParamsType:
|
|
description: Types of scoring function parameter configurations.
|
|
enum:
|
|
- llm_as_judge
|
|
- regex_parser
|
|
- basic
|
|
title: ScoringFnParamsType
|
|
type: string
|
|
StringType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: string
|
|
title: Type
|
|
default: string
|
|
type: object
|
|
title: StringType
|
|
description: Parameter type for string values.
|
|
UnionType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: union
|
|
title: Type
|
|
default: union
|
|
type: object
|
|
title: UnionType
|
|
description: Parameter type for union values.
|
|
ListScoringFunctionsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/ScoringFn'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListScoringFunctionsResponse
|
|
ScoreRequest:
|
|
properties:
|
|
input_rows:
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
title: Input Rows
|
|
scoring_functions:
|
|
additionalProperties:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: RegexParserScoringFnParams
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
title: BasicScoringFnParams
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams
|
|
- type: 'null'
|
|
title: AdditionalpropertiesUnion
|
|
type: object
|
|
title: Scoring Functions
|
|
type: object
|
|
required:
|
|
- input_rows
|
|
- scoring_functions
|
|
title: ScoreRequest
|
|
ScoreResponse:
|
|
properties:
|
|
results:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ScoringResult'
|
|
type: object
|
|
title: Results
|
|
type: object
|
|
required:
|
|
- results
|
|
title: ScoreResponse
|
|
description: The response from scoring.
|
|
ScoringResult:
|
|
properties:
|
|
score_rows:
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
title: Score Rows
|
|
aggregated_results:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Aggregated Results
|
|
type: object
|
|
required:
|
|
- score_rows
|
|
- aggregated_results
|
|
title: ScoringResult
|
|
description: A scoring result for a single row.
|
|
ScoreBatchRequest:
|
|
properties:
|
|
dataset_id:
|
|
type: string
|
|
title: Dataset Id
|
|
scoring_functions:
|
|
additionalProperties:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: RegexParserScoringFnParams
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
title: BasicScoringFnParams
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams
|
|
- type: 'null'
|
|
title: AdditionalpropertiesUnion
|
|
type: object
|
|
title: Scoring Functions
|
|
save_results_dataset:
|
|
type: boolean
|
|
title: Save Results Dataset
|
|
default: false
|
|
type: object
|
|
required:
|
|
- dataset_id
|
|
- scoring_functions
|
|
title: ScoreBatchRequest
|
|
ScoreBatchResponse:
|
|
properties:
|
|
dataset_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
results:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ScoringResult'
|
|
type: object
|
|
title: Results
|
|
type: object
|
|
required:
|
|
- results
|
|
title: ScoreBatchResponse
|
|
description: Response from batch scoring operations on datasets.
|
|
Shield:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
description: Unique identifier for this resource in llama stack
|
|
provider_resource_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Unique identifier for this resource in the provider
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
description: ID of the provider that owns this resource
|
|
type:
|
|
type: string
|
|
const: shield
|
|
title: Type
|
|
default: shield
|
|
params:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- identifier
|
|
- provider_id
|
|
title: Shield
|
|
description: A safety shield resource that can be used to check content.
|
|
ListShieldsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Shield'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListShieldsResponse
|
|
InvokeToolRequest:
|
|
properties:
|
|
tool_name:
|
|
type: string
|
|
title: Tool Name
|
|
kwargs:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Kwargs
|
|
authorization:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- tool_name
|
|
- kwargs
|
|
title: InvokeToolRequest
|
|
ImageContentItem:
|
|
description: A image content item
|
|
properties:
|
|
type:
|
|
const: image
|
|
default: image
|
|
title: Type
|
|
type: string
|
|
image:
|
|
$ref: '#/components/schemas/_URLOrData'
|
|
required:
|
|
- image
|
|
title: ImageContentItem
|
|
type: object
|
|
InterleavedContent:
|
|
anyOf:
|
|
- type: string
|
|
- discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
- items:
|
|
discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem | TextContentItem]
|
|
title: string | list[ImageContentItem | TextContentItem]
|
|
InterleavedContentItem:
|
|
discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
TextContentItem:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: text
|
|
title: Type
|
|
default: text
|
|
text:
|
|
type: string
|
|
title: Text
|
|
type: object
|
|
required:
|
|
- text
|
|
title: TextContentItem
|
|
description: A text content item
|
|
ToolInvocationResult:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Output'
|
|
title: ImageContentItem-Output
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Output | TextContentItem
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Output'
|
|
title: ImageContentItem-Output
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Output | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem-Output | TextContentItem]
|
|
- type: 'null'
|
|
title: string | list[ImageContentItem-Output | TextContentItem]
|
|
error_message:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
error_code:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
title: ToolInvocationResult
|
|
description: Result of a tool invocation.
|
|
URL:
|
|
properties:
|
|
uri:
|
|
type: string
|
|
title: Uri
|
|
type: object
|
|
required:
|
|
- uri
|
|
title: URL
|
|
description: A URL reference to external content.
|
|
ToolDef:
|
|
properties:
|
|
toolgroup_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
input_schema:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
output_schema:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- name
|
|
title: ToolDef
|
|
description: Tool definition used in runtime contexts.
|
|
ListToolDefsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/ToolDef'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListToolDefsResponse
|
|
description: Response containing a list of tool definitions.
|
|
ToolGroup:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
description: Unique identifier for this resource in llama stack
|
|
provider_resource_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Unique identifier for this resource in the provider
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
description: ID of the provider that owns this resource
|
|
type:
|
|
type: string
|
|
const: tool_group
|
|
title: Type
|
|
default: tool_group
|
|
mcp_endpoint:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/URL'
|
|
title: URL
|
|
- type: 'null'
|
|
title: URL
|
|
args:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- identifier
|
|
- provider_id
|
|
title: ToolGroup
|
|
description: A group of related tools managed together.
|
|
ListToolGroupsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/ToolGroup'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListToolGroupsResponse
|
|
description: Response containing a list of tool groups.
|
|
Chunk:
|
|
description: A chunk of content that can be inserted into a vector database.
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
- items:
|
|
discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem | TextContentItem]
|
|
title: string | list[ImageContentItem | TextContentItem]
|
|
chunk_id:
|
|
title: Chunk Id
|
|
type: string
|
|
metadata:
|
|
additionalProperties: true
|
|
title: Metadata
|
|
type: object
|
|
embedding:
|
|
anyOf:
|
|
- items:
|
|
type: number
|
|
type: array
|
|
- type: 'null'
|
|
nullable: true
|
|
chunk_metadata:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ChunkMetadata'
|
|
title: ChunkMetadata
|
|
- type: 'null'
|
|
nullable: true
|
|
title: ChunkMetadata
|
|
required:
|
|
- content
|
|
- chunk_id
|
|
title: Chunk
|
|
type: object
|
|
ChunkMetadata:
|
|
properties:
|
|
chunk_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
document_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
source:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
created_timestamp:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
updated_timestamp:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
chunk_window:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
chunk_tokenizer:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
chunk_embedding_model:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
chunk_embedding_dimension:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
content_token_count:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
metadata_token_count:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
title: ChunkMetadata
|
|
description: |-
|
|
`ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that
|
|
will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata`
|
|
is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after.
|
|
Use `Chunk.metadata` for metadata that will be used in the context during inference.
|
|
InsertChunksRequest:
|
|
properties:
|
|
vector_store_id:
|
|
type: string
|
|
title: Vector Store Id
|
|
chunks:
|
|
items:
|
|
$ref: '#/components/schemas/Chunk-Input'
|
|
type: array
|
|
title: Chunks
|
|
ttl_seconds:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- vector_store_id
|
|
- chunks
|
|
title: InsertChunksRequest
|
|
QueryChunksRequest:
|
|
properties:
|
|
vector_store_id:
|
|
type: string
|
|
title: Vector Store Id
|
|
query:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
title: ImageContentItem-Input
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Input | TextContentItem
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
title: ImageContentItem-Input
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Input | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem-Input | TextContentItem]
|
|
title: string | list[ImageContentItem-Input | TextContentItem]
|
|
params:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- vector_store_id
|
|
- query
|
|
title: QueryChunksRequest
|
|
QueryChunksResponse:
|
|
properties:
|
|
chunks:
|
|
items:
|
|
$ref: '#/components/schemas/Chunk-Output'
|
|
type: array
|
|
title: Chunks
|
|
scores:
|
|
items:
|
|
type: number
|
|
type: array
|
|
title: Scores
|
|
type: object
|
|
required:
|
|
- chunks
|
|
- scores
|
|
title: QueryChunksResponse
|
|
description: Response from querying chunks in a vector database.
|
|
VectorStoreFileCounts:
|
|
properties:
|
|
completed:
|
|
type: integer
|
|
title: Completed
|
|
cancelled:
|
|
type: integer
|
|
title: Cancelled
|
|
failed:
|
|
type: integer
|
|
title: Failed
|
|
in_progress:
|
|
type: integer
|
|
title: In Progress
|
|
total:
|
|
type: integer
|
|
title: Total
|
|
type: object
|
|
required:
|
|
- completed
|
|
- cancelled
|
|
- failed
|
|
- in_progress
|
|
- total
|
|
title: VectorStoreFileCounts
|
|
description: File processing status counts for a vector store.
|
|
VectorStoreListResponse:
|
|
properties:
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: list
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/VectorStoreObject'
|
|
type: array
|
|
title: Data
|
|
first_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
default: false
|
|
type: object
|
|
required:
|
|
- data
|
|
title: VectorStoreListResponse
|
|
description: Response from listing vector stores.
|
|
VectorStoreObject:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: vector_store
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
usage_bytes:
|
|
type: integer
|
|
title: Usage Bytes
|
|
default: 0
|
|
file_counts:
|
|
$ref: '#/components/schemas/VectorStoreFileCounts'
|
|
status:
|
|
type: string
|
|
title: Status
|
|
default: completed
|
|
expires_after:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
expires_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
last_active_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
type: object
|
|
required:
|
|
- id
|
|
- created_at
|
|
- file_counts
|
|
title: VectorStoreObject
|
|
description: OpenAI Vector Store object.
|
|
VectorStoreChunkingStrategy:
|
|
discriminator:
|
|
mapping:
|
|
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
title: VectorStoreChunkingStrategyAuto
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: VectorStoreChunkingStrategyStatic
|
|
title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic
|
|
VectorStoreChunkingStrategyAuto:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: auto
|
|
title: Type
|
|
default: auto
|
|
type: object
|
|
title: VectorStoreChunkingStrategyAuto
|
|
description: Automatic chunking strategy for vector store files.
|
|
VectorStoreChunkingStrategyStatic:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: static
|
|
title: Type
|
|
default: static
|
|
static:
|
|
$ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig'
|
|
type: object
|
|
required:
|
|
- static
|
|
title: VectorStoreChunkingStrategyStatic
|
|
description: Static chunking strategy with configurable parameters.
|
|
VectorStoreChunkingStrategyStaticConfig:
|
|
properties:
|
|
chunk_overlap_tokens:
|
|
type: integer
|
|
title: Chunk Overlap Tokens
|
|
default: 400
|
|
max_chunk_size_tokens:
|
|
type: integer
|
|
maximum: 4096.0
|
|
minimum: 100.0
|
|
title: Max Chunk Size Tokens
|
|
default: 800
|
|
type: object
|
|
title: VectorStoreChunkingStrategyStaticConfig
|
|
description: Configuration for static chunking strategy.
|
|
OpenAICreateVectorStoreRequestWithExtraBody:
|
|
properties:
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
file_ids:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
expires_after:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
chunking_strategy:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
title: VectorStoreChunkingStrategyAuto
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: VectorStoreChunkingStrategyStatic
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic
|
|
- type: 'null'
|
|
title: Chunking Strategy
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
additionalProperties: true
|
|
type: object
|
|
title: OpenAICreateVectorStoreRequestWithExtraBody
|
|
description: Request to create a vector store with extra_body support.
|
|
OpenaiUpdateVectorStoreRequest:
|
|
properties:
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
expires_after:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenaiUpdateVectorStoreRequest
|
|
VectorStoreDeleteResponse:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: vector_store.deleted
|
|
deleted:
|
|
type: boolean
|
|
title: Deleted
|
|
default: true
|
|
type: object
|
|
required:
|
|
- id
|
|
title: VectorStoreDeleteResponse
|
|
description: Response from deleting a vector store.
|
|
OpenAICreateVectorStoreFileBatchRequestWithExtraBody:
|
|
properties:
|
|
file_ids:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: File Ids
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
chunking_strategy:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
title: VectorStoreChunkingStrategyAuto
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: VectorStoreChunkingStrategyStatic
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic
|
|
- type: 'null'
|
|
title: Chunking Strategy
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- file_ids
|
|
title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody
|
|
description: Request to create a vector store file batch with extra_body support.
|
|
VectorStoreFileBatchObject:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: vector_store.file_batch
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
vector_store_id:
|
|
type: string
|
|
title: Vector Store Id
|
|
status:
|
|
title: Status
|
|
type: string
|
|
enum:
|
|
- completed
|
|
- in_progress
|
|
- cancelled
|
|
- failed
|
|
default: completed
|
|
file_counts:
|
|
$ref: '#/components/schemas/VectorStoreFileCounts'
|
|
type: object
|
|
required:
|
|
- id
|
|
- created_at
|
|
- vector_store_id
|
|
- status
|
|
- file_counts
|
|
title: VectorStoreFileBatchObject
|
|
description: OpenAI Vector Store File Batch object.
|
|
VectorStoreFileStatus:
|
|
type: string
|
|
enum:
|
|
- completed
|
|
- in_progress
|
|
- cancelled
|
|
- failed
|
|
default: completed
|
|
VectorStoreFileLastError:
|
|
properties:
|
|
code:
|
|
title: Code
|
|
type: string
|
|
enum:
|
|
- server_error
|
|
- rate_limit_exceeded
|
|
default: server_error
|
|
message:
|
|
type: string
|
|
title: Message
|
|
type: object
|
|
required:
|
|
- code
|
|
- message
|
|
title: VectorStoreFileLastError
|
|
description: Error information for failed vector store file processing.
|
|
VectorStoreFileObject:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: vector_store.file
|
|
attributes:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Attributes
|
|
chunking_strategy:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
title: VectorStoreChunkingStrategyAuto
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: VectorStoreChunkingStrategyStatic
|
|
title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
last_error:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/VectorStoreFileLastError'
|
|
title: VectorStoreFileLastError
|
|
- type: 'null'
|
|
title: VectorStoreFileLastError
|
|
status:
|
|
title: Status
|
|
type: string
|
|
enum:
|
|
- completed
|
|
- in_progress
|
|
- cancelled
|
|
- failed
|
|
default: completed
|
|
usage_bytes:
|
|
type: integer
|
|
title: Usage Bytes
|
|
default: 0
|
|
vector_store_id:
|
|
type: string
|
|
title: Vector Store Id
|
|
type: object
|
|
required:
|
|
- id
|
|
- chunking_strategy
|
|
- created_at
|
|
- status
|
|
- vector_store_id
|
|
title: VectorStoreFileObject
|
|
description: OpenAI Vector Store File object.
|
|
VectorStoreFilesListInBatchResponse:
|
|
properties:
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: list
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/VectorStoreFileObject'
|
|
type: array
|
|
title: Data
|
|
first_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
default: false
|
|
type: object
|
|
required:
|
|
- data
|
|
title: VectorStoreFilesListInBatchResponse
|
|
description: Response from listing files in a vector store file batch.
|
|
VectorStoreListFilesResponse:
|
|
properties:
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: list
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/VectorStoreFileObject'
|
|
type: array
|
|
title: Data
|
|
first_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
default: false
|
|
type: object
|
|
required:
|
|
- data
|
|
title: VectorStoreListFilesResponse
|
|
description: Response from listing files in a vector store.
|
|
OpenaiAttachFileToVectorStoreRequest:
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
chunking_strategy:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
title: VectorStoreChunkingStrategyAuto
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: VectorStoreChunkingStrategyStatic
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic
|
|
- type: 'null'
|
|
title: Chunking Strategy
|
|
type: object
|
|
required:
|
|
- file_id
|
|
title: OpenaiAttachFileToVectorStoreRequest
|
|
OpenaiUpdateVectorStoreFileRequest:
|
|
properties:
|
|
attributes:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Attributes
|
|
type: object
|
|
required:
|
|
- attributes
|
|
title: OpenaiUpdateVectorStoreFileRequest
|
|
VectorStoreFileDeleteResponse:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: vector_store.file.deleted
|
|
deleted:
|
|
type: boolean
|
|
title: Deleted
|
|
default: true
|
|
type: object
|
|
required:
|
|
- id
|
|
title: VectorStoreFileDeleteResponse
|
|
description: Response from deleting a vector store file.
|
|
VectorStoreContent:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: text
|
|
title: Type
|
|
text:
|
|
type: string
|
|
title: Text
|
|
embedding:
|
|
anyOf:
|
|
- items:
|
|
type: number
|
|
type: array
|
|
- type: 'null'
|
|
chunk_metadata:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ChunkMetadata'
|
|
title: ChunkMetadata
|
|
- type: 'null'
|
|
title: ChunkMetadata
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- type
|
|
- text
|
|
title: VectorStoreContent
|
|
description: Content item from a vector store file or search result.
|
|
VectorStoreFileContentResponse:
|
|
properties:
|
|
object:
|
|
type: string
|
|
const: vector_store.file_content.page
|
|
title: Object
|
|
default: vector_store.file_content.page
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/VectorStoreContent'
|
|
type: array
|
|
title: Data
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
default: false
|
|
next_page:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- data
|
|
title: VectorStoreFileContentResponse
|
|
description: Represents the parsed content of a vector store file.
|
|
OpenaiSearchVectorStoreRequest:
|
|
properties:
|
|
query:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
title: string | list[string]
|
|
filters:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
max_num_results:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
default: 10
|
|
ranking_options:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/SearchRankingOptions'
|
|
title: SearchRankingOptions
|
|
- type: 'null'
|
|
title: SearchRankingOptions
|
|
rewrite_query:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
search_mode:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
default: vector
|
|
type: object
|
|
required:
|
|
- query
|
|
title: OpenaiSearchVectorStoreRequest
|
|
VectorStoreSearchResponse:
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
score:
|
|
type: number
|
|
title: Score
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties:
|
|
anyOf:
|
|
- type: string
|
|
- type: number
|
|
- type: boolean
|
|
title: string | number | boolean
|
|
type: object
|
|
- type: 'null'
|
|
content:
|
|
items:
|
|
$ref: '#/components/schemas/VectorStoreContent'
|
|
type: array
|
|
title: Content
|
|
type: object
|
|
required:
|
|
- file_id
|
|
- filename
|
|
- score
|
|
- content
|
|
title: VectorStoreSearchResponse
|
|
description: Response from searching a vector store.
|
|
VectorStoreSearchResponsePage:
|
|
properties:
|
|
object:
|
|
type: string
|
|
title: Object
|
|
default: vector_store.search_results.page
|
|
search_query:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Search Query
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/VectorStoreSearchResponse'
|
|
type: array
|
|
title: Data
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
default: false
|
|
next_page:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- search_query
|
|
- data
|
|
title: VectorStoreSearchResponsePage
|
|
description: Paginated response from searching a vector store.
|
|
VersionInfo:
|
|
properties:
|
|
version:
|
|
type: string
|
|
title: Version
|
|
type: object
|
|
required:
|
|
- version
|
|
title: VersionInfo
|
|
description: Version information for the service.
|
|
AppendRowsRequest:
|
|
properties:
|
|
rows:
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
title: Rows
|
|
type: object
|
|
required:
|
|
- rows
|
|
title: AppendRowsRequest
|
|
PaginatedResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
title: Data
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
url:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- data
|
|
- has_more
|
|
title: PaginatedResponse
|
|
description: A generic paginated response that follows a simple format.
|
|
Dataset:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
description: Unique identifier for this resource in llama stack
|
|
provider_resource_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Unique identifier for this resource in the provider
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
description: ID of the provider that owns this resource
|
|
type:
|
|
type: string
|
|
const: dataset
|
|
title: Type
|
|
default: dataset
|
|
purpose:
|
|
$ref: '#/components/schemas/DatasetPurpose'
|
|
source:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/URIDataSource'
|
|
title: URIDataSource
|
|
- $ref: '#/components/schemas/RowsDataSource'
|
|
title: RowsDataSource
|
|
title: URIDataSource | RowsDataSource
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
rows: '#/components/schemas/RowsDataSource'
|
|
uri: '#/components/schemas/URIDataSource'
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
description: Any additional metadata for this dataset
|
|
type: object
|
|
required:
|
|
- identifier
|
|
- provider_id
|
|
- purpose
|
|
- source
|
|
title: Dataset
|
|
description: Dataset resource for storing and accessing training or evaluation data.
|
|
RowsDataSource:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: rows
|
|
title: Type
|
|
default: rows
|
|
rows:
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
title: Rows
|
|
type: object
|
|
required:
|
|
- rows
|
|
title: RowsDataSource
|
|
description: A dataset stored in rows.
|
|
URIDataSource:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: uri
|
|
title: Type
|
|
default: uri
|
|
uri:
|
|
type: string
|
|
title: Uri
|
|
type: object
|
|
required:
|
|
- uri
|
|
title: URIDataSource
|
|
description: A dataset that can be obtained from a URI.
|
|
ListDatasetsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Dataset'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListDatasetsResponse
|
|
description: Response from listing datasets.
|
|
Benchmark:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
description: Unique identifier for this resource in llama stack
|
|
provider_resource_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Unique identifier for this resource in the provider
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
description: ID of the provider that owns this resource
|
|
type:
|
|
type: string
|
|
const: benchmark
|
|
title: Type
|
|
default: benchmark
|
|
dataset_id:
|
|
type: string
|
|
title: Dataset Id
|
|
scoring_functions:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Scoring Functions
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
description: Metadata for this evaluation task
|
|
type: object
|
|
required:
|
|
- identifier
|
|
- provider_id
|
|
- dataset_id
|
|
- scoring_functions
|
|
title: Benchmark
|
|
description: A benchmark resource for evaluating model performance.
|
|
ListBenchmarksResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Benchmark'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListBenchmarksResponse
|
|
BenchmarkConfig:
|
|
properties:
|
|
eval_candidate:
|
|
$ref: '#/components/schemas/ModelCandidate'
|
|
scoring_params:
|
|
additionalProperties:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: RegexParserScoringFnParams
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
title: BasicScoringFnParams
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams
|
|
type: object
|
|
title: Scoring Params
|
|
description: Map between scoring function id and parameters for each scoring function you want to run
|
|
num_examples:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated
|
|
type: object
|
|
required:
|
|
- eval_candidate
|
|
title: BenchmarkConfig
|
|
description: A benchmark configuration for evaluation.
|
|
GreedySamplingStrategy:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: greedy
|
|
title: Type
|
|
default: greedy
|
|
type: object
|
|
title: GreedySamplingStrategy
|
|
description: Greedy sampling strategy that selects the highest probability token at each step.
|
|
ModelCandidate:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: model
|
|
title: Type
|
|
default: model
|
|
model:
|
|
type: string
|
|
title: Model
|
|
sampling_params:
|
|
$ref: '#/components/schemas/SamplingParams'
|
|
system_message:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/SystemMessage'
|
|
title: SystemMessage
|
|
- type: 'null'
|
|
title: SystemMessage
|
|
type: object
|
|
required:
|
|
- model
|
|
- sampling_params
|
|
title: ModelCandidate
|
|
description: A model candidate for evaluation.
|
|
SamplingParams:
|
|
properties:
|
|
strategy:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/GreedySamplingStrategy'
|
|
title: GreedySamplingStrategy
|
|
- $ref: '#/components/schemas/TopPSamplingStrategy'
|
|
title: TopPSamplingStrategy
|
|
- $ref: '#/components/schemas/TopKSamplingStrategy'
|
|
title: TopKSamplingStrategy
|
|
title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
greedy: '#/components/schemas/GreedySamplingStrategy'
|
|
top_k: '#/components/schemas/TopKSamplingStrategy'
|
|
top_p: '#/components/schemas/TopPSamplingStrategy'
|
|
max_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
repetition_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
default: 1.0
|
|
stop:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
type: object
|
|
title: SamplingParams
|
|
description: Sampling parameters.
|
|
SystemMessage:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: system
|
|
title: Role
|
|
default: system
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
title: ImageContentItem-Input
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Input | TextContentItem
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
title: ImageContentItem-Input
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Input | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem-Input | TextContentItem]
|
|
title: string | list[ImageContentItem-Input | TextContentItem]
|
|
type: object
|
|
required:
|
|
- content
|
|
title: SystemMessage
|
|
description: A system message providing instructions or context to the model.
|
|
TopKSamplingStrategy:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: top_k
|
|
title: Type
|
|
default: top_k
|
|
top_k:
|
|
type: integer
|
|
minimum: 1.0
|
|
title: Top K
|
|
type: object
|
|
required:
|
|
- top_k
|
|
title: TopKSamplingStrategy
|
|
description: Top-k sampling strategy that restricts sampling to the k most likely tokens.
|
|
TopPSamplingStrategy:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: top_p
|
|
title: Type
|
|
default: top_p
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
minimum: 0.0
|
|
- type: 'null'
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
default: 0.95
|
|
type: object
|
|
required:
|
|
- temperature
|
|
title: TopPSamplingStrategy
|
|
description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p.
|
|
EvaluateRowsRequest:
|
|
properties:
|
|
input_rows:
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
title: Input Rows
|
|
scoring_functions:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Scoring Functions
|
|
benchmark_config:
|
|
$ref: '#/components/schemas/BenchmarkConfig'
|
|
type: object
|
|
required:
|
|
- input_rows
|
|
- scoring_functions
|
|
- benchmark_config
|
|
title: EvaluateRowsRequest
|
|
EvaluateResponse:
|
|
properties:
|
|
generations:
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
title: Generations
|
|
scores:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ScoringResult'
|
|
type: object
|
|
title: Scores
|
|
type: object
|
|
required:
|
|
- generations
|
|
- scores
|
|
title: EvaluateResponse
|
|
description: The response from an evaluation.
|
|
RunEvalRequest:
|
|
properties:
|
|
benchmark_config:
|
|
$ref: '#/components/schemas/BenchmarkConfig'
|
|
type: object
|
|
required:
|
|
- benchmark_config
|
|
title: RunEvalRequest
|
|
Job:
|
|
properties:
|
|
job_id:
|
|
type: string
|
|
title: Job Id
|
|
status:
|
|
$ref: '#/components/schemas/JobStatus'
|
|
type: object
|
|
required:
|
|
- job_id
|
|
- status
|
|
title: Job
|
|
description: A job execution instance with status tracking.
|
|
RerankRequest:
|
|
properties:
|
|
model:
|
|
type: string
|
|
title: Model
|
|
query:
|
|
anyOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
title: OpenAIChatCompletionContentPartTextParam
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
title: OpenAIChatCompletionContentPartImageParam
|
|
title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam
|
|
items:
|
|
items:
|
|
anyOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
title: OpenAIChatCompletionContentPartTextParam
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
title: OpenAIChatCompletionContentPartImageParam
|
|
title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam
|
|
type: array
|
|
title: Items
|
|
max_num_results:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- model
|
|
- query
|
|
- items
|
|
title: RerankRequest
|
|
RerankData:
|
|
properties:
|
|
index:
|
|
type: integer
|
|
title: Index
|
|
relevance_score:
|
|
type: number
|
|
title: Relevance Score
|
|
type: object
|
|
required:
|
|
- index
|
|
- relevance_score
|
|
title: RerankData
|
|
description: A single rerank result from a reranking response.
|
|
RerankResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/RerankData'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: RerankResponse
|
|
description: Response from a reranking request.
|
|
Checkpoint:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
title: Created At
|
|
epoch:
|
|
type: integer
|
|
title: Epoch
|
|
post_training_job_id:
|
|
type: string
|
|
title: Post Training Job Id
|
|
path:
|
|
type: string
|
|
title: Path
|
|
training_metrics:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/PostTrainingMetric'
|
|
title: PostTrainingMetric
|
|
- type: 'null'
|
|
title: PostTrainingMetric
|
|
type: object
|
|
required:
|
|
- identifier
|
|
- created_at
|
|
- epoch
|
|
- post_training_job_id
|
|
- path
|
|
title: Checkpoint
|
|
description: Checkpoint created during training runs.
|
|
PostTrainingJobArtifactsResponse:
|
|
properties:
|
|
job_uuid:
|
|
type: string
|
|
title: Job Uuid
|
|
checkpoints:
|
|
items:
|
|
$ref: '#/components/schemas/Checkpoint'
|
|
type: array
|
|
title: Checkpoints
|
|
type: object
|
|
required:
|
|
- job_uuid
|
|
title: PostTrainingJobArtifactsResponse
|
|
description: Artifacts of a finetuning job.
|
|
PostTrainingMetric:
|
|
properties:
|
|
epoch:
|
|
type: integer
|
|
title: Epoch
|
|
train_loss:
|
|
type: number
|
|
title: Train Loss
|
|
validation_loss:
|
|
type: number
|
|
title: Validation Loss
|
|
perplexity:
|
|
type: number
|
|
title: Perplexity
|
|
type: object
|
|
required:
|
|
- epoch
|
|
- train_loss
|
|
- validation_loss
|
|
- perplexity
|
|
title: PostTrainingMetric
|
|
description: Training metrics captured during post-training jobs.
|
|
CancelTrainingJobRequest:
|
|
properties:
|
|
job_uuid:
|
|
type: string
|
|
title: Job Uuid
|
|
type: object
|
|
required:
|
|
- job_uuid
|
|
title: CancelTrainingJobRequest
|
|
PostTrainingJobStatusResponse:
|
|
properties:
|
|
job_uuid:
|
|
type: string
|
|
title: Job Uuid
|
|
status:
|
|
$ref: '#/components/schemas/JobStatus'
|
|
scheduled_at:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
- type: 'null'
|
|
started_at:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
- type: 'null'
|
|
completed_at:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
- type: 'null'
|
|
resources_allocated:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
checkpoints:
|
|
items:
|
|
$ref: '#/components/schemas/Checkpoint'
|
|
type: array
|
|
title: Checkpoints
|
|
type: object
|
|
required:
|
|
- job_uuid
|
|
- status
|
|
title: PostTrainingJobStatusResponse
|
|
description: Status of a finetuning job.
|
|
ListPostTrainingJobsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/PostTrainingJob'
|
|
type: array
|
|
title: Data
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListPostTrainingJobsResponse
|
|
DPOAlignmentConfig:
|
|
properties:
|
|
beta:
|
|
type: number
|
|
title: Beta
|
|
loss_type:
|
|
$ref: '#/components/schemas/DPOLossType'
|
|
default: sigmoid
|
|
type: object
|
|
required:
|
|
- beta
|
|
title: DPOAlignmentConfig
|
|
description: Configuration for Direct Preference Optimization (DPO) alignment.
|
|
DPOLossType:
|
|
type: string
|
|
enum:
|
|
- sigmoid
|
|
- hinge
|
|
- ipo
|
|
- kto_pair
|
|
title: DPOLossType
|
|
DataConfig:
|
|
properties:
|
|
dataset_id:
|
|
type: string
|
|
title: Dataset Id
|
|
batch_size:
|
|
type: integer
|
|
title: Batch Size
|
|
shuffle:
|
|
type: boolean
|
|
title: Shuffle
|
|
data_format:
|
|
$ref: '#/components/schemas/DatasetFormat'
|
|
validation_dataset_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
packed:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
train_on_input:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
type: object
|
|
required:
|
|
- dataset_id
|
|
- batch_size
|
|
- shuffle
|
|
- data_format
|
|
title: DataConfig
|
|
description: Configuration for training data and data loading.
|
|
DatasetFormat:
|
|
type: string
|
|
enum:
|
|
- instruct
|
|
- dialog
|
|
title: DatasetFormat
|
|
description: Format of the training dataset.
|
|
EfficiencyConfig:
|
|
properties:
|
|
enable_activation_checkpointing:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
enable_activation_offloading:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
memory_efficient_fsdp_wrap:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
fsdp_cpu_offload:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
type: object
|
|
title: EfficiencyConfig
|
|
description: Configuration for memory and compute efficiency optimizations.
|
|
OptimizerConfig:
|
|
properties:
|
|
optimizer_type:
|
|
$ref: '#/components/schemas/OptimizerType'
|
|
lr:
|
|
type: number
|
|
title: Lr
|
|
weight_decay:
|
|
type: number
|
|
title: Weight Decay
|
|
num_warmup_steps:
|
|
type: integer
|
|
title: Num Warmup Steps
|
|
type: object
|
|
required:
|
|
- optimizer_type
|
|
- lr
|
|
- weight_decay
|
|
- num_warmup_steps
|
|
title: OptimizerConfig
|
|
description: Configuration parameters for the optimization algorithm.
|
|
OptimizerType:
|
|
type: string
|
|
enum:
|
|
- adam
|
|
- adamw
|
|
- sgd
|
|
title: OptimizerType
|
|
description: Available optimizer algorithms for training.
|
|
TrainingConfig:
|
|
properties:
|
|
n_epochs:
|
|
type: integer
|
|
title: N Epochs
|
|
max_steps_per_epoch:
|
|
type: integer
|
|
title: Max Steps Per Epoch
|
|
default: 1
|
|
gradient_accumulation_steps:
|
|
type: integer
|
|
title: Gradient Accumulation Steps
|
|
default: 1
|
|
max_validation_steps:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
default: 1
|
|
data_config:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/DataConfig'
|
|
title: DataConfig
|
|
- type: 'null'
|
|
title: DataConfig
|
|
optimizer_config:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OptimizerConfig'
|
|
title: OptimizerConfig
|
|
- type: 'null'
|
|
title: OptimizerConfig
|
|
efficiency_config:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/EfficiencyConfig'
|
|
title: EfficiencyConfig
|
|
- type: 'null'
|
|
title: EfficiencyConfig
|
|
dtype:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
default: bf16
|
|
type: object
|
|
required:
|
|
- n_epochs
|
|
title: TrainingConfig
|
|
description: Comprehensive configuration for the training process.
|
|
PreferenceOptimizeRequest:
|
|
properties:
|
|
job_uuid:
|
|
type: string
|
|
title: Job Uuid
|
|
finetuned_model:
|
|
type: string
|
|
title: Finetuned Model
|
|
algorithm_config:
|
|
$ref: '#/components/schemas/DPOAlignmentConfig'
|
|
training_config:
|
|
$ref: '#/components/schemas/TrainingConfig'
|
|
hyperparam_search_config:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Hyperparam Search Config
|
|
logger_config:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Logger Config
|
|
type: object
|
|
required:
|
|
- job_uuid
|
|
- finetuned_model
|
|
- algorithm_config
|
|
- training_config
|
|
- hyperparam_search_config
|
|
- logger_config
|
|
title: PreferenceOptimizeRequest
|
|
PostTrainingJob:
|
|
properties:
|
|
job_uuid:
|
|
type: string
|
|
title: Job Uuid
|
|
type: object
|
|
required:
|
|
- job_uuid
|
|
title: PostTrainingJob
|
|
AlgorithmConfig:
|
|
discriminator:
|
|
mapping:
|
|
LoRA: '#/components/schemas/LoraFinetuningConfig'
|
|
QAT: '#/components/schemas/QATFinetuningConfig'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/LoraFinetuningConfig'
|
|
title: LoraFinetuningConfig
|
|
- $ref: '#/components/schemas/QATFinetuningConfig'
|
|
title: QATFinetuningConfig
|
|
title: LoraFinetuningConfig | QATFinetuningConfig
|
|
LoraFinetuningConfig:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: LoRA
|
|
title: Type
|
|
default: LoRA
|
|
lora_attn_modules:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Lora Attn Modules
|
|
apply_lora_to_mlp:
|
|
type: boolean
|
|
title: Apply Lora To Mlp
|
|
apply_lora_to_output:
|
|
type: boolean
|
|
title: Apply Lora To Output
|
|
rank:
|
|
type: integer
|
|
title: Rank
|
|
alpha:
|
|
type: integer
|
|
title: Alpha
|
|
use_dora:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
quantize_base:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
default: false
|
|
type: object
|
|
required:
|
|
- lora_attn_modules
|
|
- apply_lora_to_mlp
|
|
- apply_lora_to_output
|
|
- rank
|
|
- alpha
|
|
title: LoraFinetuningConfig
|
|
description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning.
|
|
QATFinetuningConfig:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: QAT
|
|
title: Type
|
|
default: QAT
|
|
quantizer_name:
|
|
type: string
|
|
title: Quantizer Name
|
|
group_size:
|
|
type: integer
|
|
title: Group Size
|
|
type: object
|
|
required:
|
|
- quantizer_name
|
|
- group_size
|
|
title: QATFinetuningConfig
|
|
description: Configuration for Quantization-Aware Training (QAT) fine-tuning.
|
|
SupervisedFineTuneRequest:
|
|
properties:
|
|
job_uuid:
|
|
type: string
|
|
title: Job Uuid
|
|
training_config:
|
|
$ref: '#/components/schemas/TrainingConfig'
|
|
hyperparam_search_config:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Hyperparam Search Config
|
|
logger_config:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Logger Config
|
|
model:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Model descriptor for training if not in provider config`
|
|
checkpoint_dir:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
algorithm_config:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LoraFinetuningConfig'
|
|
title: LoraFinetuningConfig
|
|
- $ref: '#/components/schemas/QATFinetuningConfig'
|
|
title: QATFinetuningConfig
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
LoRA: '#/components/schemas/LoraFinetuningConfig'
|
|
QAT: '#/components/schemas/QATFinetuningConfig'
|
|
title: LoraFinetuningConfig | QATFinetuningConfig
|
|
- type: 'null'
|
|
title: Algorithm Config
|
|
type: object
|
|
required:
|
|
- job_uuid
|
|
- training_config
|
|
- hyperparam_search_config
|
|
- logger_config
|
|
title: SupervisedFineTuneRequest
|
|
RegisterModelRequest:
|
|
properties:
|
|
model_id:
|
|
type: string
|
|
title: Model Id
|
|
provider_model_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
provider_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
model_type:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ModelType'
|
|
title: ModelType
|
|
- type: 'null'
|
|
title: ModelType
|
|
type: object
|
|
required:
|
|
- model_id
|
|
title: RegisterModelRequest
|
|
ParamType:
|
|
discriminator:
|
|
mapping:
|
|
array: '#/components/schemas/ArrayType'
|
|
boolean: '#/components/schemas/BooleanType'
|
|
chat_completion_input: '#/components/schemas/ChatCompletionInputType'
|
|
completion_input: '#/components/schemas/CompletionInputType'
|
|
json: '#/components/schemas/JsonType'
|
|
number: '#/components/schemas/NumberType'
|
|
object: '#/components/schemas/ObjectType'
|
|
string: '#/components/schemas/StringType'
|
|
union: '#/components/schemas/UnionType'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/StringType'
|
|
title: StringType
|
|
- $ref: '#/components/schemas/NumberType'
|
|
title: NumberType
|
|
- $ref: '#/components/schemas/BooleanType'
|
|
title: BooleanType
|
|
- $ref: '#/components/schemas/ArrayType'
|
|
title: ArrayType
|
|
- $ref: '#/components/schemas/ObjectType'
|
|
title: ObjectType
|
|
- $ref: '#/components/schemas/JsonType'
|
|
title: JsonType
|
|
- $ref: '#/components/schemas/UnionType'
|
|
title: UnionType
|
|
- $ref: '#/components/schemas/ChatCompletionInputType'
|
|
title: ChatCompletionInputType
|
|
- $ref: '#/components/schemas/CompletionInputType'
|
|
title: CompletionInputType
|
|
title: StringType | ... (9 variants)
|
|
RegisterScoringFunctionRequest:
|
|
properties:
|
|
scoring_fn_id:
|
|
type: string
|
|
title: Scoring Fn Id
|
|
description:
|
|
type: string
|
|
title: Description
|
|
return_type:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/StringType'
|
|
title: StringType
|
|
- $ref: '#/components/schemas/NumberType'
|
|
title: NumberType
|
|
- $ref: '#/components/schemas/BooleanType'
|
|
title: BooleanType
|
|
- $ref: '#/components/schemas/ArrayType'
|
|
title: ArrayType
|
|
- $ref: '#/components/schemas/ObjectType'
|
|
title: ObjectType
|
|
- $ref: '#/components/schemas/JsonType'
|
|
title: JsonType
|
|
- $ref: '#/components/schemas/UnionType'
|
|
title: UnionType
|
|
- $ref: '#/components/schemas/ChatCompletionInputType'
|
|
title: ChatCompletionInputType
|
|
- $ref: '#/components/schemas/CompletionInputType'
|
|
title: CompletionInputType
|
|
title: StringType | ... (9 variants)
|
|
provider_scoring_fn_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
provider_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
params:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: RegexParserScoringFnParams
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
title: BasicScoringFnParams
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams
|
|
- type: 'null'
|
|
title: Params
|
|
type: object
|
|
required:
|
|
- scoring_fn_id
|
|
- description
|
|
- return_type
|
|
title: RegisterScoringFunctionRequest
|
|
RegisterShieldRequest:
|
|
properties:
|
|
shield_id:
|
|
type: string
|
|
title: Shield Id
|
|
provider_shield_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
provider_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
params:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- shield_id
|
|
title: RegisterShieldRequest
|
|
RegisterToolGroupRequest:
|
|
properties:
|
|
toolgroup_id:
|
|
type: string
|
|
title: Toolgroup Id
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
mcp_endpoint:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/URL'
|
|
title: URL
|
|
- type: 'null'
|
|
title: URL
|
|
args:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- toolgroup_id
|
|
- provider_id
|
|
title: RegisterToolGroupRequest
|
|
DataSource:
|
|
discriminator:
|
|
mapping:
|
|
rows: '#/components/schemas/RowsDataSource'
|
|
uri: '#/components/schemas/URIDataSource'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/URIDataSource'
|
|
title: URIDataSource
|
|
- $ref: '#/components/schemas/RowsDataSource'
|
|
title: RowsDataSource
|
|
title: URIDataSource | RowsDataSource
|
|
RegisterDatasetRequest:
|
|
properties:
|
|
purpose:
|
|
$ref: '#/components/schemas/DatasetPurpose'
|
|
source:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/URIDataSource'
|
|
title: URIDataSource
|
|
- $ref: '#/components/schemas/RowsDataSource'
|
|
title: RowsDataSource
|
|
title: URIDataSource | RowsDataSource
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
dataset_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- purpose
|
|
- source
|
|
title: RegisterDatasetRequest
|
|
RegisterBenchmarkRequest:
|
|
properties:
|
|
benchmark_id:
|
|
type: string
|
|
title: Benchmark Id
|
|
dataset_id:
|
|
type: string
|
|
title: Dataset Id
|
|
scoring_functions:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Scoring Functions
|
|
provider_benchmark_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
provider_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- benchmark_id
|
|
- dataset_id
|
|
- scoring_functions
|
|
title: RegisterBenchmarkRequest
|
|
AllowedToolsFilter:
|
|
properties:
|
|
tool_names:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
type: object
|
|
title: AllowedToolsFilter
|
|
description: Filter configuration for restricting which MCP tools can be used.
|
|
ApprovalFilter:
|
|
properties:
|
|
always:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
never:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
type: object
|
|
title: ApprovalFilter
|
|
description: Filter configuration for MCP tool approval requirements.
|
|
BatchError:
|
|
properties:
|
|
code:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
line:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
message:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
param:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
additionalProperties: true
|
|
type: object
|
|
title: BatchError
|
|
BatchRequestCounts:
|
|
properties:
|
|
completed:
|
|
type: integer
|
|
title: Completed
|
|
failed:
|
|
type: integer
|
|
title: Failed
|
|
total:
|
|
type: integer
|
|
title: Total
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- completed
|
|
- failed
|
|
- total
|
|
title: BatchRequestCounts
|
|
BatchUsage:
|
|
properties:
|
|
input_tokens:
|
|
type: integer
|
|
title: Input Tokens
|
|
input_tokens_details:
|
|
$ref: '#/components/schemas/InputTokensDetails'
|
|
output_tokens:
|
|
type: integer
|
|
title: Output Tokens
|
|
output_tokens_details:
|
|
$ref: '#/components/schemas/OutputTokensDetails'
|
|
total_tokens:
|
|
type: integer
|
|
title: Total Tokens
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- input_tokens
|
|
- input_tokens_details
|
|
- output_tokens
|
|
- output_tokens_details
|
|
- total_tokens
|
|
title: BatchUsage
|
|
Body_openai_upload_file_v1_files_post:
|
|
properties:
|
|
file:
|
|
type: string
|
|
format: binary
|
|
title: File
|
|
purpose:
|
|
$ref: '#/components/schemas/OpenAIFilePurpose'
|
|
expires_after:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ExpiresAfter'
|
|
title: ExpiresAfter
|
|
- type: 'null'
|
|
title: ExpiresAfter
|
|
type: object
|
|
required:
|
|
- file
|
|
- purpose
|
|
title: Body_openai_upload_file_v1_files_post
|
|
Chunk-Input:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
title: ImageContentItem-Input
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Input | TextContentItem
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
title: ImageContentItem-Input
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Input | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem-Input | TextContentItem]
|
|
title: string | list[ImageContentItem-Input | TextContentItem]
|
|
chunk_id:
|
|
type: string
|
|
title: Chunk Id
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
embedding:
|
|
anyOf:
|
|
- items:
|
|
type: number
|
|
type: array
|
|
- type: 'null'
|
|
chunk_metadata:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ChunkMetadata'
|
|
title: ChunkMetadata
|
|
- type: 'null'
|
|
title: ChunkMetadata
|
|
type: object
|
|
required:
|
|
- content
|
|
- chunk_id
|
|
title: Chunk
|
|
description: A chunk of content that can be inserted into a vector database.
|
|
Chunk-Output:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Output'
|
|
title: ImageContentItem-Output
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Output | TextContentItem
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Output'
|
|
title: ImageContentItem-Output
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
title: ImageContentItem-Output | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem-Output | TextContentItem]
|
|
title: string | list[ImageContentItem-Output | TextContentItem]
|
|
chunk_id:
|
|
type: string
|
|
title: Chunk Id
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
embedding:
|
|
anyOf:
|
|
- items:
|
|
type: number
|
|
type: array
|
|
- type: 'null'
|
|
chunk_metadata:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ChunkMetadata'
|
|
title: ChunkMetadata
|
|
- type: 'null'
|
|
title: ChunkMetadata
|
|
type: object
|
|
required:
|
|
- content
|
|
- chunk_id
|
|
title: Chunk
|
|
description: A chunk of content that can be inserted into a vector database.
|
|
ConversationItemInclude:
|
|
type: string
|
|
enum:
|
|
- web_search_call.action.sources
|
|
- code_interpreter_call.outputs
|
|
- computer_call_output.output.image_url
|
|
- file_search_call.results
|
|
- message.input_image.image_url
|
|
- message.output_text.logprobs
|
|
- reasoning.encrypted_content
|
|
title: ConversationItemInclude
|
|
description: Specify additional output data to include in the model response.
|
|
DatasetPurpose:
|
|
type: string
|
|
enum:
|
|
- post-training/messages
|
|
- eval/question-answer
|
|
- eval/messages-answer
|
|
title: DatasetPurpose
|
|
description: Purpose of the dataset. Each purpose has a required input data schema.
|
|
Errors:
|
|
properties:
|
|
data:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/BatchError'
|
|
type: array
|
|
- type: 'null'
|
|
object:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
additionalProperties: true
|
|
type: object
|
|
title: Errors
|
|
HealthStatus:
|
|
type: string
|
|
enum:
|
|
- OK
|
|
- Error
|
|
- Not Implemented
|
|
title: HealthStatus
|
|
ImageContentItem-Input:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: image
|
|
title: Type
|
|
default: image
|
|
image:
|
|
$ref: '#/components/schemas/_URLOrData'
|
|
type: object
|
|
required:
|
|
- image
|
|
title: ImageContentItem
|
|
description: A image content item
|
|
ImageContentItem-Output:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: image
|
|
title: Type
|
|
default: image
|
|
image:
|
|
$ref: '#/components/schemas/_URLOrData'
|
|
type: object
|
|
required:
|
|
- image
|
|
title: ImageContentItem
|
|
description: A image content item
|
|
InputTokensDetails:
|
|
properties:
|
|
cached_tokens:
|
|
type: integer
|
|
title: Cached Tokens
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- cached_tokens
|
|
title: InputTokensDetails
|
|
JobStatus:
|
|
type: string
|
|
enum:
|
|
- completed
|
|
- in_progress
|
|
- failed
|
|
- scheduled
|
|
- cancelled
|
|
title: JobStatus
|
|
description: Status of a job execution.
|
|
MCPListToolsTool:
|
|
properties:
|
|
input_schema:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Input Schema
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- input_schema
|
|
- name
|
|
title: MCPListToolsTool
|
|
description: Tool definition returned by MCP list tools operation.
|
|
OpenAIAssistantMessageParam-Input:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: assistant
|
|
title: Role
|
|
default: assistant
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam]
|
|
- type: 'null'
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam]
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
tool_calls:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
|
|
type: array
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIAssistantMessageParam
|
|
description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request.
|
|
OpenAIAssistantMessageParam-Output:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: assistant
|
|
title: Role
|
|
default: assistant
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam]
|
|
- type: 'null'
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam]
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
tool_calls:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
|
|
type: array
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIAssistantMessageParam
|
|
description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request.
|
|
OpenAIChatCompletionUsageCompletionTokensDetails:
|
|
properties:
|
|
reasoning_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIChatCompletionUsageCompletionTokensDetails
|
|
description: Token details for output tokens in OpenAI chat completion usage.
|
|
OpenAIChatCompletionUsagePromptTokensDetails:
|
|
properties:
|
|
cached_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIChatCompletionUsagePromptTokensDetails
|
|
description: Token details for prompt tokens in OpenAI chat completion usage.
|
|
OpenAIResponseMessage-Input:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
title: OpenAIResponseInputMessageContentText
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
title: OpenAIResponseInputMessageContentImage
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
title: OpenAIResponseInputMessageContentFile
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile
|
|
type: array
|
|
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
title: OpenAIResponseOutputMessageContentOutputText
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseContentPartRefusal
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal
|
|
type: array
|
|
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
|
|
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
|
|
role:
|
|
title: Role
|
|
type: string
|
|
enum:
|
|
- system
|
|
- developer
|
|
- user
|
|
- assistant
|
|
default: system
|
|
type:
|
|
type: string
|
|
const: message
|
|
title: Type
|
|
default: message
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- content
|
|
- role
|
|
title: OpenAIResponseMessage
|
|
description: |-
|
|
Corresponds to the various Message types in the Responses API.
|
|
They are all under one type because the Responses API gives them all
|
|
the same "type" value, and there is no way to tell them apart in certain
|
|
scenarios.
|
|
OpenAIResponseMessage-Output:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
title: OpenAIResponseInputMessageContentText
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
title: OpenAIResponseInputMessageContentImage
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
title: OpenAIResponseInputMessageContentFile
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile
|
|
type: array
|
|
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
title: OpenAIResponseOutputMessageContentOutputText
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseContentPartRefusal
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal
|
|
type: array
|
|
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
|
|
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
|
|
role:
|
|
title: Role
|
|
type: string
|
|
enum:
|
|
- system
|
|
- developer
|
|
- user
|
|
- assistant
|
|
default: system
|
|
type:
|
|
type: string
|
|
const: message
|
|
title: Type
|
|
default: message
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- content
|
|
- role
|
|
title: OpenAIResponseMessage
|
|
description: |-
|
|
Corresponds to the various Message types in the Responses API.
|
|
They are all under one type because the Responses API gives them all
|
|
the same "type" value, and there is no way to tell them apart in certain
|
|
scenarios.
|
|
OpenAIResponseOutputMessageFileSearchToolCallResults:
|
|
properties:
|
|
attributes:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Attributes
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
score:
|
|
type: number
|
|
title: Score
|
|
text:
|
|
type: string
|
|
title: Text
|
|
type: object
|
|
required:
|
|
- attributes
|
|
- file_id
|
|
- filename
|
|
- score
|
|
- text
|
|
title: OpenAIResponseOutputMessageFileSearchToolCallResults
|
|
description: Search results returned by the file search operation.
|
|
OpenAIResponseTextFormat:
|
|
properties:
|
|
type:
|
|
title: Type
|
|
type: string
|
|
enum:
|
|
- text
|
|
- json_schema
|
|
- json_object
|
|
default: text
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
schema:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
strict:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIResponseTextFormat
|
|
description: Configuration for Responses API text format.
|
|
OpenAIResponseUsageInputTokensDetails:
|
|
properties:
|
|
cached_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIResponseUsageInputTokensDetails
|
|
description: Token details for input tokens in OpenAI response usage.
|
|
OpenAIResponseUsageOutputTokensDetails:
|
|
properties:
|
|
reasoning_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIResponseUsageOutputTokensDetails
|
|
description: Token details for output tokens in OpenAI response usage.
|
|
OpenAIUserMessageParam-Input:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: user
|
|
title: Role
|
|
default: user
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
title: OpenAIChatCompletionContentPartTextParam
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
title: OpenAIChatCompletionContentPartImageParam
|
|
- $ref: '#/components/schemas/OpenAIFile'
|
|
title: OpenAIFile
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file: '#/components/schemas/OpenAIFile'
|
|
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile]
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile]
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- content
|
|
title: OpenAIUserMessageParam
|
|
description: A message from the user in an OpenAI-compatible chat completion request.
|
|
OpenAIUserMessageParam-Output:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: user
|
|
title: Role
|
|
default: user
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
title: OpenAIChatCompletionContentPartTextParam
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
title: OpenAIChatCompletionContentPartImageParam
|
|
- $ref: '#/components/schemas/OpenAIFile'
|
|
title: OpenAIFile
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file: '#/components/schemas/OpenAIFile'
|
|
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile
|
|
type: array
|
|
title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile]
|
|
title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile]
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- content
|
|
title: OpenAIUserMessageParam
|
|
description: A message from the user in an OpenAI-compatible chat completion request.
|
|
OutputTokensDetails:
|
|
properties:
|
|
reasoning_tokens:
|
|
type: integer
|
|
title: Reasoning Tokens
|
|
additionalProperties: true
|
|
type: object
|
|
required:
|
|
- reasoning_tokens
|
|
title: OutputTokensDetails
|
|
SearchRankingOptions:
|
|
properties:
|
|
ranker:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
score_threshold:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
default: 0.0
|
|
type: object
|
|
title: SearchRankingOptions
|
|
description: Options for ranking and filtering search results.
|
|
_URLOrData:
|
|
properties:
|
|
url:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/URL'
|
|
title: URL
|
|
- type: 'null'
|
|
title: URL
|
|
data:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
contentEncoding: base64
|
|
type: object
|
|
title: _URLOrData
|
|
description: A URL or a base64 encoded string
|
|
SamplingStrategy:
|
|
discriminator:
|
|
mapping:
|
|
greedy: '#/components/schemas/GreedySamplingStrategy'
|
|
top_k: '#/components/schemas/TopKSamplingStrategy'
|
|
top_p: '#/components/schemas/TopPSamplingStrategy'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/GreedySamplingStrategy'
|
|
title: GreedySamplingStrategy
|
|
- $ref: '#/components/schemas/TopPSamplingStrategy'
|
|
title: TopPSamplingStrategy
|
|
- $ref: '#/components/schemas/TopKSamplingStrategy'
|
|
title: TopKSamplingStrategy
|
|
title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy
|
|
GrammarResponseFormat:
|
|
description: Configuration for grammar-guided response generation.
|
|
properties:
|
|
type:
|
|
const: grammar
|
|
default: grammar
|
|
title: Type
|
|
type: string
|
|
bnf:
|
|
additionalProperties: true
|
|
title: Bnf
|
|
type: object
|
|
required:
|
|
- bnf
|
|
title: GrammarResponseFormat
|
|
type: object
|
|
JsonSchemaResponseFormat:
|
|
description: Configuration for JSON schema-guided response generation.
|
|
properties:
|
|
type:
|
|
const: json_schema
|
|
default: json_schema
|
|
title: Type
|
|
type: string
|
|
json_schema:
|
|
additionalProperties: true
|
|
title: Json Schema
|
|
type: object
|
|
required:
|
|
- json_schema
|
|
title: JsonSchemaResponseFormat
|
|
type: object
|
|
ResponseFormat:
|
|
discriminator:
|
|
mapping:
|
|
grammar: '#/components/schemas/GrammarResponseFormat'
|
|
json_schema: '#/components/schemas/JsonSchemaResponseFormat'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/JsonSchemaResponseFormat'
|
|
title: JsonSchemaResponseFormat
|
|
- $ref: '#/components/schemas/GrammarResponseFormat'
|
|
title: GrammarResponseFormat
|
|
title: JsonSchemaResponseFormat | GrammarResponseFormat
|
|
OpenAIResponseContentPart:
|
|
discriminator:
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
|
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
|
title: OpenAIResponseContentPartOutputText
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
title: OpenAIResponseContentPartRefusal
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
|
title: OpenAIResponseContentPartReasoningText
|
|
title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText
|
|
SpanEndPayload:
|
|
description: Payload for a span end event.
|
|
properties:
|
|
type:
|
|
const: span_end
|
|
default: span_end
|
|
title: Type
|
|
type: string
|
|
status:
|
|
$ref: '#/components/schemas/SpanStatus'
|
|
required:
|
|
- status
|
|
title: SpanEndPayload
|
|
type: object
|
|
SpanStartPayload:
|
|
description: Payload for a span start event.
|
|
properties:
|
|
type:
|
|
const: span_start
|
|
default: span_start
|
|
title: Type
|
|
type: string
|
|
name:
|
|
title: Name
|
|
type: string
|
|
parent_span_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
required:
|
|
- name
|
|
title: SpanStartPayload
|
|
type: object
|
|
SpanStatus:
|
|
description: The status of a span indicating whether it completed successfully or with an error.
|
|
enum:
|
|
- ok
|
|
- error
|
|
title: SpanStatus
|
|
type: string
|
|
StructuredLogPayload:
|
|
discriminator:
|
|
mapping:
|
|
span_end: '#/components/schemas/SpanEndPayload'
|
|
span_start: '#/components/schemas/SpanStartPayload'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/SpanStartPayload'
|
|
title: SpanStartPayload
|
|
- $ref: '#/components/schemas/SpanEndPayload'
|
|
title: SpanEndPayload
|
|
title: SpanStartPayload | SpanEndPayload
|
|
LogSeverity:
|
|
description: The severity level of a log message.
|
|
enum:
|
|
- verbose
|
|
- debug
|
|
- info
|
|
- warn
|
|
- error
|
|
- critical
|
|
title: LogSeverity
|
|
type: string
|
|
MetricEvent:
|
|
description: A metric event containing a measured value.
|
|
properties:
|
|
trace_id:
|
|
title: Trace Id
|
|
type: string
|
|
span_id:
|
|
title: Span Id
|
|
type: string
|
|
timestamp:
|
|
format: date-time
|
|
title: Timestamp
|
|
type: string
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties:
|
|
anyOf:
|
|
- type: string
|
|
- type: integer
|
|
- type: number
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: string | ... (4 variants)
|
|
type: object
|
|
- type: 'null'
|
|
type:
|
|
const: metric
|
|
default: metric
|
|
title: Type
|
|
type: string
|
|
metric:
|
|
title: Metric
|
|
type: string
|
|
value:
|
|
anyOf:
|
|
- type: integer
|
|
- type: number
|
|
title: integer | number
|
|
unit:
|
|
title: Unit
|
|
type: string
|
|
required:
|
|
- trace_id
|
|
- span_id
|
|
- timestamp
|
|
- metric
|
|
- value
|
|
- unit
|
|
title: MetricEvent
|
|
type: object
|
|
StructuredLogEvent:
|
|
description: A structured log event containing typed payload data.
|
|
properties:
|
|
trace_id:
|
|
title: Trace Id
|
|
type: string
|
|
span_id:
|
|
title: Span Id
|
|
type: string
|
|
timestamp:
|
|
format: date-time
|
|
title: Timestamp
|
|
type: string
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties:
|
|
anyOf:
|
|
- type: string
|
|
- type: integer
|
|
- type: number
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: string | ... (4 variants)
|
|
type: object
|
|
- type: 'null'
|
|
type:
|
|
const: structured_log
|
|
default: structured_log
|
|
title: Type
|
|
type: string
|
|
payload:
|
|
discriminator:
|
|
mapping:
|
|
span_end: '#/components/schemas/SpanEndPayload'
|
|
span_start: '#/components/schemas/SpanStartPayload'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/SpanStartPayload'
|
|
title: SpanStartPayload
|
|
- $ref: '#/components/schemas/SpanEndPayload'
|
|
title: SpanEndPayload
|
|
title: SpanStartPayload | SpanEndPayload
|
|
required:
|
|
- trace_id
|
|
- span_id
|
|
- timestamp
|
|
- payload
|
|
title: StructuredLogEvent
|
|
type: object
|
|
UnstructuredLogEvent:
|
|
description: An unstructured log event containing a simple text message.
|
|
properties:
|
|
trace_id:
|
|
title: Trace Id
|
|
type: string
|
|
span_id:
|
|
title: Span Id
|
|
type: string
|
|
timestamp:
|
|
format: date-time
|
|
title: Timestamp
|
|
type: string
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties:
|
|
anyOf:
|
|
- type: string
|
|
- type: integer
|
|
- type: number
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: string | ... (4 variants)
|
|
type: object
|
|
- type: 'null'
|
|
type:
|
|
const: unstructured_log
|
|
default: unstructured_log
|
|
title: Type
|
|
type: string
|
|
message:
|
|
title: Message
|
|
type: string
|
|
severity:
|
|
$ref: '#/components/schemas/LogSeverity'
|
|
required:
|
|
- trace_id
|
|
- span_id
|
|
- timestamp
|
|
- message
|
|
- severity
|
|
title: UnstructuredLogEvent
|
|
type: object
|
|
Event:
|
|
discriminator:
|
|
mapping:
|
|
metric: '#/components/schemas/MetricEvent'
|
|
structured_log: '#/components/schemas/StructuredLogEvent'
|
|
unstructured_log: '#/components/schemas/UnstructuredLogEvent'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/UnstructuredLogEvent'
|
|
title: UnstructuredLogEvent
|
|
- $ref: '#/components/schemas/MetricEvent'
|
|
title: MetricEvent
|
|
- $ref: '#/components/schemas/StructuredLogEvent'
|
|
title: StructuredLogEvent
|
|
title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent
|
|
MetricInResponse:
|
|
description: A metric value included in API responses.
|
|
properties:
|
|
metric:
|
|
title: Metric
|
|
type: string
|
|
value:
|
|
anyOf:
|
|
- type: integer
|
|
- type: number
|
|
title: integer | number
|
|
unit:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
required:
|
|
- metric
|
|
- value
|
|
title: MetricInResponse
|
|
type: object
|
|
TextDelta:
|
|
description: A text content delta for streaming responses.
|
|
properties:
|
|
type:
|
|
const: text
|
|
default: text
|
|
title: Type
|
|
type: string
|
|
text:
|
|
title: Text
|
|
type: string
|
|
required:
|
|
- text
|
|
title: TextDelta
|
|
type: object
|
|
ImageDelta:
|
|
description: An image content delta for streaming responses.
|
|
properties:
|
|
type:
|
|
const: image
|
|
default: image
|
|
title: Type
|
|
type: string
|
|
image:
|
|
format: binary
|
|
title: Image
|
|
type: string
|
|
required:
|
|
- image
|
|
title: ImageDelta
|
|
type: object
|
|
Fp8QuantizationConfig:
|
|
description: Configuration for 8-bit floating point quantization.
|
|
properties:
|
|
type:
|
|
const: fp8_mixed
|
|
default: fp8_mixed
|
|
title: Type
|
|
type: string
|
|
title: Fp8QuantizationConfig
|
|
type: object
|
|
Bf16QuantizationConfig:
|
|
description: Configuration for BFloat16 precision (typically no quantization).
|
|
properties:
|
|
type:
|
|
const: bf16
|
|
default: bf16
|
|
title: Type
|
|
type: string
|
|
title: Bf16QuantizationConfig
|
|
type: object
|
|
Int4QuantizationConfig:
|
|
description: Configuration for 4-bit integer quantization.
|
|
properties:
|
|
type:
|
|
const: int4_mixed
|
|
default: int4_mixed
|
|
title: Type
|
|
type: string
|
|
scheme:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
default: int4_weight_int8_dynamic_activation
|
|
title: Int4QuantizationConfig
|
|
type: object
|
|
UserMessage:
|
|
description: A message from the user in a chat conversation.
|
|
properties:
|
|
role:
|
|
const: user
|
|
default: user
|
|
title: Role
|
|
type: string
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
- items:
|
|
discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem | TextContentItem]
|
|
title: string | list[ImageContentItem | TextContentItem]
|
|
context:
|
|
anyOf:
|
|
- type: string
|
|
- discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
- items:
|
|
discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem | TextContentItem]
|
|
- type: 'null'
|
|
title: string | list[ImageContentItem | TextContentItem]
|
|
nullable: true
|
|
required:
|
|
- content
|
|
title: UserMessage
|
|
type: object
|
|
ToolResponseMessage:
|
|
description: A message representing the result of a tool invocation.
|
|
properties:
|
|
role:
|
|
const: tool
|
|
default: tool
|
|
title: Role
|
|
type: string
|
|
call_id:
|
|
title: Call Id
|
|
type: string
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
- items:
|
|
discriminator:
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem'
|
|
text: '#/components/schemas/TextContentItem'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem'
|
|
title: ImageContentItem
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
title: TextContentItem
|
|
title: ImageContentItem | TextContentItem
|
|
type: array
|
|
title: list[ImageContentItem | TextContentItem]
|
|
title: string | list[ImageContentItem | TextContentItem]
|
|
required:
|
|
- call_id
|
|
- content
|
|
title: ToolResponseMessage
|
|
type: object
|
|
TokenLogProbs:
|
|
description: Log probabilities for generated tokens.
|
|
properties:
|
|
logprobs_by_token:
|
|
additionalProperties:
|
|
type: number
|
|
title: Logprobs By Token
|
|
type: object
|
|
required:
|
|
- logprobs_by_token
|
|
title: TokenLogProbs
|
|
type: object
|
|
EmbeddingsResponse:
|
|
description: Response containing generated embeddings.
|
|
properties:
|
|
embeddings:
|
|
items:
|
|
items:
|
|
type: number
|
|
type: array
|
|
title: Embeddings
|
|
type: array
|
|
required:
|
|
- embeddings
|
|
title: EmbeddingsResponse
|
|
type: object
|
|
OpenAICompletionLogprobs:
|
|
description: |-
|
|
The log probabilities for the tokens in the message from an OpenAI-compatible completion response.
|
|
|
|
:text_offset: (Optional) The offset of the token in the text
|
|
:token_logprobs: (Optional) The log probabilities for the tokens
|
|
:tokens: (Optional) The tokens
|
|
:top_logprobs: (Optional) The top log probabilities for the tokens
|
|
properties:
|
|
text_offset:
|
|
anyOf:
|
|
- items:
|
|
type: integer
|
|
type: array
|
|
- type: 'null'
|
|
nullable: true
|
|
token_logprobs:
|
|
anyOf:
|
|
- items:
|
|
type: number
|
|
type: array
|
|
- type: 'null'
|
|
nullable: true
|
|
tokens:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
nullable: true
|
|
top_logprobs:
|
|
anyOf:
|
|
- items:
|
|
additionalProperties:
|
|
type: number
|
|
type: object
|
|
type: array
|
|
- type: 'null'
|
|
nullable: true
|
|
title: OpenAICompletionLogprobs
|
|
type: object
|
|
VectorStoreCreateRequest:
|
|
description: Request to create a vector store.
|
|
properties:
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
file_ids:
|
|
items:
|
|
type: string
|
|
title: File Ids
|
|
type: array
|
|
expires_after:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
nullable: true
|
|
chunking_strategy:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
nullable: true
|
|
metadata:
|
|
additionalProperties: true
|
|
title: Metadata
|
|
type: object
|
|
title: VectorStoreCreateRequest
|
|
type: object
|
|
VectorStoreModifyRequest:
|
|
description: Request to modify a vector store.
|
|
properties:
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
expires_after:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
nullable: true
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
nullable: true
|
|
title: VectorStoreModifyRequest
|
|
type: object
|
|
VectorStoreSearchRequest:
|
|
description: Request to search a vector store.
|
|
properties:
|
|
query:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: list[string]
|
|
title: string | list[string]
|
|
filters:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
nullable: true
|
|
max_num_results:
|
|
default: 10
|
|
title: Max Num Results
|
|
type: integer
|
|
ranking_options:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
nullable: true
|
|
rewrite_query:
|
|
default: false
|
|
title: Rewrite Query
|
|
type: boolean
|
|
required:
|
|
- query
|
|
title: VectorStoreSearchRequest
|
|
type: object
|
|
DialogType:
|
|
description: Parameter type for dialog data with semantic output labels.
|
|
properties:
|
|
type:
|
|
const: dialog
|
|
default: dialog
|
|
title: Type
|
|
type: string
|
|
title: DialogType
|
|
type: object
|
|
ConversationMessage:
|
|
description: OpenAI-compatible message item for conversations.
|
|
properties:
|
|
id:
|
|
description: unique identifier for this message
|
|
title: Id
|
|
type: string
|
|
content:
|
|
description: message content
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Content
|
|
type: array
|
|
role:
|
|
description: message role
|
|
title: Role
|
|
type: string
|
|
status:
|
|
description: message status
|
|
title: Status
|
|
type: string
|
|
type:
|
|
const: message
|
|
default: message
|
|
title: Type
|
|
type: string
|
|
object:
|
|
const: message
|
|
default: message
|
|
title: Object
|
|
type: string
|
|
required:
|
|
- id
|
|
- content
|
|
- role
|
|
- status
|
|
title: ConversationMessage
|
|
type: object
|
|
ConversationItemCreateRequest:
|
|
description: Request body for creating conversation items.
|
|
properties:
|
|
items:
|
|
description: Items to include in the conversation context. You may add up to 20 items at a time.
|
|
items:
|
|
discriminator:
|
|
mapping:
|
|
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
message: '#/components/schemas/OpenAIResponseMessage'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
propertyName: type
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage'
|
|
title: OpenAIResponseMessage
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
title: OpenAIResponseInputFunctionToolCallOutput
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
title: OpenAIResponseMCPApprovalRequest
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
title: OpenAIResponseMCPApprovalResponse
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
title: OpenAIResponseMessage | ... (9 variants)
|
|
maxItems: 20
|
|
title: Items
|
|
type: array
|
|
required:
|
|
- items
|
|
title: ConversationItemCreateRequest
|
|
type: object
|
|
ToolGroupInput:
|
|
description: Input data for registering a tool group.
|
|
properties:
|
|
toolgroup_id:
|
|
title: Toolgroup Id
|
|
type: string
|
|
provider_id:
|
|
title: Provider Id
|
|
type: string
|
|
args:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
nullable: true
|
|
mcp_endpoint:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/URL'
|
|
title: URL
|
|
- type: 'null'
|
|
nullable: true
|
|
title: URL
|
|
required:
|
|
- toolgroup_id
|
|
- provider_id
|
|
title: ToolGroupInput
|
|
type: object
|
|
Api:
|
|
description: Enumeration of all available APIs in the Llama Stack system.
|
|
enum:
|
|
- providers
|
|
- inference
|
|
- safety
|
|
- agents
|
|
- batches
|
|
- vector_io
|
|
- datasetio
|
|
- scoring
|
|
- eval
|
|
- post_training
|
|
- tool_runtime
|
|
- models
|
|
- shields
|
|
- vector_stores
|
|
- datasets
|
|
- scoring_functions
|
|
- benchmarks
|
|
- tool_groups
|
|
- files
|
|
- prompts
|
|
- conversations
|
|
- inspect
|
|
title: Api
|
|
type: string
|
|
ProviderSpec:
|
|
properties:
|
|
api:
|
|
$ref: '#/components/schemas/Api'
|
|
provider_type:
|
|
title: Provider Type
|
|
type: string
|
|
config_class:
|
|
description: Fully-qualified classname of the config for this provider
|
|
title: Config Class
|
|
type: string
|
|
api_dependencies:
|
|
description: Higher-level API surfaces may depend on other providers to provide their functionality
|
|
items:
|
|
$ref: '#/components/schemas/Api'
|
|
title: Api Dependencies
|
|
type: array
|
|
optional_api_dependencies:
|
|
items:
|
|
$ref: '#/components/schemas/Api'
|
|
title: Optional Api Dependencies
|
|
type: array
|
|
deprecation_warning:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: If this provider is deprecated, specify the warning message here
|
|
nullable: true
|
|
deprecation_error:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: If this provider is deprecated and does NOT work, specify the error message here
|
|
nullable: true
|
|
module:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: |2-
|
|
|
|
Fully-qualified name of the module to import. The module is expected to have:
|
|
|
|
- `get_adapter_impl(config, deps)`: returns the adapter implementation
|
|
|
|
Example: `module: ramalama_stack`
|
|
|
|
nullable: true
|
|
pip_packages:
|
|
description: The pip dependencies needed for this implementation
|
|
items:
|
|
type: string
|
|
title: Pip Packages
|
|
type: array
|
|
provider_data_validator:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
is_external:
|
|
default: false
|
|
description: Notes whether this provider is an external provider.
|
|
title: Is External
|
|
type: boolean
|
|
deps__:
|
|
items:
|
|
type: string
|
|
title: Deps
|
|
type: array
|
|
required:
|
|
- api
|
|
- provider_type
|
|
- config_class
|
|
title: ProviderSpec
|
|
type: object
|
|
InlineProviderSpec:
|
|
properties:
|
|
api:
|
|
$ref: '#/components/schemas/Api'
|
|
provider_type:
|
|
title: Provider Type
|
|
type: string
|
|
config_class:
|
|
description: Fully-qualified classname of the config for this provider
|
|
title: Config Class
|
|
type: string
|
|
api_dependencies:
|
|
description: Higher-level API surfaces may depend on other providers to provide their functionality
|
|
items:
|
|
$ref: '#/components/schemas/Api'
|
|
title: Api Dependencies
|
|
type: array
|
|
optional_api_dependencies:
|
|
items:
|
|
$ref: '#/components/schemas/Api'
|
|
title: Optional Api Dependencies
|
|
type: array
|
|
deprecation_warning:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: If this provider is deprecated, specify the warning message here
|
|
nullable: true
|
|
deprecation_error:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: If this provider is deprecated and does NOT work, specify the error message here
|
|
nullable: true
|
|
module:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: |2-
|
|
|
|
Fully-qualified name of the module to import. The module is expected to have:
|
|
|
|
- `get_adapter_impl(config, deps)`: returns the adapter implementation
|
|
|
|
Example: `module: ramalama_stack`
|
|
|
|
nullable: true
|
|
pip_packages:
|
|
description: The pip dependencies needed for this implementation
|
|
items:
|
|
type: string
|
|
title: Pip Packages
|
|
type: array
|
|
provider_data_validator:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
is_external:
|
|
default: false
|
|
description: Notes whether this provider is an external provider.
|
|
title: Is External
|
|
type: boolean
|
|
deps__:
|
|
items:
|
|
type: string
|
|
title: Deps
|
|
type: array
|
|
container_image:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: |2
|
|
|
|
The container image to use for this implementation. If one is provided, pip_packages will be ignored.
|
|
If a provider depends on other providers, the dependencies MUST NOT specify a container image.
|
|
nullable: true
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: |2
|
|
|
|
A description of the provider. This is used to display in the documentation.
|
|
nullable: true
|
|
required:
|
|
- api
|
|
- provider_type
|
|
- config_class
|
|
title: InlineProviderSpec
|
|
type: object
|
|
RemoteProviderSpec:
|
|
properties:
|
|
api:
|
|
$ref: '#/components/schemas/Api'
|
|
provider_type:
|
|
title: Provider Type
|
|
type: string
|
|
config_class:
|
|
description: Fully-qualified classname of the config for this provider
|
|
title: Config Class
|
|
type: string
|
|
api_dependencies:
|
|
description: Higher-level API surfaces may depend on other providers to provide their functionality
|
|
items:
|
|
$ref: '#/components/schemas/Api'
|
|
title: Api Dependencies
|
|
type: array
|
|
optional_api_dependencies:
|
|
items:
|
|
$ref: '#/components/schemas/Api'
|
|
title: Optional Api Dependencies
|
|
type: array
|
|
deprecation_warning:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: If this provider is deprecated, specify the warning message here
|
|
nullable: true
|
|
deprecation_error:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: If this provider is deprecated and does NOT work, specify the error message here
|
|
nullable: true
|
|
module:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: |2-
|
|
|
|
Fully-qualified name of the module to import. The module is expected to have:
|
|
|
|
- `get_adapter_impl(config, deps)`: returns the adapter implementation
|
|
|
|
Example: `module: ramalama_stack`
|
|
|
|
nullable: true
|
|
pip_packages:
|
|
description: The pip dependencies needed for this implementation
|
|
items:
|
|
type: string
|
|
title: Pip Packages
|
|
type: array
|
|
provider_data_validator:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
is_external:
|
|
default: false
|
|
description: Notes whether this provider is an external provider.
|
|
title: Is External
|
|
type: boolean
|
|
deps__:
|
|
items:
|
|
type: string
|
|
title: Deps
|
|
type: array
|
|
adapter_type:
|
|
description: Unique identifier for this adapter
|
|
title: Adapter Type
|
|
type: string
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: |2
|
|
|
|
A description of the provider. This is used to display in the documentation.
|
|
nullable: true
|
|
required:
|
|
- api
|
|
- provider_type
|
|
- config_class
|
|
- adapter_type
|
|
title: RemoteProviderSpec
|
|
type: object
|
|
PostTrainingJobLogStream:
|
|
description: Stream of logs from a finetuning job.
|
|
properties:
|
|
job_uuid:
|
|
title: Job Uuid
|
|
type: string
|
|
log_lines:
|
|
items:
|
|
type: string
|
|
title: Log Lines
|
|
type: array
|
|
required:
|
|
- job_uuid
|
|
- log_lines
|
|
title: PostTrainingJobLogStream
|
|
type: object
|
|
RLHFAlgorithm:
|
|
description: Available reinforcement learning from human feedback algorithms.
|
|
enum:
|
|
- dpo
|
|
title: RLHFAlgorithm
|
|
type: string
|
|
PostTrainingRLHFRequest:
|
|
description: Request to finetune a model using reinforcement learning from human feedback.
|
|
properties:
|
|
job_uuid:
|
|
title: Job Uuid
|
|
type: string
|
|
finetuned_model:
|
|
$ref: '#/components/schemas/URL'
|
|
dataset_id:
|
|
title: Dataset Id
|
|
type: string
|
|
validation_dataset_id:
|
|
title: Validation Dataset Id
|
|
type: string
|
|
algorithm:
|
|
$ref: '#/components/schemas/RLHFAlgorithm'
|
|
algorithm_config:
|
|
$ref: '#/components/schemas/DPOAlignmentConfig'
|
|
optimizer_config:
|
|
$ref: '#/components/schemas/OptimizerConfig'
|
|
training_config:
|
|
$ref: '#/components/schemas/TrainingConfig'
|
|
hyperparam_search_config:
|
|
additionalProperties: true
|
|
title: Hyperparam Search Config
|
|
type: object
|
|
logger_config:
|
|
additionalProperties: true
|
|
title: Logger Config
|
|
type: object
|
|
required:
|
|
- job_uuid
|
|
- finetuned_model
|
|
- dataset_id
|
|
- validation_dataset_id
|
|
- algorithm
|
|
- algorithm_config
|
|
- optimizer_config
|
|
- training_config
|
|
- hyperparam_search_config
|
|
- logger_config
|
|
title: PostTrainingRLHFRequest
|
|
type: object
|
|
Span:
|
|
description: A span representing a single operation within a trace.
|
|
properties:
|
|
span_id:
|
|
title: Span Id
|
|
type: string
|
|
trace_id:
|
|
title: Trace Id
|
|
type: string
|
|
parent_span_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
name:
|
|
title: Name
|
|
type: string
|
|
start_time:
|
|
format: date-time
|
|
title: Start Time
|
|
type: string
|
|
end_time:
|
|
anyOf:
|
|
- format: date-time
|
|
type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
required:
|
|
- span_id
|
|
- trace_id
|
|
- name
|
|
- start_time
|
|
title: Span
|
|
type: object
|
|
Trace:
|
|
description: A trace representing the complete execution path of a request across multiple operations.
|
|
properties:
|
|
trace_id:
|
|
title: Trace Id
|
|
type: string
|
|
root_span_id:
|
|
title: Root Span Id
|
|
type: string
|
|
start_time:
|
|
format: date-time
|
|
title: Start Time
|
|
type: string
|
|
end_time:
|
|
anyOf:
|
|
- format: date-time
|
|
type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
required:
|
|
- trace_id
|
|
- root_span_id
|
|
- start_time
|
|
title: Trace
|
|
type: object
|
|
EventType:
|
|
description: The type of telemetry event being logged.
|
|
enum:
|
|
- unstructured_log
|
|
- structured_log
|
|
- metric
|
|
title: EventType
|
|
type: string
|
|
StructuredLogType:
|
|
description: The type of structured log event payload.
|
|
enum:
|
|
- span_start
|
|
- span_end
|
|
title: StructuredLogType
|
|
type: string
|
|
EvalTrace:
|
|
description: A trace record for evaluation purposes.
|
|
properties:
|
|
session_id:
|
|
title: Session Id
|
|
type: string
|
|
step:
|
|
title: Step
|
|
type: string
|
|
input:
|
|
title: Input
|
|
type: string
|
|
output:
|
|
title: Output
|
|
type: string
|
|
expected_output:
|
|
title: Expected Output
|
|
type: string
|
|
required:
|
|
- session_id
|
|
- step
|
|
- input
|
|
- output
|
|
- expected_output
|
|
title: EvalTrace
|
|
type: object
|
|
SpanWithStatus:
|
|
description: A span that includes status information.
|
|
properties:
|
|
span_id:
|
|
title: Span Id
|
|
type: string
|
|
trace_id:
|
|
title: Trace Id
|
|
type: string
|
|
parent_span_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
name:
|
|
title: Name
|
|
type: string
|
|
start_time:
|
|
format: date-time
|
|
title: Start Time
|
|
type: string
|
|
end_time:
|
|
anyOf:
|
|
- format: date-time
|
|
type: string
|
|
- type: 'null'
|
|
nullable: true
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
status:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/SpanStatus'
|
|
title: SpanStatus
|
|
- type: 'null'
|
|
nullable: true
|
|
title: SpanStatus
|
|
required:
|
|
- span_id
|
|
- trace_id
|
|
- name
|
|
- start_time
|
|
title: SpanWithStatus
|
|
type: object
|
|
QueryConditionOp:
|
|
description: Comparison operators for query conditions.
|
|
enum:
|
|
- eq
|
|
- ne
|
|
- gt
|
|
- lt
|
|
title: QueryConditionOp
|
|
type: string
|
|
QueryCondition:
|
|
description: A condition for filtering query results.
|
|
properties:
|
|
key:
|
|
title: Key
|
|
type: string
|
|
op:
|
|
$ref: '#/components/schemas/QueryConditionOp'
|
|
value:
|
|
title: Value
|
|
required:
|
|
- key
|
|
- op
|
|
- value
|
|
title: QueryCondition
|
|
type: object
|
|
MetricLabel:
|
|
description: A label associated with a metric.
|
|
properties:
|
|
name:
|
|
title: Name
|
|
type: string
|
|
value:
|
|
title: Value
|
|
type: string
|
|
required:
|
|
- name
|
|
- value
|
|
title: MetricLabel
|
|
type: object
|
|
MetricDataPoint:
|
|
description: A single data point in a metric time series.
|
|
properties:
|
|
timestamp:
|
|
title: Timestamp
|
|
type: integer
|
|
value:
|
|
title: Value
|
|
type: number
|
|
unit:
|
|
title: Unit
|
|
type: string
|
|
required:
|
|
- timestamp
|
|
- value
|
|
- unit
|
|
title: MetricDataPoint
|
|
type: object
|
|
MetricSeries:
|
|
description: A time series of metric data points.
|
|
properties:
|
|
metric:
|
|
title: Metric
|
|
type: string
|
|
labels:
|
|
items:
|
|
$ref: '#/components/schemas/MetricLabel'
|
|
title: Labels
|
|
type: array
|
|
values:
|
|
items:
|
|
$ref: '#/components/schemas/MetricDataPoint'
|
|
title: Values
|
|
type: array
|
|
required:
|
|
- metric
|
|
- labels
|
|
- values
|
|
title: MetricSeries
|
|
type: object
|
|
responses:
|
|
BadRequest400:
|
|
description: The request was invalid or malformed
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
example:
|
|
status: 400
|
|
title: Bad Request
|
|
detail: The request was invalid or malformed
|
|
TooManyRequests429:
|
|
description: The client has sent too many requests in a given amount of time
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
example:
|
|
status: 429
|
|
title: Too Many Requests
|
|
detail: You have exceeded the rate limit. Please try again later.
|
|
InternalServerError500:
|
|
description: The server encountered an unexpected error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
example:
|
|
status: 500
|
|
title: Internal Server Error
|
|
detail: An unexpected error occurred
|
|
DefaultError:
|
|
description: An error occurred
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
tags:
|
|
- description: APIs for creating and interacting with agentic systems.
|
|
name: Agents
|
|
x-displayName: Agents
|
|
- description: |-
|
|
The API is designed to allow use of openai client libraries for seamless integration.
|
|
|
|
This API provides the following extensions:
|
|
- idempotent batch creation
|
|
|
|
Note: This API is currently under active development and may undergo changes.
|
|
name: Batches
|
|
x-displayName: The Batches API enables efficient processing of multiple requests in a single operation, particularly useful for processing large datasets, batch evaluation workflows, and cost-effective inference at scale.
|
|
- description: ''
|
|
name: Benchmarks
|
|
- description: Protocol for conversation management operations.
|
|
name: Conversations
|
|
x-displayName: Conversations
|
|
- description: ''
|
|
name: DatasetIO
|
|
- description: ''
|
|
name: Datasets
|
|
- description: Llama Stack Evaluation API for running evaluations on model and agent candidates.
|
|
name: Eval
|
|
x-displayName: Evaluations
|
|
- description: This API is used to upload documents that can be used with other Llama Stack APIs.
|
|
name: Files
|
|
x-displayName: Files
|
|
- description: |-
|
|
Llama Stack Inference API for generating completions, chat completions, and embeddings.
|
|
|
|
This API provides the raw interface to the underlying models. Three kinds of models are supported:
|
|
- LLM models: these models generate "raw" and "chat" (conversational) completions.
|
|
- Embedding models: these models generate embeddings to be used for semantic search.
|
|
- Rerank models: these models reorder the documents based on their relevance to a query.
|
|
name: Inference
|
|
x-displayName: Inference
|
|
- description: APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
|
|
name: Inspect
|
|
x-displayName: Inspect
|
|
- description: ''
|
|
name: Models
|
|
- description: ''
|
|
name: PostTraining (Coming Soon)
|
|
- description: Protocol for prompt management operations.
|
|
name: Prompts
|
|
x-displayName: Prompts
|
|
- description: Providers API for inspecting, listing, and modifying providers and their configurations.
|
|
name: Providers
|
|
x-displayName: Providers
|
|
- description: OpenAI-compatible Moderations API.
|
|
name: Safety
|
|
x-displayName: Safety
|
|
- description: ''
|
|
name: Scoring
|
|
- description: ''
|
|
name: ScoringFunctions
|
|
- description: ''
|
|
name: Shields
|
|
- description: ''
|
|
name: ToolGroups
|
|
- description: ''
|
|
name: ToolRuntime
|
|
- description: ''
|
|
name: VectorIO
|
|
x-tagGroups:
|
|
- name: Operations
|
|
tags:
|
|
- Agents
|
|
- Batches
|
|
- Benchmarks
|
|
- Conversations
|
|
- DatasetIO
|
|
- Datasets
|
|
- Eval
|
|
- Files
|
|
- Inference
|
|
- Inspect
|
|
- Models
|
|
- PostTraining (Coming Soon)
|
|
- Prompts
|
|
- Providers
|
|
- Safety
|
|
- Scoring
|
|
- ScoringFunctions
|
|
- Shields
|
|
- ToolGroups
|
|
- ToolRuntime
|
|
- VectorIO
|
|
security:
|
|
- Default: []
|