phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-10-04 04:04:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: update OpenAPI generator (#3527)

Browse source 
# What does this PR do?

<!-- Provide a short summary of what this PR does and why. Link to relevant issues if applicable. -->

<!-- If resolving an issue, uncomment and update the line below -->

<!-- Closes #[issue-number] -->

Updates OpenAPI generator to use summaries and changed the file generation path. 

## Test Plan

- docs/openapi_generator/run_openapi_generator.sh

<!-- Describe the tests you ran to verify your changes with result summaries. *Provide clear instructions so the plan can be easily re-executed.* -->
This commit is contained in:
Alexey Rybak 2025-09-24 13:57:27 -07:00 • committed by GitHub
parent 914c8cb605
commit 0a7d1adfee
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 289 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/openapi_generator/pyopenapi/generator.py
View file

@ -9,7 +9,9 @@ import ipaddress
import types import types
import typing import typing
from dataclasses import make_dataclass from dataclasses import make_dataclass
from typing import Any, Dict, Set, Union from typing import Annotated, Any, Dict, get_args, get_origin, Set, Union
from fastapi import UploadFile
from llama_stack.apis.datatypes import Error from llama_stack.apis.datatypes import Error
from llama_stack.strong_typing.core import JsonType from llama_stack.strong_typing.core import JsonType
@ -30,9 +32,6 @@ from llama_stack.strong_typing.schema import (
Schema, Schema,
SchemaOptions, SchemaOptions,
) )
from typing import get_origin, get_args
from typing import Annotated
from fastapi import UploadFile
from llama_stack.strong_typing.serialization import json_dump_string, object_to_json from llama_stack.strong_typing.serialization import json_dump_string, object_to_json
from .operations import ( from .operations import (
@ -636,10 +635,7 @@ class Generator:
base_type = param_type base_type = param_type
if base_type is UploadFile: if base_type is UploadFile:
# File upload # File upload
properties[name] = { properties[name] = {"type": "string", "format": "binary"}
"type": "string",
"format": "binary"
}
else: else:
# Form field # Form field
properties[name] = self.schema_builder.classdef_to_ref(base_type) properties[name] = self.schema_builder.classdef_to_ref(base_type)
@ -649,15 +645,11 @@ class Generator:
multipart_schema = { multipart_schema = {
"type": "object", "type": "object",
"properties": properties, "properties": properties,
"required": required_fields "required": required_fields,
} }
requestBody = RequestBody( requestBody = RequestBody(
content={ content={"multipart/form-data": {"schema": multipart_schema}},
"multipart/form-data": {
"schema": multipart_schema
}
},
required=True, required=True,
) )
# data passed in payload as JSON and mapped to request parameters # data passed in payload as JSON and mapped to request parameters
@ -801,9 +793,10 @@ class Generator:
) )
return Operation( return Operation(
tags=[getattr(op.defining_class, "API_NAMESPACE", op.defining_class.__name__)], tags=[
summary=None, getattr(op.defining_class, "API_NAMESPACE", op.defining_class.__name__)
# summary=doc_string.short_description, ],
summary=doc_string.short_description,
description=description, description=description,
parameters=parameters, parameters=parameters,
requestBody=requestBody, requestBody=requestBody,

2
docs/openapi_generator/run_openapi_generator.sh
View file

@ -29,4 +29,4 @@ fi
stack_dir=$(dirname $(dirname $THIS_DIR)) stack_dir=$(dirname $(dirname $THIS_DIR))
PYTHONPATH=$PYTHONPATH:$stack_dir \ PYTHONPATH=$PYTHONPATH:$stack_dir \
python -m docs.openapi_generator.generate $(dirname $THIS_DIR)/_static python -m docs.openapi_generator.generate $(dirname $THIS_DIR)/static

120
docs/_static/llama-stack-spec.html → docs/static/llama-stack-spec.html vendored
View file

@ -62,6 +62,7 @@
"tags": [ "tags": [
"DatasetIO" "DatasetIO"
], ],
"summary": "Append rows to a dataset.",
"description": "Append rows to a dataset.", "description": "Append rows to a dataset.",
"parameters": [ "parameters": [
{ {
@ -115,6 +116,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "Generate chat completions for a batch of messages using the specified model.",
"description": "Generate chat completions for a batch of messages using the specified model.", "description": "Generate chat completions for a batch of messages using the specified model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -158,6 +160,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "Generate completions for a batch of content using the specified model.",
"description": "Generate completions for a batch of content using the specified model.", "description": "Generate completions for a batch of content using the specified model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -194,6 +197,7 @@
"tags": [ "tags": [
"PostTraining (Coming Soon)" "PostTraining (Coming Soon)"
], ],
"summary": "Cancel a training job.",
"description": "Cancel a training job.", "description": "Cancel a training job.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -242,6 +246,7 @@
"tags": [ "tags": [
"BatchInference (Coming Soon)" "BatchInference (Coming Soon)"
], ],
"summary": "Generate a chat completion for the given messages using the specified model.",
"description": "Generate a chat completion for the given messages using the specified model.", "description": "Generate a chat completion for the given messages using the specified model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -290,6 +295,7 @@
"tags": [ "tags": [
"BatchInference (Coming Soon)" "BatchInference (Coming Soon)"
], ],
"summary": "Generate a completion for the given content using the specified model.",
"description": "Generate a completion for the given content using the specified model.", "description": "Generate a completion for the given content using the specified model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -333,6 +339,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "List all agents.",
"description": "List all agents.", "description": "List all agents.",
"parameters": [ "parameters": [
{ {
@ -383,6 +390,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Create an agent with the given configuration.",
"description": "Create an agent with the given configuration.", "description": "Create an agent with the given configuration.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -426,6 +434,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Create a new session for an agent.",
"description": "Create a new session for an agent.", "description": "Create a new session for an agent.",
"parameters": [ "parameters": [
{ {
@ -484,6 +493,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Create a new turn for an agent.",
"description": "Create a new turn for an agent.", "description": "Create a new turn for an agent.",
"parameters": [ "parameters": [
{ {
@ -546,6 +556,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "List all OpenAI responses.",
"description": "List all OpenAI responses.", "description": "List all OpenAI responses.",
"parameters": [ "parameters": [
{ {
@ -619,6 +630,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Create a new OpenAI response.",
"description": "Create a new OpenAI response.", "description": "Create a new OpenAI response.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -662,6 +674,7 @@
"tags": [ "tags": [
"Prompts" "Prompts"
], ],
"summary": "List all prompts.",
"description": "List all prompts.", "description": "List all prompts.",
"parameters": [] "parameters": []
}, },
@ -693,6 +706,7 @@
"tags": [ "tags": [
"Prompts" "Prompts"
], ],
"summary": "Create a new prompt.",
"description": "Create a new prompt.", "description": "Create a new prompt.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -736,6 +750,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Describe an agent by its ID.",
"description": "Describe an agent by its ID.", "description": "Describe an agent by its ID.",
"parameters": [ "parameters": [
{ {
@ -770,6 +785,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Delete an agent by its ID and its associated sessions and turns.",
"description": "Delete an agent by its ID and its associated sessions and turns.", "description": "Delete an agent by its ID and its associated sessions and turns.",
"parameters": [ "parameters": [
{ {
@ -813,6 +829,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Retrieve an agent session by its ID.",
"description": "Retrieve an agent session by its ID.", "description": "Retrieve an agent session by its ID.",
"parameters": [ "parameters": [
{ {
@ -868,6 +885,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Delete an agent session by its ID and its associated turns.",
"description": "Delete an agent session by its ID and its associated turns.", "description": "Delete an agent session by its ID and its associated turns.",
"parameters": [ "parameters": [
{ {
@ -920,6 +938,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Retrieve an OpenAI response by its ID.",
"description": "Retrieve an OpenAI response by its ID.", "description": "Retrieve an OpenAI response by its ID.",
"parameters": [ "parameters": [
{ {
@ -961,6 +980,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Delete an OpenAI response by its ID.",
"description": "Delete an OpenAI response by its ID.", "description": "Delete an OpenAI response by its ID.",
"parameters": [ "parameters": [
{ {
@ -1004,6 +1024,7 @@
"tags": [ "tags": [
"Prompts" "Prompts"
], ],
"summary": "Get a prompt by its identifier and optional version.",
"description": "Get a prompt by its identifier and optional version.", "description": "Get a prompt by its identifier and optional version.",
"parameters": [ "parameters": [
{ {
@ -1054,6 +1075,7 @@
"tags": [ "tags": [
"Prompts" "Prompts"
], ],
"summary": "Update an existing prompt (increments version).",
"description": "Update an existing prompt (increments version).", "description": "Update an existing prompt (increments version).",
"parameters": [ "parameters": [
{ {
@ -1098,6 +1120,7 @@
"tags": [ "tags": [
"Prompts" "Prompts"
], ],
"summary": "Delete a prompt.",
"description": "Delete a prompt.", "description": "Delete a prompt.",
"parameters": [ "parameters": [
{ {
@ -1141,6 +1164,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "Generate embeddings for content pieces using the specified model.",
"description": "Generate embeddings for content pieces using the specified model.", "description": "Generate embeddings for content pieces using the specified model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -1184,6 +1208,7 @@
"tags": [ "tags": [
"Eval" "Eval"
], ],
"summary": "Evaluate a list of rows on a benchmark.",
"description": "Evaluate a list of rows on a benchmark.", "description": "Evaluate a list of rows on a benchmark.",
"parameters": [ "parameters": [
{ {
@ -1237,6 +1262,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Retrieve an agent step by its ID.",
"description": "Retrieve an agent step by its ID.", "description": "Retrieve an agent step by its ID.",
"parameters": [ "parameters": [
{ {
@ -1307,6 +1333,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Retrieve an agent turn by its ID.",
"description": "Retrieve an agent turn by its ID.", "description": "Retrieve an agent turn by its ID.",
"parameters": [ "parameters": [
{ {
@ -1368,6 +1395,7 @@
"tags": [ "tags": [
"Benchmarks" "Benchmarks"
], ],
"summary": "Get a benchmark by its ID.",
"description": "Get a benchmark by its ID.", "description": "Get a benchmark by its ID.",
"parameters": [ "parameters": [
{ {
@ -1402,6 +1430,7 @@
"tags": [ "tags": [
"Benchmarks" "Benchmarks"
], ],
"summary": "Unregister a benchmark.",
"description": "Unregister a benchmark.", "description": "Unregister a benchmark.",
"parameters": [ "parameters": [
{ {
@ -1445,6 +1474,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "Describe a chat completion by its ID.",
"description": "Describe a chat completion by its ID.", "description": "Describe a chat completion by its ID.",
"parameters": [ "parameters": [
{ {
@ -1488,6 +1518,7 @@
"tags": [ "tags": [
"Datasets" "Datasets"
], ],
"summary": "Get a dataset by its ID.",
"description": "Get a dataset by its ID.", "description": "Get a dataset by its ID.",
"parameters": [ "parameters": [
{ {
@ -1522,6 +1553,7 @@
"tags": [ "tags": [
"Datasets" "Datasets"
], ],
"summary": "Unregister a dataset by its ID.",
"description": "Unregister a dataset by its ID.", "description": "Unregister a dataset by its ID.",
"parameters": [ "parameters": [
{ {
@ -1565,6 +1597,7 @@
"tags": [ "tags": [
"Models" "Models"
], ],
"summary": "Get a model by its identifier.",
"description": "Get a model by its identifier.", "description": "Get a model by its identifier.",
"parameters": [ "parameters": [
{ {
@ -1599,6 +1632,7 @@
"tags": [ "tags": [
"Models" "Models"
], ],
"summary": "Unregister a model.",
"description": "Unregister a model.", "description": "Unregister a model.",
"parameters": [ "parameters": [
{ {
@ -1642,6 +1676,7 @@
"tags": [ "tags": [
"ScoringFunctions" "ScoringFunctions"
], ],
"summary": "Get a scoring function by its ID.",
"description": "Get a scoring function by its ID.", "description": "Get a scoring function by its ID.",
"parameters": [ "parameters": [
{ {
@ -1676,6 +1711,7 @@
"tags": [ "tags": [
"ScoringFunctions" "ScoringFunctions"
], ],
"summary": "Unregister a scoring function.",
"description": "Unregister a scoring function.", "description": "Unregister a scoring function.",
"parameters": [ "parameters": [
{ {
@ -1719,6 +1755,7 @@
"tags": [ "tags": [
"Shields" "Shields"
], ],
"summary": "Get a shield by its identifier.",
"description": "Get a shield by its identifier.", "description": "Get a shield by its identifier.",
"parameters": [ "parameters": [
{ {
@ -1753,6 +1790,7 @@
"tags": [ "tags": [
"Shields" "Shields"
], ],
"summary": "Unregister a shield.",
"description": "Unregister a shield.", "description": "Unregister a shield.",
"parameters": [ "parameters": [
{ {
@ -1796,6 +1834,7 @@
"tags": [ "tags": [
"Telemetry" "Telemetry"
], ],
"summary": "Get a span by its ID.",
"description": "Get a span by its ID.", "description": "Get a span by its ID.",
"parameters": [ "parameters": [
{ {
@ -1848,6 +1887,7 @@
"tags": [ "tags": [
"Telemetry" "Telemetry"
], ],
"summary": "Get a span tree by its ID.",
"description": "Get a span tree by its ID.", "description": "Get a span tree by its ID.",
"parameters": [ "parameters": [
{ {
@ -1901,6 +1941,7 @@
"tags": [ "tags": [
"ToolGroups" "ToolGroups"
], ],
"summary": "Get a tool by its name.",
"description": "Get a tool by its name.", "description": "Get a tool by its name.",
"parameters": [ "parameters": [
{ {
@ -1944,6 +1985,7 @@
"tags": [ "tags": [
"ToolGroups" "ToolGroups"
], ],
"summary": "Get a tool group by its ID.",
"description": "Get a tool group by its ID.", "description": "Get a tool group by its ID.",
"parameters": [ "parameters": [
{ {
@ -1978,6 +2020,7 @@
"tags": [ "tags": [
"ToolGroups" "ToolGroups"
], ],
"summary": "Unregister a tool group.",
"description": "Unregister a tool group.", "description": "Unregister a tool group.",
"parameters": [ "parameters": [
{ {
@ -2021,6 +2064,7 @@
"tags": [ "tags": [
"Telemetry" "Telemetry"
], ],
"summary": "Get a trace by its ID.",
"description": "Get a trace by its ID.", "description": "Get a trace by its ID.",
"parameters": [ "parameters": [
{ {
@ -2064,6 +2108,7 @@
"tags": [ "tags": [
"PostTraining (Coming Soon)" "PostTraining (Coming Soon)"
], ],
"summary": "Get the artifacts of a training job.",
"description": "Get the artifacts of a training job.", "description": "Get the artifacts of a training job.",
"parameters": [ "parameters": [
{ {
@ -2107,6 +2152,7 @@
"tags": [ "tags": [
"PostTraining (Coming Soon)" "PostTraining (Coming Soon)"
], ],
"summary": "Get the status of a training job.",
"description": "Get the status of a training job.", "description": "Get the status of a training job.",
"parameters": [ "parameters": [
{ {
@ -2150,6 +2196,7 @@
"tags": [ "tags": [
"PostTraining (Coming Soon)" "PostTraining (Coming Soon)"
], ],
"summary": "Get all training jobs.",
"description": "Get all training jobs.", "description": "Get all training jobs.",
"parameters": [] "parameters": []
} }
@ -2183,6 +2230,7 @@
"tags": [ "tags": [
"VectorDBs" "VectorDBs"
], ],
"summary": "Get a vector database by its identifier.",
"description": "Get a vector database by its identifier.", "description": "Get a vector database by its identifier.",
"parameters": [ "parameters": [
{ {
@ -2217,6 +2265,7 @@
"tags": [ "tags": [
"VectorDBs" "VectorDBs"
], ],
"summary": "Unregister a vector database.",
"description": "Unregister a vector database.", "description": "Unregister a vector database.",
"parameters": [ "parameters": [
{ {
@ -2260,6 +2309,7 @@
"tags": [ "tags": [
"Inspect" "Inspect"
], ],
"summary": "Get the current health status of the service.",
"description": "Get the current health status of the service.", "description": "Get the current health status of the service.",
"parameters": [] "parameters": []
} }
@ -2286,6 +2336,7 @@
"tags": [ "tags": [
"ToolRuntime" "ToolRuntime"
], ],
"summary": "Index documents so they can be used by the RAG system.",
"description": "Index documents so they can be used by the RAG system.", "description": "Index documents so they can be used by the RAG system.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -2322,6 +2373,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Insert chunks into a vector database.",
"description": "Insert chunks into a vector database.", "description": "Insert chunks into a vector database.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -2365,6 +2417,7 @@
"tags": [ "tags": [
"Providers" "Providers"
], ],
"summary": "Get detailed information about a specific provider.",
"description": "Get detailed information about a specific provider.", "description": "Get detailed information about a specific provider.",
"parameters": [ "parameters": [
{ {
@ -2408,6 +2461,7 @@
"tags": [ "tags": [
"ToolRuntime" "ToolRuntime"
], ],
"summary": "Run a tool with the given arguments.",
"description": "Run a tool with the given arguments.", "description": "Run a tool with the given arguments.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -2451,6 +2505,7 @@
"tags": [ "tags": [
"DatasetIO" "DatasetIO"
], ],
"summary": "Get a paginated list of rows from a dataset.",
"description": "Get a paginated list of rows from a dataset.\nUses offset-based pagination where:\n- start_index: The starting index (0-based). If None, starts from beginning.\n- limit: Number of items to return. If None or -1, returns all items.\n\nThe response includes:\n- data: List of items for the current page.\n- has_more: Whether there are more items available after this set.", "description": "Get a paginated list of rows from a dataset.\nUses offset-based pagination where:\n- start_index: The starting index (0-based). If None, starts from beginning.\n- limit: Number of items to return. If None or -1, returns all items.\n\nThe response includes:\n- data: List of items for the current page.\n- has_more: Whether there are more items available after this set.",
"parameters": [ "parameters": [
{ {
@ -2512,6 +2567,7 @@
"tags": [ "tags": [
"Eval" "Eval"
], ],
"summary": "Get the status of a job.",
"description": "Get the status of a job.", "description": "Get the status of a job.",
"parameters": [ "parameters": [
{ {
@ -2555,6 +2611,7 @@
"tags": [ "tags": [
"Eval" "Eval"
], ],
"summary": "Cancel a job.",
"description": "Cancel a job.", "description": "Cancel a job.",
"parameters": [ "parameters": [
{ {
@ -2607,6 +2664,7 @@
"tags": [ "tags": [
"Eval" "Eval"
], ],
"summary": "Get the result of a job.",
"description": "Get the result of a job.", "description": "Get the result of a job.",
"parameters": [ "parameters": [
{ {
@ -2659,6 +2717,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "List all session(s) of a given agent.",
"description": "List all session(s) of a given agent.", "description": "List all session(s) of a given agent.",
"parameters": [ "parameters": [
{ {
@ -2720,6 +2779,7 @@
"tags": [ "tags": [
"Benchmarks" "Benchmarks"
], ],
"summary": "List all benchmarks.",
"description": "List all benchmarks.", "description": "List all benchmarks.",
"parameters": [] "parameters": []
}, },
@ -2744,6 +2804,7 @@
"tags": [ "tags": [
"Benchmarks" "Benchmarks"
], ],
"summary": "Register a benchmark.",
"description": "Register a benchmark.", "description": "Register a benchmark.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -2787,6 +2848,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "List all chat completions.",
"description": "List all chat completions.", "description": "List all chat completions.",
"parameters": [ "parameters": [
{ {
@ -2862,6 +2924,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "Generate an OpenAI-compatible chat completion for the given messages using the specified model.",
"description": "Generate an OpenAI-compatible chat completion for the given messages using the specified model.", "description": "Generate an OpenAI-compatible chat completion for the given messages using the specified model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -2905,6 +2968,7 @@
"tags": [ "tags": [
"Datasets" "Datasets"
], ],
"summary": "List all datasets.",
"description": "List all datasets.", "description": "List all datasets.",
"parameters": [] "parameters": []
}, },
@ -2936,6 +3000,7 @@
"tags": [ "tags": [
"Datasets" "Datasets"
], ],
"summary": "Register a new dataset.",
"description": "Register a new dataset.", "description": "Register a new dataset.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -2979,6 +3044,7 @@
"tags": [ "tags": [
"Models" "Models"
], ],
"summary": "List all models.",
"description": "List all models.", "description": "List all models.",
"parameters": [] "parameters": []
}, },
@ -3010,6 +3076,7 @@
"tags": [ "tags": [
"Models" "Models"
], ],
"summary": "Register a model.",
"description": "Register a model.", "description": "Register a model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -3053,6 +3120,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "List input items for a given OpenAI response.",
"description": "List input items for a given OpenAI response.", "description": "List input items for a given OpenAI response.",
"parameters": [ "parameters": [
{ {
@ -3144,6 +3212,7 @@
"tags": [ "tags": [
"Prompts" "Prompts"
], ],
"summary": "List all versions of a specific prompt.",
"description": "List all versions of a specific prompt.", "description": "List all versions of a specific prompt.",
"parameters": [ "parameters": [
{ {
@ -3187,6 +3256,7 @@
"tags": [ "tags": [
"Providers" "Providers"
], ],
"summary": "List all available providers.",
"description": "List all available providers.", "description": "List all available providers.",
"parameters": [] "parameters": []
} }
@ -3220,6 +3290,7 @@
"tags": [ "tags": [
"Inspect" "Inspect"
], ],
"summary": "List all available API routes with their methods and implementing providers.",
"description": "List all available API routes with their methods and implementing providers.", "description": "List all available API routes with their methods and implementing providers.",
"parameters": [] "parameters": []
} }
@ -3253,6 +3324,7 @@
"tags": [ "tags": [
"ToolRuntime" "ToolRuntime"
], ],
"summary": "List all tools in the runtime.",
"description": "List all tools in the runtime.", "description": "List all tools in the runtime.",
"parameters": [ "parameters": [
{ {
@ -3305,6 +3377,7 @@
"tags": [ "tags": [
"ScoringFunctions" "ScoringFunctions"
], ],
"summary": "List all scoring functions.",
"description": "List all scoring functions.", "description": "List all scoring functions.",
"parameters": [] "parameters": []
}, },
@ -3329,6 +3402,7 @@
"tags": [ "tags": [
"ScoringFunctions" "ScoringFunctions"
], ],
"summary": "Register a scoring function.",
"description": "Register a scoring function.", "description": "Register a scoring function.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -3372,6 +3446,7 @@
"tags": [ "tags": [
"Shields" "Shields"
], ],
"summary": "List all shields.",
"description": "List all shields.", "description": "List all shields.",
"parameters": [] "parameters": []
}, },
@ -3403,6 +3478,7 @@
"tags": [ "tags": [
"Shields" "Shields"
], ],
"summary": "Register a shield.",
"description": "Register a shield.", "description": "Register a shield.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -3446,6 +3522,7 @@
"tags": [ "tags": [
"ToolGroups" "ToolGroups"
], ],
"summary": "List tool groups with optional provider.",
"description": "List tool groups with optional provider.", "description": "List tool groups with optional provider.",
"parameters": [] "parameters": []
}, },
@ -3470,6 +3547,7 @@
"tags": [ "tags": [
"ToolGroups" "ToolGroups"
], ],
"summary": "Register a tool group.",
"description": "Register a tool group.", "description": "Register a tool group.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -3513,6 +3591,7 @@
"tags": [ "tags": [
"ToolGroups" "ToolGroups"
], ],
"summary": "List tools with optional tool group.",
"description": "List tools with optional tool group.", "description": "List tools with optional tool group.",
"parameters": [ "parameters": [
{ {
@ -3556,6 +3635,7 @@
"tags": [ "tags": [
"VectorDBs" "VectorDBs"
], ],
"summary": "List all vector databases.",
"description": "List all vector databases.", "description": "List all vector databases.",
"parameters": [] "parameters": []
}, },
@ -3587,6 +3667,7 @@
"tags": [ "tags": [
"VectorDBs" "VectorDBs"
], ],
"summary": "Register a vector database.",
"description": "Register a vector database.", "description": "Register a vector database.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -3623,6 +3704,7 @@
"tags": [ "tags": [
"Telemetry" "Telemetry"
], ],
"summary": "Log an event.",
"description": "Log an event.", "description": "Log an event.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -3666,6 +3748,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "List files in a vector store.",
"description": "List files in a vector store.", "description": "List files in a vector store.",
"parameters": [ "parameters": [
{ {
@ -3752,6 +3835,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Attach a file to a vector store.",
"description": "Attach a file to a vector store.", "description": "Attach a file to a vector store.",
"parameters": [ "parameters": [
{ {
@ -3805,6 +3889,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "Generate an OpenAI-compatible completion for the given prompt using the specified model.",
"description": "Generate an OpenAI-compatible completion for the given prompt using the specified model.", "description": "Generate an OpenAI-compatible completion for the given prompt using the specified model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -3848,6 +3933,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Returns a list of vector stores.",
"description": "Returns a list of vector stores.", "description": "Returns a list of vector stores.",
"parameters": [ "parameters": [
{ {
@ -3916,6 +4002,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Creates a vector store.",
"description": "Creates a vector store.", "description": "Creates a vector store.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -3959,6 +4046,7 @@
"tags": [ "tags": [
"Files" "Files"
], ],
"summary": "Returns information about a specific file.",
"description": "Returns information about a specific file.", "description": "Returns information about a specific file.",
"parameters": [ "parameters": [
{ {
@ -4000,6 +4088,7 @@
"tags": [ "tags": [
"Files" "Files"
], ],
"summary": "Delete a file.",
"description": "Delete a file.", "description": "Delete a file.",
"parameters": [ "parameters": [
{ {
@ -4043,6 +4132,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Retrieves a vector store.",
"description": "Retrieves a vector store.", "description": "Retrieves a vector store.",
"parameters": [ "parameters": [
{ {
@ -4084,6 +4174,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Updates a vector store.",
"description": "Updates a vector store.", "description": "Updates a vector store.",
"parameters": [ "parameters": [
{ {
@ -4135,6 +4226,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Delete a vector store.",
"description": "Delete a vector store.", "description": "Delete a vector store.",
"parameters": [ "parameters": [
{ {
@ -4178,6 +4270,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Retrieves a vector store file.",
"description": "Retrieves a vector store file.", "description": "Retrieves a vector store file.",
"parameters": [ "parameters": [
{ {
@ -4228,6 +4321,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Updates a vector store file.",
"description": "Updates a vector store file.", "description": "Updates a vector store file.",
"parameters": [ "parameters": [
{ {
@ -4288,6 +4382,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Delete a vector store file.",
"description": "Delete a vector store file.", "description": "Delete a vector store file.",
"parameters": [ "parameters": [
{ {
@ -4340,6 +4435,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "Generate OpenAI-compatible embeddings for the given input using the specified model.",
"description": "Generate OpenAI-compatible embeddings for the given input using the specified model.", "description": "Generate OpenAI-compatible embeddings for the given input using the specified model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -4383,6 +4479,7 @@
"tags": [ "tags": [
"Files" "Files"
], ],
"summary": "Returns a list of files that belong to the user's organization.",
"description": "Returns a list of files that belong to the user's organization.", "description": "Returns a list of files that belong to the user's organization.",
"parameters": [ "parameters": [
{ {
@ -4451,6 +4548,7 @@
"tags": [ "tags": [
"Files" "Files"
], ],
"summary": "Upload a file that can be used across various endpoints.",
"description": "Upload a file that can be used across various endpoints.\nThe file upload should be a multipart form request with:\n- file: The File object (not file name) to be uploaded.\n- purpose: The intended purpose of the uploaded file.\n- expires_after: Optional form values describing expiration for the file. Expected expires_after[anchor] = \"created_at\", expires_after[seconds] = {integer}. Seconds must be between 3600 and 2592000 (1 hour to 30 days).", "description": "Upload a file that can be used across various endpoints.\nThe file upload should be a multipart form request with:\n- file: The File object (not file name) to be uploaded.\n- purpose: The intended purpose of the uploaded file.\n- expires_after: Optional form values describing expiration for the file. Expected expires_after[anchor] = \"created_at\", expires_after[seconds] = {integer}. Seconds must be between 3600 and 2592000 (1 hour to 30 days).",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -4529,6 +4627,7 @@
"tags": [ "tags": [
"Models" "Models"
], ],
"summary": "List models using the OpenAI API.",
"description": "List models using the OpenAI API.", "description": "List models using the OpenAI API.",
"parameters": [] "parameters": []
} }
@ -4562,6 +4661,7 @@
"tags": [ "tags": [
"Files" "Files"
], ],
"summary": "Returns the contents of the specified file.",
"description": "Returns the contents of the specified file.", "description": "Returns the contents of the specified file.",
"parameters": [ "parameters": [
{ {
@ -4605,6 +4705,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Retrieves the contents of a vector store file.",
"description": "Retrieves the contents of a vector store file.", "description": "Retrieves the contents of a vector store file.",
"parameters": [ "parameters": [
{ {
@ -4657,6 +4758,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Search for chunks in a vector store.",
"description": "Search for chunks in a vector store.\nSearches a vector store for relevant chunks based on a query and optional file attribute filters.", "description": "Search for chunks in a vector store.\nSearches a vector store for relevant chunks based on a query and optional file attribute filters.",
"parameters": [ "parameters": [
{ {
@ -4710,6 +4812,7 @@
"tags": [ "tags": [
"PostTraining (Coming Soon)" "PostTraining (Coming Soon)"
], ],
"summary": "Run preference optimization of a model.",
"description": "Run preference optimization of a model.", "description": "Run preference optimization of a model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -4753,6 +4856,7 @@
"tags": [ "tags": [
"ToolRuntime" "ToolRuntime"
], ],
"summary": "Query the RAG system for context; typically invoked by the agent.",
"description": "Query the RAG system for context; typically invoked by the agent.", "description": "Query the RAG system for context; typically invoked by the agent.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -4796,6 +4900,7 @@
"tags": [ "tags": [
"VectorIO" "VectorIO"
], ],
"summary": "Query chunks from a vector database.",
"description": "Query chunks from a vector database.", "description": "Query chunks from a vector database.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -4839,6 +4944,7 @@
"tags": [ "tags": [
"Telemetry" "Telemetry"
], ],
"summary": "Query metrics.",
"description": "Query metrics.", "description": "Query metrics.",
"parameters": [ "parameters": [
{ {
@ -4892,6 +4998,7 @@
"tags": [ "tags": [
"Telemetry" "Telemetry"
], ],
"summary": "Query spans.",
"description": "Query spans.", "description": "Query spans.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -4935,6 +5042,7 @@
"tags": [ "tags": [
"Telemetry" "Telemetry"
], ],
"summary": "Query traces.",
"description": "Query traces.", "description": "Query traces.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -4978,6 +5086,7 @@
"tags": [ "tags": [
"Inference" "Inference"
], ],
"summary": "Rerank a list of documents based on their relevance to a query.",
"description": "Rerank a list of documents based on their relevance to a query.", "description": "Rerank a list of documents based on their relevance to a query.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -5026,6 +5135,7 @@
"tags": [ "tags": [
"Agents" "Agents"
], ],
"summary": "Resume an agent turn with executed tool call responses.",
"description": "Resume an agent turn with executed tool call responses.\nWhen a Turn has the status `awaiting_input` due to pending input from client side tool calls, this endpoint can be used to submit the outputs from the tool calls once they are ready.", "description": "Resume an agent turn with executed tool call responses.\nWhen a Turn has the status `awaiting_input` due to pending input from client side tool calls, this endpoint can be used to submit the outputs from the tool calls once they are ready.",
"parameters": [ "parameters": [
{ {
@ -5097,6 +5207,7 @@
"tags": [ "tags": [
"Eval" "Eval"
], ],
"summary": "Run an evaluation on a benchmark.",
"description": "Run an evaluation on a benchmark.", "description": "Run an evaluation on a benchmark.",
"parameters": [ "parameters": [
{ {
@ -5150,6 +5261,7 @@
"tags": [ "tags": [
"Safety" "Safety"
], ],
"summary": "Classifies if text and/or image inputs are potentially harmful.",
"description": "Classifies if text and/or image inputs are potentially harmful.", "description": "Classifies if text and/or image inputs are potentially harmful.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -5193,6 +5305,7 @@
"tags": [ "tags": [
"Safety" "Safety"
], ],
"summary": "Run a shield.",
"description": "Run a shield.", "description": "Run a shield.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -5229,6 +5342,7 @@
"tags": [ "tags": [
"Telemetry" "Telemetry"
], ],
"summary": "Save spans to a dataset.",
"description": "Save spans to a dataset.", "description": "Save spans to a dataset.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -5272,6 +5386,7 @@
"tags": [ "tags": [
"Scoring" "Scoring"
], ],
"summary": "Score a list of rows.",
"description": "Score a list of rows.", "description": "Score a list of rows.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -5315,6 +5430,7 @@
"tags": [ "tags": [
"Scoring" "Scoring"
], ],
"summary": "Score a batch of rows.",
"description": "Score a batch of rows.", "description": "Score a batch of rows.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -5358,6 +5474,7 @@
"tags": [ "tags": [
"Prompts" "Prompts"
], ],
"summary": "Set which version of a prompt should be the default in get_prompt (latest).",
"description": "Set which version of a prompt should be the default in get_prompt (latest).", "description": "Set which version of a prompt should be the default in get_prompt (latest).",
"parameters": [ "parameters": [
{ {
@ -5411,6 +5528,7 @@
"tags": [ "tags": [
"PostTraining (Coming Soon)" "PostTraining (Coming Soon)"
], ],
"summary": "Run supervised fine-tuning of a model.",
"description": "Run supervised fine-tuning of a model.", "description": "Run supervised fine-tuning of a model.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -5454,6 +5572,7 @@
"tags": [ "tags": [
"SyntheticDataGeneration (Coming Soon)" "SyntheticDataGeneration (Coming Soon)"
], ],
"summary": "Generate synthetic data based on input dialogs and apply filtering.",
"description": "Generate synthetic data based on input dialogs and apply filtering.", "description": "Generate synthetic data based on input dialogs and apply filtering.",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
@ -5497,6 +5616,7 @@
"tags": [ "tags": [
"Inspect" "Inspect"
], ],
"summary": "Get the version of the service.",
"description": "Get the version of the service.", "description": "Get the version of the service.",
"parameters": [] "parameters": []
} }

153
docs/_static/llama-stack-spec.yaml → docs/static/llama-stack-spec.yaml vendored
View file

@ -27,6 +27,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- DatasetIO - DatasetIO
summary: Append rows to a dataset.
description: Append rows to a dataset. description: Append rows to a dataset.
parameters: parameters:
- name: dataset_id - name: dataset_id
@ -64,6 +65,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: >-
Generate chat completions for a batch of messages using the specified model.
description: >- description: >-
Generate chat completions for a batch of messages using the specified model. Generate chat completions for a batch of messages using the specified model.
parameters: [] parameters: []
@ -95,6 +98,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: >-
Generate completions for a batch of content using the specified model.
description: >- description: >-
Generate completions for a batch of content using the specified model. Generate completions for a batch of content using the specified model.
parameters: [] parameters: []
@ -121,6 +126,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- PostTraining (Coming Soon) - PostTraining (Coming Soon)
summary: Cancel a training job.
description: Cancel a training job. description: Cancel a training job.
parameters: [] parameters: []
requestBody: requestBody:
@ -155,6 +161,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- BatchInference (Coming Soon) - BatchInference (Coming Soon)
summary: >-
Generate a chat completion for the given messages using the specified model.
description: >- description: >-
Generate a chat completion for the given messages using the specified model. Generate a chat completion for the given messages using the specified model.
parameters: [] parameters: []
@ -190,6 +198,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- BatchInference (Coming Soon) - BatchInference (Coming Soon)
summary: >-
Generate a completion for the given content using the specified model.
description: >- description: >-
Generate a completion for the given content using the specified model. Generate a completion for the given content using the specified model.
parameters: [] parameters: []
@ -220,6 +230,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: List all agents.
description: List all agents. description: List all agents.
parameters: parameters:
- name: start_index - name: start_index
@ -255,6 +266,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: >-
Create an agent with the given configuration.
description: >- description: >-
Create an agent with the given configuration. Create an agent with the given configuration.
parameters: [] parameters: []
@ -285,6 +298,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Create a new session for an agent.
description: Create a new session for an agent. description: Create a new session for an agent.
parameters: parameters:
- name: agent_id - name: agent_id
@ -326,6 +340,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Create a new turn for an agent.
description: Create a new turn for an agent. description: Create a new turn for an agent.
parameters: parameters:
- name: agent_id - name: agent_id
@ -369,6 +384,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: List all OpenAI responses.
description: List all OpenAI responses. description: List all OpenAI responses.
parameters: parameters:
- name: after - name: after
@ -419,6 +435,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Create a new OpenAI response.
description: Create a new OpenAI response. description: Create a new OpenAI response.
parameters: [] parameters: []
requestBody: requestBody:
@ -449,6 +466,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Prompts - Prompts
summary: List all prompts.
description: List all prompts. description: List all prompts.
parameters: [] parameters: []
post: post:
@ -471,6 +489,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Prompts - Prompts
summary: Create a new prompt.
description: Create a new prompt. description: Create a new prompt.
parameters: [] parameters: []
requestBody: requestBody:
@ -500,6 +519,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Describe an agent by its ID.
description: Describe an agent by its ID. description: Describe an agent by its ID.
parameters: parameters:
- name: agent_id - name: agent_id
@ -524,6 +544,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: >-
Delete an agent by its ID and its associated sessions and turns.
description: >- description: >-
Delete an agent by its ID and its associated sessions and turns. Delete an agent by its ID and its associated sessions and turns.
parameters: parameters:
@ -554,6 +576,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Retrieve an agent session by its ID.
description: Retrieve an agent session by its ID. description: Retrieve an agent session by its ID.
parameters: parameters:
- name: session_id - name: session_id
@ -594,6 +617,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: >-
Delete an agent session by its ID and its associated turns.
description: >- description: >-
Delete an agent session by its ID and its associated turns. Delete an agent session by its ID and its associated turns.
parameters: parameters:
@ -631,6 +656,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Retrieve an OpenAI response by its ID.
description: Retrieve an OpenAI response by its ID. description: Retrieve an OpenAI response by its ID.
parameters: parameters:
- name: response_id - name: response_id
@ -660,6 +686,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Delete an OpenAI response by its ID.
description: Delete an OpenAI response by its ID. description: Delete an OpenAI response by its ID.
parameters: parameters:
- name: response_id - name: response_id
@ -689,6 +716,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Prompts - Prompts
summary: >-
Get a prompt by its identifier and optional version.
description: >- description: >-
Get a prompt by its identifier and optional version. Get a prompt by its identifier and optional version.
parameters: parameters:
@ -726,6 +755,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Prompts - Prompts
summary: >-
Update an existing prompt (increments version).
description: >- description: >-
Update an existing prompt (increments version). Update an existing prompt (increments version).
parameters: parameters:
@ -757,6 +788,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Prompts - Prompts
summary: Delete a prompt.
description: Delete a prompt. description: Delete a prompt.
parameters: parameters:
- name: prompt_id - name: prompt_id
@ -789,6 +821,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: >-
Generate embeddings for content pieces using the specified model.
description: >- description: >-
Generate embeddings for content pieces using the specified model. Generate embeddings for content pieces using the specified model.
parameters: [] parameters: []
@ -820,6 +854,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Eval - Eval
summary: Evaluate a list of rows on a benchmark.
description: Evaluate a list of rows on a benchmark. description: Evaluate a list of rows on a benchmark.
parameters: parameters:
- name: benchmark_id - name: benchmark_id
@ -856,6 +891,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Retrieve an agent step by its ID.
description: Retrieve an agent step by its ID. description: Retrieve an agent step by its ID.
parameters: parameters:
- name: agent_id - name: agent_id
@ -904,6 +940,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: Retrieve an agent turn by its ID.
description: Retrieve an agent turn by its ID. description: Retrieve an agent turn by its ID.
parameters: parameters:
- name: agent_id - name: agent_id
@ -946,6 +983,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Benchmarks - Benchmarks
summary: Get a benchmark by its ID.
description: Get a benchmark by its ID. description: Get a benchmark by its ID.
parameters: parameters:
- name: benchmark_id - name: benchmark_id
@ -970,6 +1008,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Benchmarks - Benchmarks
summary: Unregister a benchmark.
description: Unregister a benchmark. description: Unregister a benchmark.
parameters: parameters:
- name: benchmark_id - name: benchmark_id
@ -999,6 +1038,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: Describe a chat completion by its ID.
description: Describe a chat completion by its ID. description: Describe a chat completion by its ID.
parameters: parameters:
- name: completion_id - name: completion_id
@ -1028,6 +1068,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Datasets - Datasets
summary: Get a dataset by its ID.
description: Get a dataset by its ID. description: Get a dataset by its ID.
parameters: parameters:
- name: dataset_id - name: dataset_id
@ -1052,6 +1093,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Datasets - Datasets
summary: Unregister a dataset by its ID.
description: Unregister a dataset by its ID. description: Unregister a dataset by its ID.
parameters: parameters:
- name: dataset_id - name: dataset_id
@ -1081,6 +1123,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Models - Models
summary: Get a model by its identifier.
description: Get a model by its identifier. description: Get a model by its identifier.
parameters: parameters:
- name: model_id - name: model_id
@ -1105,6 +1148,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Models - Models
summary: Unregister a model.
description: Unregister a model. description: Unregister a model.
parameters: parameters:
- name: model_id - name: model_id
@ -1135,6 +1179,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ScoringFunctions - ScoringFunctions
summary: Get a scoring function by its ID.
description: Get a scoring function by its ID. description: Get a scoring function by its ID.
parameters: parameters:
- name: scoring_fn_id - name: scoring_fn_id
@ -1159,6 +1204,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ScoringFunctions - ScoringFunctions
summary: Unregister a scoring function.
description: Unregister a scoring function. description: Unregister a scoring function.
parameters: parameters:
- name: scoring_fn_id - name: scoring_fn_id
@ -1189,6 +1235,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Shields - Shields
summary: Get a shield by its identifier.
description: Get a shield by its identifier. description: Get a shield by its identifier.
parameters: parameters:
- name: identifier - name: identifier
@ -1213,6 +1260,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Shields - Shields
summary: Unregister a shield.
description: Unregister a shield. description: Unregister a shield.
parameters: parameters:
- name: identifier - name: identifier
@ -1243,6 +1291,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Telemetry - Telemetry
summary: Get a span by its ID.
description: Get a span by its ID. description: Get a span by its ID.
parameters: parameters:
- name: trace_id - name: trace_id
@ -1279,6 +1328,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Telemetry - Telemetry
summary: Get a span tree by its ID.
description: Get a span tree by its ID. description: Get a span tree by its ID.
parameters: parameters:
- name: span_id - name: span_id
@ -1314,6 +1364,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolGroups - ToolGroups
summary: Get a tool by its name.
description: Get a tool by its name. description: Get a tool by its name.
parameters: parameters:
- name: tool_name - name: tool_name
@ -1343,6 +1394,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolGroups - ToolGroups
summary: Get a tool group by its ID.
description: Get a tool group by its ID. description: Get a tool group by its ID.
parameters: parameters:
- name: toolgroup_id - name: toolgroup_id
@ -1367,6 +1419,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolGroups - ToolGroups
summary: Unregister a tool group.
description: Unregister a tool group. description: Unregister a tool group.
parameters: parameters:
- name: toolgroup_id - name: toolgroup_id
@ -1396,6 +1449,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Telemetry - Telemetry
summary: Get a trace by its ID.
description: Get a trace by its ID. description: Get a trace by its ID.
parameters: parameters:
- name: trace_id - name: trace_id
@ -1425,6 +1479,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- PostTraining (Coming Soon) - PostTraining (Coming Soon)
summary: Get the artifacts of a training job.
description: Get the artifacts of a training job. description: Get the artifacts of a training job.
parameters: parameters:
- name: job_uuid - name: job_uuid
@ -1455,6 +1510,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- PostTraining (Coming Soon) - PostTraining (Coming Soon)
summary: Get the status of a training job.
description: Get the status of a training job. description: Get the status of a training job.
parameters: parameters:
- name: job_uuid - name: job_uuid
@ -1485,6 +1541,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- PostTraining (Coming Soon) - PostTraining (Coming Soon)
summary: Get all training jobs.
description: Get all training jobs. description: Get all training jobs.
parameters: [] parameters: []
/v1/vector-dbs/{vector_db_id}: /v1/vector-dbs/{vector_db_id}:
@ -1508,6 +1565,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorDBs - VectorDBs
summary: Get a vector database by its identifier.
description: Get a vector database by its identifier. description: Get a vector database by its identifier.
parameters: parameters:
- name: vector_db_id - name: vector_db_id
@ -1533,6 +1591,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorDBs - VectorDBs
summary: Unregister a vector database.
description: Unregister a vector database. description: Unregister a vector database.
parameters: parameters:
- name: vector_db_id - name: vector_db_id
@ -1564,6 +1623,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inspect - Inspect
summary: >-
Get the current health status of the service.
description: >- description: >-
Get the current health status of the service. Get the current health status of the service.
parameters: [] parameters: []
@ -1584,6 +1645,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolRuntime - ToolRuntime
summary: >-
Index documents so they can be used by the RAG system.
description: >- description: >-
Index documents so they can be used by the RAG system. Index documents so they can be used by the RAG system.
parameters: [] parameters: []
@ -1610,6 +1673,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Insert chunks into a vector database.
description: Insert chunks into a vector database. description: Insert chunks into a vector database.
parameters: [] parameters: []
requestBody: requestBody:
@ -1640,6 +1704,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Providers - Providers
summary: >-
Get detailed information about a specific provider.
description: >- description: >-
Get detailed information about a specific provider. Get detailed information about a specific provider.
parameters: parameters:
@ -1670,6 +1736,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolRuntime - ToolRuntime
summary: Run a tool with the given arguments.
description: Run a tool with the given arguments. description: Run a tool with the given arguments.
parameters: [] parameters: []
requestBody: requestBody:
@ -1699,6 +1766,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- DatasetIO - DatasetIO
summary: >-
Get a paginated list of rows from a dataset.
description: >- description: >-
Get a paginated list of rows from a dataset. Get a paginated list of rows from a dataset.
@ -1756,6 +1825,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Eval - Eval
summary: Get the status of a job.
description: Get the status of a job. description: Get the status of a job.
parameters: parameters:
- name: benchmark_id - name: benchmark_id
@ -1787,6 +1857,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Eval - Eval
summary: Cancel a job.
description: Cancel a job. description: Cancel a job.
parameters: parameters:
- name: benchmark_id - name: benchmark_id
@ -1823,6 +1894,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Eval - Eval
summary: Get the result of a job.
description: Get the result of a job. description: Get the result of a job.
parameters: parameters:
- name: benchmark_id - name: benchmark_id
@ -1859,6 +1931,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: List all session(s) of a given agent.
description: List all session(s) of a given agent. description: List all session(s) of a given agent.
parameters: parameters:
- name: agent_id - name: agent_id
@ -1901,6 +1974,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Benchmarks - Benchmarks
summary: List all benchmarks.
description: List all benchmarks. description: List all benchmarks.
parameters: [] parameters: []
post: post:
@ -1919,6 +1993,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Benchmarks - Benchmarks
summary: Register a benchmark.
description: Register a benchmark. description: Register a benchmark.
parameters: [] parameters: []
requestBody: requestBody:
@ -1948,6 +2023,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: List all chat completions.
description: List all chat completions. description: List all chat completions.
parameters: parameters:
- name: after - name: after
@ -2000,6 +2076,9 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: >-
Generate an OpenAI-compatible chat completion for the given messages using
the specified model.
description: >- description: >-
Generate an OpenAI-compatible chat completion for the given messages using Generate an OpenAI-compatible chat completion for the given messages using
the specified model. the specified model.
@ -2031,6 +2110,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Datasets - Datasets
summary: List all datasets.
description: List all datasets. description: List all datasets.
parameters: [] parameters: []
post: post:
@ -2053,6 +2133,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Datasets - Datasets
summary: Register a new dataset.
description: Register a new dataset. description: Register a new dataset.
parameters: [] parameters: []
requestBody: requestBody:
@ -2082,6 +2163,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Models - Models
summary: List all models.
description: List all models. description: List all models.
parameters: [] parameters: []
post: post:
@ -2104,6 +2186,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Models - Models
summary: Register a model.
description: Register a model. description: Register a model.
parameters: [] parameters: []
requestBody: requestBody:
@ -2133,6 +2216,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: >-
List input items for a given OpenAI response.
description: >- description: >-
List input items for a given OpenAI response. List input items for a given OpenAI response.
parameters: parameters:
@ -2203,6 +2288,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Prompts - Prompts
summary: List all versions of a specific prompt.
description: List all versions of a specific prompt. description: List all versions of a specific prompt.
parameters: parameters:
- name: prompt_id - name: prompt_id
@ -2234,6 +2320,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Providers - Providers
summary: List all available providers.
description: List all available providers. description: List all available providers.
parameters: [] parameters: []
/v1/inspect/routes: /v1/inspect/routes:
@ -2258,6 +2345,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inspect - Inspect
summary: >-
List all available API routes with their methods and implementing providers.
description: >- description: >-
List all available API routes with their methods and implementing providers. List all available API routes with their methods and implementing providers.
parameters: [] parameters: []
@ -2282,6 +2371,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolRuntime - ToolRuntime
summary: List all tools in the runtime.
description: List all tools in the runtime. description: List all tools in the runtime.
parameters: parameters:
- name: tool_group_id - name: tool_group_id
@ -2319,6 +2409,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ScoringFunctions - ScoringFunctions
summary: List all scoring functions.
description: List all scoring functions. description: List all scoring functions.
parameters: [] parameters: []
post: post:
@ -2337,6 +2428,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ScoringFunctions - ScoringFunctions
summary: Register a scoring function.
description: Register a scoring function. description: Register a scoring function.
parameters: [] parameters: []
requestBody: requestBody:
@ -2366,6 +2458,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Shields - Shields
summary: List all shields.
description: List all shields. description: List all shields.
parameters: [] parameters: []
post: post:
@ -2388,6 +2481,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Shields - Shields
summary: Register a shield.
description: Register a shield. description: Register a shield.
parameters: [] parameters: []
requestBody: requestBody:
@ -2417,6 +2511,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolGroups - ToolGroups
summary: List tool groups with optional provider.
description: List tool groups with optional provider. description: List tool groups with optional provider.
parameters: [] parameters: []
post: post:
@ -2435,6 +2530,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolGroups - ToolGroups
summary: Register a tool group.
description: Register a tool group. description: Register a tool group.
parameters: [] parameters: []
requestBody: requestBody:
@ -2464,6 +2560,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolGroups - ToolGroups
summary: List tools with optional tool group.
description: List tools with optional tool group. description: List tools with optional tool group.
parameters: parameters:
- name: toolgroup_id - name: toolgroup_id
@ -2494,6 +2591,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorDBs - VectorDBs
summary: List all vector databases.
description: List all vector databases. description: List all vector databases.
parameters: [] parameters: []
post: post:
@ -2516,6 +2614,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorDBs - VectorDBs
summary: Register a vector database.
description: Register a vector database. description: Register a vector database.
parameters: [] parameters: []
requestBody: requestBody:
@ -2541,6 +2640,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Telemetry - Telemetry
summary: Log an event.
description: Log an event. description: Log an event.
parameters: [] parameters: []
requestBody: requestBody:
@ -2571,6 +2671,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: List files in a vector store.
description: List files in a vector store. description: List files in a vector store.
parameters: parameters:
- name: vector_store_id - name: vector_store_id
@ -2641,6 +2742,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Attach a file to a vector store.
description: Attach a file to a vector store. description: Attach a file to a vector store.
parameters: parameters:
- name: vector_store_id - name: vector_store_id
@ -2677,6 +2779,9 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: >-
Generate an OpenAI-compatible completion for the given prompt using the specified
model.
description: >- description: >-
Generate an OpenAI-compatible completion for the given prompt using the specified Generate an OpenAI-compatible completion for the given prompt using the specified
model. model.
@ -2709,6 +2814,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Returns a list of vector stores.
description: Returns a list of vector stores. description: Returns a list of vector stores.
parameters: parameters:
- name: limit - name: limit
@ -2764,6 +2870,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Creates a vector store.
description: Creates a vector store. description: Creates a vector store.
parameters: [] parameters: []
requestBody: requestBody:
@ -2794,6 +2901,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Files - Files
summary: >-
Returns information about a specific file.
description: >- description: >-
Returns information about a specific file. Returns information about a specific file.
parameters: parameters:
@ -2825,6 +2934,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Files - Files
summary: Delete a file.
description: Delete a file. description: Delete a file.
parameters: parameters:
- name: file_id - name: file_id
@ -2856,6 +2966,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Retrieves a vector store.
description: Retrieves a vector store. description: Retrieves a vector store.
parameters: parameters:
- name: vector_store_id - name: vector_store_id
@ -2885,6 +2996,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Updates a vector store.
description: Updates a vector store. description: Updates a vector store.
parameters: parameters:
- name: vector_store_id - name: vector_store_id
@ -2920,6 +3032,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Delete a vector store.
description: Delete a vector store. description: Delete a vector store.
parameters: parameters:
- name: vector_store_id - name: vector_store_id
@ -2950,6 +3063,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Retrieves a vector store file.
description: Retrieves a vector store file. description: Retrieves a vector store file.
parameters: parameters:
- name: vector_store_id - name: vector_store_id
@ -2986,6 +3100,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Updates a vector store file.
description: Updates a vector store file. description: Updates a vector store file.
parameters: parameters:
- name: vector_store_id - name: vector_store_id
@ -3028,6 +3143,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Delete a vector store file.
description: Delete a vector store file. description: Delete a vector store file.
parameters: parameters:
- name: vector_store_id - name: vector_store_id
@ -3065,6 +3181,9 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: >-
Generate OpenAI-compatible embeddings for the given input using the specified
model.
description: >- description: >-
Generate OpenAI-compatible embeddings for the given input using the specified Generate OpenAI-compatible embeddings for the given input using the specified
model. model.
@ -3097,6 +3216,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Files - Files
summary: >-
Returns a list of files that belong to the user's organization.
description: >- description: >-
Returns a list of files that belong to the user's organization. Returns a list of files that belong to the user's organization.
parameters: parameters:
@ -3154,6 +3275,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Files - Files
summary: >-
Upload a file that can be used across various endpoints.
description: >- description: >-
Upload a file that can be used across various endpoints. Upload a file that can be used across various endpoints.
@ -3213,6 +3336,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Models - Models
summary: List models using the OpenAI API.
description: List models using the OpenAI API. description: List models using the OpenAI API.
parameters: [] parameters: []
/v1/openai/v1/files/{file_id}/content: /v1/openai/v1/files/{file_id}/content:
@ -3237,6 +3361,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Files - Files
summary: >-
Returns the contents of the specified file.
description: >- description: >-
Returns the contents of the specified file. Returns the contents of the specified file.
parameters: parameters:
@ -3269,6 +3395,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: >-
Retrieves the contents of a vector store file.
description: >- description: >-
Retrieves the contents of a vector store file. Retrieves the contents of a vector store file.
parameters: parameters:
@ -3307,6 +3435,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Search for chunks in a vector store.
description: >- description: >-
Search for chunks in a vector store. Search for chunks in a vector store.
@ -3346,6 +3475,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- PostTraining (Coming Soon) - PostTraining (Coming Soon)
summary: Run preference optimization of a model.
description: Run preference optimization of a model. description: Run preference optimization of a model.
parameters: [] parameters: []
requestBody: requestBody:
@ -3376,6 +3506,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- ToolRuntime - ToolRuntime
summary: >-
Query the RAG system for context; typically invoked by the agent.
description: >- description: >-
Query the RAG system for context; typically invoked by the agent. Query the RAG system for context; typically invoked by the agent.
parameters: [] parameters: []
@ -3406,6 +3538,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- VectorIO - VectorIO
summary: Query chunks from a vector database.
description: Query chunks from a vector database. description: Query chunks from a vector database.
parameters: [] parameters: []
requestBody: requestBody:
@ -3435,6 +3568,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Telemetry - Telemetry
summary: Query metrics.
description: Query metrics. description: Query metrics.
parameters: parameters:
- name: metric_name - name: metric_name
@ -3470,6 +3604,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Telemetry - Telemetry
summary: Query spans.
description: Query spans. description: Query spans.
parameters: [] parameters: []
requestBody: requestBody:
@ -3499,6 +3634,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Telemetry - Telemetry
summary: Query traces.
description: Query traces. description: Query traces.
parameters: [] parameters: []
requestBody: requestBody:
@ -3529,6 +3665,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inference - Inference
summary: >-
Rerank a list of documents based on their relevance to a query.
description: >- description: >-
Rerank a list of documents based on their relevance to a query. Rerank a list of documents based on their relevance to a query.
parameters: [] parameters: []
@ -3564,6 +3702,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Agents - Agents
summary: >-
Resume an agent turn with executed tool call responses.
description: >- description: >-
Resume an agent turn with executed tool call responses. Resume an agent turn with executed tool call responses.
@ -3617,6 +3757,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Eval - Eval
summary: Run an evaluation on a benchmark.
description: Run an evaluation on a benchmark. description: Run an evaluation on a benchmark.
parameters: parameters:
- name: benchmark_id - name: benchmark_id
@ -3653,6 +3794,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Safety - Safety
summary: >-
Classifies if text and/or image inputs are potentially harmful.
description: >- description: >-
Classifies if text and/or image inputs are potentially harmful. Classifies if text and/or image inputs are potentially harmful.
parameters: [] parameters: []
@ -3683,6 +3826,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Safety - Safety
summary: Run a shield.
description: Run a shield. description: Run a shield.
parameters: [] parameters: []
requestBody: requestBody:
@ -3708,6 +3852,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Telemetry - Telemetry
summary: Save spans to a dataset.
description: Save spans to a dataset. description: Save spans to a dataset.
parameters: [] parameters: []
requestBody: requestBody:
@ -3738,6 +3883,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Scoring - Scoring
summary: Score a list of rows.
description: Score a list of rows. description: Score a list of rows.
parameters: [] parameters: []
requestBody: requestBody:
@ -3767,6 +3913,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Scoring - Scoring
summary: Score a batch of rows.
description: Score a batch of rows. description: Score a batch of rows.
parameters: [] parameters: []
requestBody: requestBody:
@ -3797,6 +3944,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Prompts - Prompts
summary: >-
Set which version of a prompt should be the default in get_prompt (latest).
description: >- description: >-
Set which version of a prompt should be the default in get_prompt (latest). Set which version of a prompt should be the default in get_prompt (latest).
parameters: parameters:
@ -3833,6 +3982,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- PostTraining (Coming Soon) - PostTraining (Coming Soon)
summary: Run supervised fine-tuning of a model.
description: Run supervised fine-tuning of a model. description: Run supervised fine-tuning of a model.
parameters: [] parameters: []
requestBody: requestBody:
@ -3863,6 +4013,8 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- SyntheticDataGeneration (Coming Soon) - SyntheticDataGeneration (Coming Soon)
summary: >-
Generate synthetic data based on input dialogs and apply filtering.
description: >- description: >-
Generate synthetic data based on input dialogs and apply filtering. Generate synthetic data based on input dialogs and apply filtering.
parameters: [] parameters: []
@ -3894,6 +4046,7 @@ paths:
$ref: '#/components/responses/DefaultError' $ref: '#/components/responses/DefaultError'
tags: tags:
- Inspect - Inspect
summary: Get the version of the service.
description: Get the version of the service. description: Get the version of the service.
parameters: [] parameters: []
jsonSchemaDialect: >- jsonSchemaDialect: >-