phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-12-11 19:56:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: Rename RagTool FileSearchTool

Browse source 
Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>
This commit is contained in:
Francisco Javier Arceo 2025-10-24 16:52:58 -04:00
parent 4566eebe05
commit 2d9163529a
288 changed files with 16985 additions and 2071 deletions
Download patch file Download diff file Expand all files Collapse all files

8
benchmarking/k8s-benchmark/stack_run_config.yaml
View file

@ -80,8 +80,8 @@ providers:
config:
api_key: ${env.TAVILY_SEARCH_API_KEY:+}
max_results: 3
- provider_id: rag-runtime
provider_type: inline::rag-runtime
- provider_id: file_search-runtime
provider_type: inline::file_search-runtime
config: {}
- provider_id: model-context-protocol
provider_type: remote::model-context-protocol
@ -134,8 +134,8 @@ registered_resources:
tool_groups:
- toolgroup_id: builtin::websearch
provider_id: tavily-search
- toolgroup_id: builtin::rag
provider_id: rag-runtime
- toolgroup_id: builtin::file_search
provider_id: file_search-runtime
server:
port: 8323
telemetry:

8
client-sdks/stainless/openapi.stainless.yml
View file

@ -121,9 +121,9 @@ resources:
tool_response_message: ToolResponseMessage
system_message: SystemMessage
tool_call: ToolCall
query_result: RAGQueryResult
query_result: FileSearchResult
document: RAGDocument
query_config: RAGQueryConfig
query_config: FileSearchConfig
response_format: ResponseFormat
toolgroups:
models:
@ -153,8 +153,8 @@ resources:
subresources:
rag_tool:
methods:
insert: post /v1/tool-runtime/rag-tool/insert
query: post /v1/tool-runtime/rag-tool/query
insert: post /v1/tool-runtime/file_search-tool/insert
query: post /v1/tool-runtime/file_search-tool/query
responses:
models:

666
client-sdks/stainless/openapi.yml
View file

@ -1869,6 +1869,69 @@ paths:
$ref: '#/components/schemas/SyntheticDataGenerateRequest'
required: true
deprecated: false
/v1/tool-runtime/file_search-tool/insert:
post:
responses:
'200':
description: OK
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- 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.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InsertRequest'
required: true
deprecated: false
/v1/tool-runtime/file_search-tool/query:
post:
responses:
'200':
description: >-
FileSearchResult containing the retrieved content and metadata
content:
application/json:
schema:
$ref: '#/components/schemas/FileSearchResult'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- 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.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryRequest'
required: true
deprecated: false
/v1/tool-runtime/invoke:
post:
responses:
@ -1939,69 +2002,6 @@ paths:
schema:
$ref: '#/components/schemas/URL'
deprecated: false
/v1/tool-runtime/rag-tool/insert:
post:
responses:
'200':
description: OK
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- 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.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InsertRequest'
required: true
deprecated: false
/v1/tool-runtime/rag-tool/query:
post:
responses:
'200':
description: >-
RAGQueryResult containing the retrieved content and metadata
content:
application/json:
schema:
$ref: '#/components/schemas/RAGQueryResult'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- 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.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryRequest'
required: true
deprecated: false
/v1/toolgroups:
get:
responses:
@ -9698,6 +9698,274 @@ components:
description: >-
Response from the synthetic data generation. Batch of (prompt, response, score)
tuples that pass the threshold.
RAGDocument:
type: object
properties:
document_id:
type: string
description: The unique identifier for the document.
content:
oneOf:
- type: string
- $ref: '#/components/schemas/InterleavedContentItem'
- type: array
items:
$ref: '#/components/schemas/InterleavedContentItem'
- $ref: '#/components/schemas/URL'
description: The content of the document.
mime_type:
type: string
description: The MIME type of the document.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: Additional metadata for the document.
additionalProperties: false
required:
- document_id
- content
- metadata
title: RAGDocument
description: >-
A document to be used for document ingestion in the RAG Tool.
InsertRequest:
type: object
properties:
documents:
type: array
items:
$ref: '#/components/schemas/RAGDocument'
description: >-
List of documents to index in the RAG system
vector_db_id:
type: string
description: >-
ID of the vector database to store the document embeddings
chunk_size_in_tokens:
type: integer
description: >-
(Optional) Size in tokens for document chunking during indexing
additionalProperties: false
required:
- documents
- vector_db_id
- chunk_size_in_tokens
title: InsertRequest
DefaultFileSearchGeneratorConfig:
type: object
properties:
type:
type: string
const: default
default: default
description: >-
Type of query generator, always 'default'
separator:
type: string
default: ' '
description: >-
String separator used to join query terms
additionalProperties: false
required:
- type
- separator
title: DefaultFileSearchGeneratorConfig
description: >-
Configuration for the default RAG query generator.
FileSearchConfig:
type: object
properties:
query_generator_config:
oneOf:
- $ref: '#/components/schemas/DefaultFileSearchGeneratorConfig'
- $ref: '#/components/schemas/LLMFileSearchGeneratorConfig'
discriminator:
propertyName: type
mapping:
default: '#/components/schemas/DefaultFileSearchGeneratorConfig'
llm: '#/components/schemas/LLMFileSearchGeneratorConfig'
description: Configuration for the query generator.
max_tokens_in_context:
type: integer
default: 4096
description: Maximum number of tokens in the context.
max_chunks:
type: integer
default: 5
description: Maximum number of chunks to retrieve.
chunk_template:
type: string
default: >
Result {index}
Content: {chunk.content}
Metadata: {metadata}
description: >-
Template for formatting each retrieved chunk in the context. Available
placeholders: {index} (1-based chunk ordinal), {chunk.content} (chunk
content string), {metadata} (chunk metadata dict). Default: "Result {index}\nContent:
{chunk.content}\nMetadata: {metadata}\n"
mode:
$ref: '#/components/schemas/FileSearchMode'
default: vector
description: >-
Search mode for retrieval—either "vector", "keyword", or "hybrid". Default
"vector".
ranker:
$ref: '#/components/schemas/Ranker'
description: >-
Configuration for the ranker to use in hybrid search. Defaults to RRF
ranker.
additionalProperties: false
required:
- query_generator_config
- max_tokens_in_context
- max_chunks
- chunk_template
title: FileSearchConfig
description: >-
Configuration for the RAG query generation.
FileSearchMode:
type: string
enum:
- vector
- keyword
- hybrid
title: FileSearchMode
description: >-
Search modes for RAG query retrieval: - VECTOR: Uses vector similarity search
for semantic matching - KEYWORD: Uses keyword-based search for exact matching
- HYBRID: Combines both vector and keyword search for better results
LLMFileSearchGeneratorConfig:
type: object
properties:
type:
type: string
const: llm
default: llm
description: Type of query generator, always 'llm'
model:
type: string
description: >-
Name of the language model to use for query generation
template:
type: string
description: >-
Template string for formatting the query generation prompt
additionalProperties: false
required:
- type
- model
- template
title: LLMFileSearchGeneratorConfig
description: >-
Configuration for the LLM-based File Search generator.
RRFRanker:
type: object
properties:
type:
type: string
const: rrf
default: rrf
description: The type of ranker, always "rrf"
impact_factor:
type: number
default: 60.0
description: >-
The impact factor for RRF scoring. Higher values give more weight to higher-ranked
results. Must be greater than 0
additionalProperties: false
required:
- type
- impact_factor
title: RRFRanker
description: >-
Reciprocal Rank Fusion (RRF) ranker configuration.
Ranker:
oneOf:
- $ref: '#/components/schemas/RRFRanker'
- $ref: '#/components/schemas/WeightedRanker'
discriminator:
propertyName: type
mapping:
rrf: '#/components/schemas/RRFRanker'
weighted: '#/components/schemas/WeightedRanker'
WeightedRanker:
type: object
properties:
type:
type: string
const: weighted
default: weighted
description: The type of ranker, always "weighted"
alpha:
type: number
default: 0.5
description: >-
Weight factor between 0 and 1. 0 means only use keyword scores, 1 means
only use vector scores, values in between blend both scores.
additionalProperties: false
required:
- type
- alpha
title: WeightedRanker
description: >-
Weighted ranker configuration that combines vector and keyword scores.
QueryRequest:
type: object
properties:
content:
$ref: '#/components/schemas/InterleavedContent'
description: >-
The query content to search for in the indexed documents
vector_db_ids:
type: array
items:
type: string
description: >-
List of vector database IDs to search within
query_config:
$ref: '#/components/schemas/FileSearchConfig'
description: >-
(Optional) Configuration parameters for the query operation
additionalProperties: false
required:
- content
- vector_db_ids
title: QueryRequest
FileSearchResult:
type: object
properties:
content:
$ref: '#/components/schemas/InterleavedContent'
description: >-
(Optional) The retrieved content from the query
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
Additional metadata about the query result
additionalProperties: false
required:
- metadata
title: FileSearchResult
description: >-
Result of a RAG query containing retrieved content and metadata.
InvokeToolRequest:
type: object
properties:
@ -9821,274 +10089,6 @@ components:
title: ListToolDefsResponse
description: >-
Response containing a list of tool definitions.
RAGDocument:
type: object
properties:
document_id:
type: string
description: The unique identifier for the document.
content:
oneOf:
- type: string
- $ref: '#/components/schemas/InterleavedContentItem'
- type: array
items:
$ref: '#/components/schemas/InterleavedContentItem'
- $ref: '#/components/schemas/URL'
description: The content of the document.
mime_type:
type: string
description: The MIME type of the document.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: Additional metadata for the document.
additionalProperties: false
required:
- document_id
- content
- metadata
title: RAGDocument
description: >-
A document to be used for document ingestion in the RAG Tool.
InsertRequest:
type: object
properties:
documents:
type: array
items:
$ref: '#/components/schemas/RAGDocument'
description: >-
List of documents to index in the RAG system
vector_db_id:
type: string
description: >-
ID of the vector database to store the document embeddings
chunk_size_in_tokens:
type: integer
description: >-
(Optional) Size in tokens for document chunking during indexing
additionalProperties: false
required:
- documents
- vector_db_id
- chunk_size_in_tokens
title: InsertRequest
DefaultRAGQueryGeneratorConfig:
type: object
properties:
type:
type: string
const: default
default: default
description: >-
Type of query generator, always 'default'
separator:
type: string
default: ' '
description: >-
String separator used to join query terms
additionalProperties: false
required:
- type
- separator
title: DefaultRAGQueryGeneratorConfig
description: >-
Configuration for the default RAG query generator.
LLMRAGQueryGeneratorConfig:
type: object
properties:
type:
type: string
const: llm
default: llm
description: Type of query generator, always 'llm'
model:
type: string
description: >-
Name of the language model to use for query generation
template:
type: string
description: >-
Template string for formatting the query generation prompt
additionalProperties: false
required:
- type
- model
- template
title: LLMRAGQueryGeneratorConfig
description: >-
Configuration for the LLM-based RAG query generator.
RAGQueryConfig:
type: object
properties:
query_generator_config:
oneOf:
- $ref: '#/components/schemas/DefaultRAGQueryGeneratorConfig'
- $ref: '#/components/schemas/LLMRAGQueryGeneratorConfig'
discriminator:
propertyName: type
mapping:
default: '#/components/schemas/DefaultRAGQueryGeneratorConfig'
llm: '#/components/schemas/LLMRAGQueryGeneratorConfig'
description: Configuration for the query generator.
max_tokens_in_context:
type: integer
default: 4096
description: Maximum number of tokens in the context.
max_chunks:
type: integer
default: 5
description: Maximum number of chunks to retrieve.
chunk_template:
type: string
default: >
Result {index}
Content: {chunk.content}
Metadata: {metadata}
description: >-
Template for formatting each retrieved chunk in the context. Available
placeholders: {index} (1-based chunk ordinal), {chunk.content} (chunk
content string), {metadata} (chunk metadata dict). Default: "Result {index}\nContent:
{chunk.content}\nMetadata: {metadata}\n"
mode:
$ref: '#/components/schemas/RAGSearchMode'
default: vector
description: >-
Search mode for retrieval—either "vector", "keyword", or "hybrid". Default
"vector".
ranker:
$ref: '#/components/schemas/Ranker'
description: >-
Configuration for the ranker to use in hybrid search. Defaults to RRF
ranker.
additionalProperties: false
required:
- query_generator_config
- max_tokens_in_context
- max_chunks
- chunk_template
title: RAGQueryConfig
description: >-
Configuration for the RAG query generation.
RAGSearchMode:
type: string
enum:
- vector
- keyword
- hybrid
title: RAGSearchMode
description: >-
Search modes for RAG query retrieval: - VECTOR: Uses vector similarity search
for semantic matching - KEYWORD: Uses keyword-based search for exact matching
- HYBRID: Combines both vector and keyword search for better results
RRFRanker:
type: object
properties:
type:
type: string
const: rrf
default: rrf
description: The type of ranker, always "rrf"
impact_factor:
type: number
default: 60.0
description: >-
The impact factor for RRF scoring. Higher values give more weight to higher-ranked
results. Must be greater than 0
additionalProperties: false
required:
- type
- impact_factor
title: RRFRanker
description: >-
Reciprocal Rank Fusion (RRF) ranker configuration.
Ranker:
oneOf:
- $ref: '#/components/schemas/RRFRanker'
- $ref: '#/components/schemas/WeightedRanker'
discriminator:
propertyName: type
mapping:
rrf: '#/components/schemas/RRFRanker'
weighted: '#/components/schemas/WeightedRanker'
WeightedRanker:
type: object
properties:
type:
type: string
const: weighted
default: weighted
description: The type of ranker, always "weighted"
alpha:
type: number
default: 0.5
description: >-
Weight factor between 0 and 1. 0 means only use keyword scores, 1 means
only use vector scores, values in between blend both scores.
additionalProperties: false
required:
- type
- alpha
title: WeightedRanker
description: >-
Weighted ranker configuration that combines vector and keyword scores.
QueryRequest:
type: object
properties:
content:
$ref: '#/components/schemas/InterleavedContent'
description: >-
The query content to search for in the indexed documents
vector_db_ids:
type: array
items:
type: string
description: >-
List of vector database IDs to search within
query_config:
$ref: '#/components/schemas/RAGQueryConfig'
description: >-
(Optional) Configuration parameters for the query operation
additionalProperties: false
required:
- content
- vector_db_ids
title: QueryRequest
RAGQueryResult:
type: object
properties:
content:
$ref: '#/components/schemas/InterleavedContent'
description: >-
(Optional) The retrieved content from the query
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
Additional metadata about the query result
additionalProperties: false
required:
- metadata
title: RAGQueryResult
description: >-
Result of a RAG query containing retrieved content and metadata.
ToolGroup:
type: object
properties:
@ -10280,8 +10280,8 @@ components:
`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
set during chunk creation in `FileSearchToolRuntimeImpl().insert()`and is
not expected to change after. Use `Chunk.metadata` for metadata that will
be used in the context during inference.
InsertChunksRequest:
type: object

30
docs/docs/api-deprecated/agents.tag.mdx Normal file
View file

@ -0,0 +1,30 @@
---
id: agents
title: "Agents"
description: "Agents"
custom_edit_url: null
---
APIs for creating and interacting with agentic systems.
## Deprecated APIs
> **⚠️ DEPRECATED**: These APIs are provided for migration reference and will be removed in future versions. Not recommended for new projects.
### Migration Guidance
If you are using deprecated versions of the Agents or Responses APIs, please migrate to:
- **Responses API**: Use the stable v1 Responses API endpoints
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

72
docs/docs/api-deprecated/append-rows-to-a-dataset.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: append-rows-to-a-dataset
title: "Append rows to a dataset."
description: "Append rows to a dataset."
sidebar_label: "Append rows to a dataset."
hide_title: true
hide_table_of_contents: true
api: eJztV81uGzcQfpUBT4mxkpwgQRrdnNhFjSawISuHwhaK0XJWy4RLbkiubEHQM/TeUx+jz9MX6CsUQ+5aa0sxHKCXANZFK+78ceb7Popr4cjX1njyYrwWLw8P+UuSz52qg7JGjMXZr2KTiVf7Xk1LAkdfG/IBrtGDMkvUSoJ1UKEurKtIikzk1gQygf2xrrXKkf1Hnz0HWQufl1QhP4VVTWIs7Pwz5UFkona2JhdUqs4HDI3v2SkTaEFOZPfK+mU6PYdkDbmVxPUHFTT1fH1wyix2XE+csw6icQYIvrQugG+qCt0KbAGhJKBoc12qvASVNu0UmgCFdYCmfR/zbDh+QKUfmzlZc2ptzYIclE2FZuAIJc41Qc/nTjmcSRkf0OSP2OWzs/iE+jkcwafJh3YzORqYEzSeJAQLjoJTtCSorCNQhucZJwc4t02IyX1NuSpUDjbPG+fI5HSvrk0mUEqV8p33Blqg9pQJxo9yJMX4sptwN63b5s1u55fa9I3mdViGwtkq1nB0fjqEiW0WpV5BYbW21x4mP7+HNz8dvhly0+gGqzoho8PXq8PDbb53KGGSIL6t55HI32x4969evt3PnFwrMgFK9OD5IVgLFZpVF5ijAsJCLckAVrYxIfZWVfREqidS/WCkevl2m29qLXxkpLfM8n1q/WYbKHFJQDc5keS2MdkwEGhVqTCEc03oCYJbAS5QGdAYyA1bvr3+1knlyS3JAZmcqUSOJAOrMXRTUx5Its19otYTtX4oar3un1enjGyDGi4S2rf5W3od7UK+a4YcwlnjIBBW8VSaExkwNqhCkezoJanARoddij0U+IlUT6T6sUh1uC/bIygUWcJQw4Xn3RxjQE/h9Izrv0eYuiYjwXE5wQKCTLZDBj06rCiQ4yBrYbDiSlqD3xUTSnGMGkO50wg+7E6PuxG0TjFFyhjP05SVc22bH1xD2S4VWwBtNrNkTD68s3LFFv8Tq7manhU6hyveYqDK7/PeD6a1sIbOitix1sM0WotNdvt7bq0mNP0l01Rzcv2Vbr/ZvYJ6C20lm1mSxJ1LcTfTtuG2P4nh9/Eh9qYH/gSbib323b0kAu7uFGNVtaMcw3awFYXSSkaNjbeZCJ6xGC1fjNrSlB2lkgecdbTeAm4jMpH+QCVENo6ZUIZQj0cjNKtBaX0gOdAaKxz4gPmXYW4rwZjxlDdOhVV0PO7Oj8sZv2OkTLaYOtkyMWHicr2ZRVkrbARC24QPnAYuOA1ctPKTZGkAx7cbZ+qzknDVaTjLF3vYwvrt7ygZ9rW1nyuUGKB2dqkk+SsD9z4IzDRbABlZW2WCB0yEUw5y65I4SWUWwOeWKzAnn4KioyvDAmNdVN7d4HO+bGpaksNFV9VHK0n74ZW5MgcH//z5179//wHHJ+eTk/dH05Pjg4MxfKAF5qvYiZSowhULvKPKLknyHbNoQuMI2i75IXxi+eSrrFq41ApHBbXCbvQqiiaDqMJI81aeHhK0Oz3v6caDTi3ZAt2EUa1RMW8T8tYteC/biXbwZW3YAlhkYtzTzFkmGKXstV7P0dMnpzcbXv7akGN4zjIRz/E5g+xyLaTy/CxvifnNbTybtPx7Dt8pv3s32emOYRlcom74l8jEF1rdPQciO0pCSS5WnAzep7oGUw6zDbAj0axoyeMoz6kOD9rOegpyfnYxFZmYt8dAxX+wxsLhNZ8neJ2KtbFPSeB5bS00mkWDC7ZNMfnzH+v7J+k=
sidebar_class_name: "post api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Append rows to a dataset."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/datasetio/append-rows/{dataset_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Append rows to a dataset.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"dataset_id","in":"path","description":"The ID of the dataset to append the rows to.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The rows to append to the dataset."}},"additionalProperties":false,"required":["rows"],"title":"AppendRowsRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/attach-a-file-to-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

19
docs/docs/api-deprecated/benchmarks.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: benchmarks
title: "Benchmarks"
description: "Benchmarks"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

72
docs/docs/api-deprecated/cancel-a-job.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: cancel-a-job
title: "Cancel a job."
description: "Cancel a job."
sidebar_label: "Cancel a job."
hide_title: true
hide_table_of_contents: true
api: eJztV81uGzcQfpUBT4mxlpwgQRrd3FhFgzqIYTuHwjaKETnS0uGSG3JWsSDsM/TeUx+jz9MX6CsUw1392HIKJ+glgH3xasn5++b7hsulipTq4BMlNVqq5wcH8s9Q0tHWbINXI/X+F9UW6sV9S+clQaRPDSWGz5jA+jk6ayBEqNBNQ6zIqELp4Jk8iz3WtbMaxX54ncTJUiVdUoXyxIua1EiFyTVpVoWqY6gpsu2yS4zcpK191jPNKKriTlo/n5+fQLcbdDAk+bNlR1u2iaP1sx3TcYwhQt5cAEIqQ2RITVVhXECYApcElPd8Lq0uwXZFR4ueYRoioO/Xc5xW/DNa99DI3W4J7YKfUYSyqdDvR0KDE0ewZXMrHYlkfWL0+gFVPnmfn9A9hUP4cHrcF6PRw4SgSWSAA0TiaGlOUIVIYL30M3cOcBIazsFTTdpOrYagdRMjeU138moLhcbYLt7JVkOn6BIVSvhjIxk1ulh1eNWtNXhX6/51MH0BvBWXYRpDlXM4PHk7gNPQzEq3gGlwLnxOcPrTG3j1w8GrgYBGN1jVHTNW/HpxcLCJ9yMaOO0ovsnngcxvW6n+xfPX9ytHO0ueocQESR44BKjQL1aOxSsgzOycPGAVGs8ZW1vRo6geRfWdier560288xDgnTC9V1baltavoYES5wR0o4mMwCZiQyZwtrI8gBNHmAg4LgBnaD04ZIqDXm8vv3RSJYpzikBei5QokhFiNZ5uatJMpgf3UVqP0vqupPVy+7x6K8z26OCsY/smfi+vw13Kr8AwA3jfRGDCKp9KEyIPPrCdWjIreRmaYuN4V2L/5fhRVI+i+r5EdXBftAdIKKtEqIazJNWM55hTv53qG2mRA4TrMBkIxzFiRUxRbJbKYyWBJ+R1WWH8+JsVBVmxrJHLncrldHt7tMJ8bZb71/iuEXN0Tde44CXkBnKODRW7Auxp07bFOqHrMPm6VK7DRJLQudyvi5oxqyNp5M32irgMRo2UIUdMGTku1UgN58+GUuJwXXwaLrfxa4fXYZKGy66EVhWq+xzoAG+i9LVkrkfDIfrFfhkSk9l3DivcT4z640CHSklWiXQTLS+y4dFqGl5cyZroIxfTU+dY7OFM7OGsV0nXhH04WlcnDBXCSzodivNn9wArYybdEhxuj4DtWFwiQx3D3BpKlx7u/CEkyncJ8qYO1nMC9Pk7y0bQIXYaMtbPQMZrnKKm1DnFSJdedBBiHhC7zidyJ3I0p4izVVbvgiGXBpf+0u/t/f3Hn//89TscjU9Ox28Oz8dHe3sjOKYZ6kVGogtU4ULmUKQqzMnIVWjacBMJepTSAD6IyuXGZWexgyLSlPr5490ia7sOiSvMZ0zP4rviu4XzcnNQ7WzsKcp0w8PaofXiP1Nn2fPwouucMFEVG/1Kc0d31Cx0lNe9pq4KJZwTF8vlBBN9iK5t5fWnhqKQ7apQ+YyZCLMulsrYJM9mPUS/WMeT0151T+FbJsW9Zfcv0S+EuOga+aUK9ZEWdyeXDJD/IdmdWfINefVgt1dtoUpCQzFD2S0eak01b5ntfKeIxNcj6Gh8PD4fq7b9Fy2isFc=
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Cancel a job."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Cancel a job.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"benchmark_id","in":"path","description":"The ID of the benchmark to run the evaluation on.","required":true,"schema":{"type":"string"}},{"name":"job_id","in":"path","description":"The ID of the job to cancel.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/cancel-a-training-job.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: cancel-a-training-job
title: "Cancel a training job."
description: "Cancel a training job."
sidebar_label: "Cancel a training job."
hide_title: true
hide_table_of_contents: true
api: eJztV81u20YQfpXBnhqDkpwgQRrdHNtF0yawYMuHwhaK4XIkrrPcZWaXsglBz9B7T32MPk9foK9QzFK05NhJXaCXAOZBIsj522++b3a5Ukyh9i5QUOOVerG/L38FBc2mjsY7NVYnP6t1pl4+9GpaEjB9aihEuMYAxi3RmgI8Q4V27rmiQmVKexfJRfHHurZGo/iProIEWamgS6pQ7mJbkxorn1+RjipTNfuaOJquuhAxNmHHzrhIC2KVfVbWj9PpBDpr0L4gqT+aaGnHN0Q2bnHP9ZjZMyTjDBBC6TlCaKoKuQU/h1gSULK5Lo0uwXSLZoMuwtwzoNu8T3nWEj+isY/N3FlLauvdghjKpkI3YMICc0uw43OnHMlkXIjo9CNW+d1JukP7DA7g/PT9ZjEaHeQETaACogemyIaWBJVnAuOkn6lzgLlvYkoeatJmbjR4rRtmcpo+q2udKSwK0+Wb7DR0jjZQpoQ/hqlQ44u+w323bsGb3favg+kL4PVchjn7KtVwMHk3hFPfLErbwtxb668DnP5wCK+/3389FNDoBqu6Y0bPr5f7+9t8b7GA047i23oeyfz1Wlb/8sWbh5WjrSEXocQAQW6i91Cha/vAEhUQFmZJDrDyjYsJW1PRk6ieRPWNierFm22+qffwQZi+UVbYldYvvoESlwR0o4kKgU3EhpHAmsrEIUwsYSCI3AIu0DiwGImHG729+tJOFYiXxEBOi5SIqRBiNY5uatKRig24T9J6ktY3Ja1Xu/vVO2G2QwtnHdu3+TfyOrhP+R6MYggnDUMkrNKulBM5cD6auaGil1dBc2xsvC+xrwV+EtWTqL4tUe0/lO0REkoqEarhIshqJj7EKaNxxi3gu0Nfyf+Z9+6ZLOjuAg6lcRYQYu9w5fOhSAAZK4rEEnLWwUUhvvVFKzX/T9K68vmvTWOKf6eO7Kbn5++O+i5f+Vy4olP9w//W7tusO/3tgOhh+8nn/Qk8Qbv1jtxQUlfNpDH2jzJVUSx9ocaq9uncXmMs1ViNls9H8mTQAzy68vmoK1tlqjsgCMYr1bB0uoyxHo9G6NpB6UOkYmAtVjgIEfXHofaVWs/ETzdsYpscj/r5eDGTd9KE0227jrdM28Ldw5zkO/cJ/w0S7yUdnEk6ONvIrJPfAI5uly0UF8VI9V2Hls8faJrMqXBHsbg7Q3ZzxRIj1OyXpqBw6eCzCyFQ+hghV9TeuBgAXTqoGQbtuRNhIRSW+cxz1BS6oMh06URIntOEuR88l48qS0tiXPRVffAF2TC8dJdub++v3//4+8/f4Oh4cnp8eDA9PtrbG8N7WqBuExJdogpbGWRMlV9SId9S8yY2TLBBKQzhXMaEfLKZBXdQMM1pM8CcbdNwEMJUmJTksKKv6fQO4Du6/LLHRmeRbuKotmicZEzcW21Ie9H18g5tVSbskU21o+4sU0JPMV6tcgx0zna9lsefGuK2Gxppg8qFVRezdaZKwoI4UfYjtVJjV+1gKiWJuW2ktHsTZZ31HgdaUx2/ajvb0eLk5GyqMpVvplYlm/JYMV6rLP2OlcqUT+ileZSerZRFt2hwIbZdTLn+AZwUiLM=
sidebar_class_name: "post api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Cancel a training job."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/post-training/job/cancel"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Cancel a training job.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"job_uuid":{"type":"string","description":"The UUID of the job to cancel."}},"additionalProperties":false,"required":["job_uuid"],"title":"CancelTrainingJobRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/cancels-a-vector-store-file-batch.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/create-a-model-response.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/create-a-new-session-for-an-agent.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: create-a-new-session-for-an-agent
title: "Create a new session for an agent."
description: "Create a new session for an agent."
sidebar_label: "Create a new session for an agent."
hide_title: true
hide_table_of_contents: true
api: eJztWM1u2zgQfpUBT22g2GnRolvf3CSLLdCigeMcFomxGJNji61EKiTlxDD0DHvf0z7GPs++wL7CYkgpVuJkmy56KRBfLEvk/H3fN9R4Ixz5yhpPXow24uXBAX8p8tLpKmhrxEiMDYyXZMIpea+tOXSEgSbttoHIhLQmkAm8E6uq0BJ55/Cz5+0b4WVOJfJVWFckRsLOP5MMIhOVsxW5oJNzn+z/plVvrQ9Om6XI7sR0ZvRlTaAVmaAXmhwsrIOQE8gYnoLWmmiaTKBSmjdicdLzuMDCUyYcXdbakRKj834Is0wEHQqO4eHsd+LqHoCjUDtDCq5yMikobZaAYOgKkA12EQ5E03CQr+6r/TRnU5c1+QBX6EGbFRZagXVQYrGwriT1HREIGGrfW6dNoCW5nTR/mU5PIK0GaRWJ5qZaX0Pu2DlGihdngOBz6wL4uizRrcEuIoYU11zlWuagU9JOowkRZDTt8+inYfsBdfFYz2k1uy6sWZKDvC7R7DtChfOCoLfnVjjsSRsf0MhHZPnsU5UI9xzGcDb50CYj0cCcoPakIFgmidO0IiitI9CG8YzIAc5tHaJzX5HUCy3BSlk7R0bSnbi+ieAJ4Q6tm+L12B7L9EDxumYBC2fLGMP45P0AJrZe5sUaFrYo7JWHyc+H8OangzcDLhpdY1klZnT8enVwsPX3DhVMEsW38TyS+a1yXr69Xzmy0Cy0HD14vgjWQolm3Rlmq4Cw1CsygKWtTYi11SU9iepJVD+YqF6+3fqbWgsfmemtsnxfWr/aGnJcEdC1JFJcNhYbBoJClzoM4KQg9ATBrQGXqA0UGMh1J9Xrh04qT25FDshIlhI5Ukys2tB1RZIPZWrL8CStJ2n9QNJ63T+v3jOzDRZwmti+9d/Ka7xL+a4YagCfageBsIyn0pzIgLHxFVZ18lK0wLoI976IP2j4SVRPovqxRHVwn7dHSCiqhKmGS8/ZxOnMc/C3g02TWjtxtbNWx504gPHoWqHDkgI5NrURBkuOJz7mIZDRFiNRYch3isEH3vujDoY00gXbzp8Jta1T9rWFILiasl1BtjRqmllaTD68s2rNK77ziJ3y/Bp/OUNe2eXY5XOT5eD/TdfRe49sCan+lN3NAxHo23WLWq8cSZ7yu1KWFHKrGCkbp4gI2EgMVy+GERg/3HSYNsPun4FMpPeVBH3tmHh5CNVoOESz3s+tD6T2iwJL3PcB5ZeBtKVgcDzJ2umwjhuPunZ9PuNnDMlkC95xj/i3in+DNnNsYSMabT0+sEs4ZZdw2io/dYR9OLrJnVXHIuYMEl6rF/dAyK3T32oi2G9rfV8hxwCVsyutyF8YuPNB8BTnIzKqstoED2jiu6N2IK1LfUHx3xx8ZLgFSvLJKDq6MKxt62LT2zU+5zmvoBU5XHZRfbSKCj+4MBdmb+/vP/7856/f4ej4ZHJ8OJ4eH+3tjeADLVGuYyWSoxLX3FsdlXZFise7RR1qR9BWyQ/gjDsXT5F66VIpHC2o7ammWMd+xTwqMWqrhetR7eRW8XuqfdzuVo2BrsOwKlAbjiTyctMy+jxhnDgtMjHqdaqO1rNMMHV58WYzR09nrmgavn1Zk2POzjIRz9I5s+18I5T2fK1uRPtgGs8mrRafwze3v3uza2+iWTOTsaj5l8jEF1r3+3AzazKREypyMeL0+DDFtT9lI9vtOw2yybodYympCv+5dtbrJiefTqciE/O2CZf8kjMSDq+4m+NVCtXGOsX2Gu9tRIFmWeOS1yab/PkXtuB+eQ==
sidebar_class_name: "post api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create a new session for an agent."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/agents/{agent_id}/session"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create a new session for an agent.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to create the session for.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"session_name":{"type":"string","description":"The name of the session to create."}},"additionalProperties":false,"required":["session_name"],"title":"CreateAgentSessionRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An AgentSessionCreateResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":"string","description":"Unique identifier for the created session"}},"additionalProperties":false,"required":["session_id"],"title":"AgentSessionCreateResponse","description":"Response returned when creating a new agent session."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/create-a-new-turn-for-an-agent.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

73
docs/docs/api-deprecated/create-a-vector-store-file-batch.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/create-an-agent-with-the-given-configuration.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

73
docs/docs/api-deprecated/create-chat-completions.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

73
docs/docs/api-deprecated/create-completion.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

73
docs/docs/api-deprecated/create-embeddings.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

73
docs/docs/api-deprecated/create-moderation.api.mdx Normal file
View file

@ -0,0 +1,73 @@
---
id: create-moderation
title: "Create moderation."
description: "Create moderation."
sidebar_label: "Create moderation."
hide_title: true
hide_table_of_contents: true
api: eJztWM1u20YQfpXBnpJAlp2gRRvdHMdFAySwYTsoCtsIRuSQ3GS5y+yPFMLQM/TeUx+jz9MX6CsUs7uyaEl2nCA9BLAupsnlzDez3zfLmSthyXVGO3JiciWe7e3xn5JcYWXnpdFiIvahNSVZ5H/BTN9T4cdiJAqjPWnP67HrlCzigt33jl+6Eq5oqEW+8n1HYiLSm2IkOms6sl4ml7IcrHHeSl2L0RqCs4YgaPkxEMiStJeVJAuVseAbGqKz9DGQ82OxGAm+re5nOy6F4KgEb6AmzfZo07gLyrtoPF8PzKO12IuRkJ5a9/mwK4V1TcPYp8YoQr0B8LeGfEMWUPdgqghqSsrMoUBPtbGSHKAlyBYjvNWjbUiwLCUbR3V8A9MakMU6kn1Q0vkliJWPEaAuYZ5x+ob6ISAwFrTxQ1z9u8gYKt9J3QX/jh1/DdLbcp63enHvCACV0TXMpW/ikwgL2Noj9xh8gz7edoWxBAm7A29uxhSffk0YOrRTsvfP9xpaaRMwB+igs1TKwlMJ0z7xOoIMjuy7lpzDmrYkaiRa8lii3yrY2+AbTUeVmJwPAlFKLEZbmLQZ6yaGtW0d3MhIFpcL3tLtcCpUjliYH4O0LKzza40NorscCS+9YqNvrpV9FM2fZElv7sKW8nfHXm2sduKLUMsIOBavVZ25A/c9AcfU/bCtvnMFzIUT5uhA6hkqGXXboqqMbWMOv1G9dx59GLJfak812Y0wfj07O4a0GgpTEuc85+BzNf3QWj4bePEIEFxjrAcX2hbtdQ2luGbeyKIBmYK2ErWPxwrq/Dz6iZvtUd7jNEme02p2zUIlC01oUe9YwhKnimDwzg047Elq51EX94jy0VGXCPUY9uHtyescTIEapnR9mlnyVtKMTzLLhY33M1EDpybkutZRIStZgCmKYC3pgtZwfQmB8w4vd+s6eQMOxzTdkrzlBwlU1rQRw/7xqzGcmFA3qofKKGXmDk5+OYCfft77KWqRPmHbJWYs+fXD3t7K3wss4SRRfIXnnszPynn2fLtyCiVJe2jQgeMLbwy0fFZnw2wVEGo5Iw3YmqBTRZctPYjqQVTfmaiePV/5OzMG3jDTs7LcUFq/mwANzgjoU0FUctpYbPxZrWQr/RiOFaEj8LYHrFFqUOjJLk+qH287qRzZGVkgXbCUyFLJxAqaPnUUv3sop+FBWg/S+o6k9ePwvHrFzNao4DSxfeU/y2t/k/LLZJRjOAoWPGEbT6UpkeYGjJvmcimvkioMym9p9u8w/CCqB1F9X6La2+btHhKKKmGqYe04mlOsyPcM/ibYA0t8oq36rfGFPlDoHIvNgazA0yfP45FdY0G2WOfZQhrZdIbFJFGpHhq0bRUUT9Y6tNiSJ8u+L1NeyfkXpuw5uG81eGMcW9v42zryOwYtG5l5FScojzjqGO9jpmGRUtOP4SDxE8FJXSuCZIgHSRB9MfPSPTeCpMXr+21QXu60pkSVBzW5zwYnW6nQsisTZ1GxjXZfOg7MCR620WlC2JsAcxNUCUp+IHYTHI2/sL2PaV/iGcjhJOhVa79sViILV697GygWos4Sz4PyrTjgaEwpJqIzscXp0DdiInZnT3dNRxolX63iYWGmDykXNz5YVkTjfTfZ3UXd7zTGeSp3lMIWd5zH4sO4MK3gfXZUBCt9H198uTxHzi/5GXPwZMXWw5UiM9tWac/7MRhBcVmKG5QT8pqdwyk7h9NcnNJu7MDL6wxwYeBwOJa0hbOnW3aVq7u7UedwWHmHvuK4r7NmJktyFxrWfgiOYgtHuuyM1KxlXeZBXGFsKl2l1DXwqWYrLHhYyEbR0oXm8mNsrMubxqfciiqakeVSkVC9SSS+0Bf6yZN//vzr37//gJeHxyeHB/tnhy+fPJnAa6qx6GMmkqMWe5aXpdbMqOQOtAo+WIKcJTeGt1xcudGV9fV8u6Jc9rXqo2iYTS3GsqKxpa0Vbz3ZgwL1P9XHrGB+dbdTKOOoOlL4KhP/PJEgUZ/J8TQzbkn/y5FgivPKq6spOnpr1WLBtz8Gsn2qu/FjYMpcPL9cjERDWJKNtP9APUeX4tw5Yzy8XIVYLNeLMhfS9MZ+UVDn71x7ORDz8dHpmRiJaS78HICYCItzngziXExEDDKFNLlK966EQl2HOOgVySb//gMWwBm7
sidebar_class_name: "post api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create moderation."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/openai/v1/moderations"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create moderation.
Classifies if text and/or image inputs are potentially harmful.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Input (or inputs) to classify. Can be a single string, an array of strings, or an array of multi-modal input objects similar to other models."},"model":{"type":"string","description":"The content moderation model you would like to use."}},"additionalProperties":false,"required":["input","model"],"title":"RunModerationRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A moderation object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the moderation request."},"model":{"type":"string","description":"The model used to generate the moderation results."},"results":{"type":"array","items":{"type":"object","properties":{"flagged":{"type":"boolean","description":"Whether any of the below categories are flagged."},"categories":{"type":"object","additionalProperties":{"type":"boolean"},"description":"A list of the categories, and whether they are flagged or not."},"category_applied_input_types":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"A list of the categories along with the input type(s) that the score applies to."},"category_scores":{"type":"object","additionalProperties":{"type":"number"},"description":"A list of the categories along with their scores as predicted by model."},"user_message":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}}},"additionalProperties":false,"required":["flagged","metadata"],"title":"ModerationObjectResults","description":"A moderation object."},"description":"A list of moderation objects"}},"additionalProperties":false,"required":["id","model","results"],"title":"ModerationObject","description":"A moderation object."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

73
docs/docs/api-deprecated/creates-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

19
docs/docs/api-deprecated/dataset-io.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: dataset-io
title: "DatasetIO"
description: "DatasetIO"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

19
docs/docs/api-deprecated/datasets.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: datasets
title: "Datasets"
description: "Datasets"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

72
docs/docs/api-deprecated/delete-a-response.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: delete-a-response
title: "Delete a response."
description: "Delete a response."
sidebar_label: "Delete a response."
hide_title: true
hide_table_of_contents: true
api: eJztWMFu20YQ/ZXBnhKDlpwgQRrd1EhFDTiwociHwjaK0XIobrLcZXaXsgWB39B7T/2Mfk9/oL9QzJKUaEtuHaCXANZFFLmz8+bte7scbYQjX1rjyYvRRrw+OeGvlLx0qgzKGjESYwPnJZnx6YQ0BZq1AeeLzySDSIS0JpAJHIhlqZVEDhx+9hy9EV7mVCBfhXVJYiRsF1g6W5ILqsmt0t4YH5wyS5E8gHJp1NeKQKVkgsoUObAZhJwgjdBS6KoRddLlOTCptMYHMdrWHvNkWOm9m/3kTcHAk/UQJID6FtcerreR14LTt5B6+RfWakLTzxZcRQ/zRJqVNSCtyZQrIp2QaVxuc81dRaKuE4Fpqvgx6osemRlqT4lw9LVSjiFcMbvJjvkO200iggqawf3rEt8H2D2GZr4OpzLLZh0Yrs0AO91sV2Ug6ppRvzkks3lOwIjJB7hFD8qsUKsUrIMCdWZdQen/pzYfMFS+N06ZQEtye8X+PJ9fQDMapE2jslrO/kutU+esgzg4AQSfWxfAV0WBbt0Jl+KY21zJHFRTtFNoAmTWMYPN85gnaiqg0k/N3Izm1NqaJTnIqwLNsSNMcaHZNNuYe3A4kzI+oJFPqPLFedko8CWM4XJ21hYj0cCCoPKUQrDgKDhFK4LCOgJleD0bYePCViEm9yVJlSkJVsrKOTKSHuD6FsW3K9yt1pa8nuYjTY+Q12kWMmeLiGF8cTqAma2WuV5DZrW2tx5mP32Adz+cvBswaXSHRdkoo9PXm5OTXb4fMYVZI/Ednicqv3XO6/eHnSO1IhMgRw+eL4K1UKBZdxPzrICwVCsygIWtTIjcqoKeTfVsqu/MVK/f7/LNrYWPrPTWWb5vrV9sBTmuCOhOEqVMG5sNA4FWhQoDuNCEniC4NeASlQGNgVx3Ur197KTy5FbkgIxkK5GjlIVVGborSfKbCLU0PFvr2VrfkbXe9s+rU1a2QQ2fGrXv8rf2Gu9LviMjHcB55SAQFvFUWhAZMDa+NKedvbbvwQd6jkcnfjbVs6m+L1OdHMr2BAtFl7DUcOm5mvGSTPAM/kDHSIC9RisRJTosKJDj0I0wWFCvu/01NoSKo0sM+V79fMadTjrmH/RxvJZNC8mJdnw33eye+1rN1HUEXjqSGHbDCwq5TcWobUoj8pCLkRiuXg1tSQYVX23/pxhuejXUIhHNUdxUWTnmNA+hHA2HaNbHufWB0mOtscBjH1B+GUhbCIbiSVZOhXUMnHQ70dUNP2NtxgraZTvjePjE8fCpVWij3GOYbEtidbDYGE5D4+rVAWbZ4v6e2LFvv36ukGOA0tmVSslfG3jwQfAU3+PJpKVVJnhAE99xlANpXcNUyp05b20uQ0m+mRQdXRvWoHXRnPuTL7gf0bQih8sO1UebkvaDa3Ntjo7++v2Pv//8DSbTi9n0w3g+nRwdjeCMlijXkYkmUYFr3gMcFXZFKbchWRUqR9Cy5AdwyQ7jbkctXUOFo4xa7xu9jr4qrQ8Fxv291fJB2d8je7M7KQ6PbhUa6C4MS43KcKYook0rw6tmDRsh8tq+ipLv/jRLxKhvqZtEsOI4bLNZoKdLp+uab3+tyLHUbhIRd/cF6+pqI1Ll+Trdbl+PFvBi1hrtJXyDOw9W2N5Es+aKUFf8SyTiC60f7BH1TZ2InDAlF+E2I8ZSUhl6sXunMJto6+zJ9Gw6n4q6/gex2iJm
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete a response."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/openai/v1/responses/{response_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete a response.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"response_id","in":"path","description":"The ID of the OpenAI response to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An OpenAIDeleteResponseObject","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deleted response"},"object":{"type":"string","const":"response","default":"response","description":"Object type identifier, always \"response\""},"deleted":{"type":"boolean","default":true,"description":"Deletion confirmation flag, always True"}},"additionalProperties":false,"required":["id","object","deleted"],"title":"OpenAIDeleteResponseObject","description":"Response object confirming deletion of an OpenAI response."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/delete-a-vector-store-file.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: delete-a-vector-store-file
title: "Delete a vector store file."
description: "Delete a vector store file."
sidebar_label: "Delete a vector store file."
hide_title: true
hide_table_of_contents: true
api: eJztWM1u2zgQfpUBT22g2GnRoq1v2drFBkiRwEl2sUiCYkyNLLYUqZKUG8PQM+x9T/sY+zz7AvsKi6Ek/7dN0V4KJJfIFjk/33zfkOOFcORLazx5MViIp0dH/C8lL50qg7JGDMQx/EYyWHcRrKM3StOQNAUatxtBmVRJDMpMIeQEKb9V1oAPGCrfE4mQ1gQygU1jWeq42pr+e8/2F8LLnArkpzAvSQyEnbwnGUQiSmdLckE10al0bY0PTpmpSLaCvTLqY0WgUjJBZYoc2GwVFqWQKU2iTjofew1mWOkgBmIW837nOfEeb+y1VnbcnkVrwKbWfWfWbWLSoc0RdLZWIUys1YRmPYbgKtp29ntOIactywxUhBU+oQdfSUneZ5UWdZ0ITFPF71CfryGaofaUCEcfK+U4kGuGOFnB30V4m4igguYQv0iFHViWHMmcLdpYzRQQGmQhIhtL0hN1zZE+28fAy5yAoyQfYnbKzFCrFKyDAnVmXRFL8oNo1vB2bZ0ygabkdrL79fLyvGU5SJvGorY4fY2mI+eYGrw4AQSfWxfAV0WBbt4xluKaT7mSOagmaafQhMgqNO376CeyKaDS9/XcrGbX2popOcirAs2hI0xxoplWyz0b4bAnZXxAI++R5aOzsmHdYziGq/Fpm4xEAxOCylMKwYKj4BTNCAomgzJcz4bJOLFViM59SVJlSoKVsnKOjKStuL6F5W2Fu2otwVvjeYTpM+C5DVZzDMfnJz0Y22qa6zlkVmv7ycP4zWt48fLoRY9BozssyoYZHb+eHR2t/P2CKYwbiq/iuSfzW+U8fbVfOVIrMgFybgv8EKyFAs28M8xWAWGqZmQAC1uZELFVBT2I6kFUP5monr5a+bu0Ft4y01tl+XVp/WEryHFGQHeSKGXYWGwYCLQqVOjBuSb0BMHNAaeoDGgM5LqT6vnnTipPbkYOyEiWEjlKmViVobuSJF9BqIXhQVoP0vqJpPV8/bw6YWYb1HDRsH3lv5XX8S7lOzDSHpxVDgJhEU+lCZEBY+OdOe3ktbwB74wjXzD8IKoHUf1cojra5+0eEooqYarh1HM2zVx2csbhb4bbjGj7Z65ElOiwoECOrSyEwYK2Bt93cSZUbKrEkO/AwUfeybArxIYT1iIq0/0ywD651s1Yyd5X9Wjm3B11tpyq62QZG1v5tpi+x2+Es3QkMayWFxRym4pBOyBHGEMuBqI/e9K3JRlU/LSOou8vtkCt+xyX7y/ahGqRiObq0JSicsyBPIRy0O+jmR/m1gdKD7XGAg99QPmhJ20hOERPsnIqzOPGYdc5r2/5HWspZtbS7JT3wwXvh4tWUY3SDmG4TJXZzOLgcBpMZ0/2wMwtyW+IE9fbxbqvkGOA0tmZSsnfGNj6Q/AU5w4yaWmVCR7QxDuZciCta/SWMpe4FbsMJfnGKDq6YaJp62Iz2TU+4flJ04wcTruo3tqUtO/dmBtzcPDvX3//98+fMBydj0evjy9Hw4ODAZzSFOU8ItE4KnDOPctRYWeU8tiUVaFyzPqIku/BFXcEns7UtP05xlFGba8yeh77QGl9KDCeRy2pvyzSDdQXqyPuK9taLge6C/1SozLsO9Jq0RL2uqlqQ1mu9pNY8jXaikQMdrtBZC6/6sR4mwimJ1tcLCbo6crpuuavP1bkmJe3iYhH14RJeL0QqfL8nC5782eTfDRu1foYvqfX7EWj/RLNnBNHXfEnkYgPNN/TBrkL/YC4f0hsHfL1bZ2InDAlF3Ft3h5LSWVY27dzF+LWsOxjw9Hp6HIk6vp/t5+1lw==
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete a vector store file."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/openai/v1/vector_stores/{vector_store_id}/files/{file_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete a vector store file.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"vector_store_id","in":"path","description":"The ID of the vector store containing the file to delete.","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","description":"The ID of the file to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A VectorStoreFileDeleteResponse indicating the deletion status.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deleted file"},"object":{"type":"string","default":"vector_store.file.deleted","description":"Object type identifier for the deletion response"},"deleted":{"type":"boolean","default":true,"description":"Whether the deletion operation was successful"}},"additionalProperties":false,"required":["id","object","deleted"],"title":"VectorStoreFileDeleteResponse","description":"Response from deleting a vector store file."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/delete-a-vector-store.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: delete-a-vector-store
title: "Delete a vector store."
description: "Delete a vector store."
sidebar_label: "Delete a vector store."
hide_title: true
hide_table_of_contents: true
api: eJztWM1uGzcQfpUBT4mxluwgQRrd3EhFDTiwIdstCtsIRtyRlgmX3JBc2YKwz9B7T32MPk9foK9QDHdXWv24dYFeDNgXy1py5ptvvo/c8VI48oU1nrwYLMWboyP+lZKXThVBWSMG4gR+IhmsuwzW0ZA0BRo3m0CZVEkMyswgZAQpP1XWgA8YSt8TiZDWBDKBw2JR6Ljamv4Xz7GXwsuMcuRPYVGQGAg7+UIyiEQUzhbkgqqRqbSzxgenzEwkW0CvjfpWEqiUTFBTRQ7sdA2LUpjHOsBzIaJK2lx7A0+x1EEMRL3nc9zTawLtZD6PgYCjdNNPrdukpSWbk7ex1tkn1mpC000fXEnbyX7OKGS0FZm5iszCPXrwpZTk/bTUoqoSgWmq+Bnqiw6pU9SeEuHoW6kcA7lhlpN1B1qEd4kIKmiG+KgSdihZSWTqbN7gNDPAjSb0RFUxwLf7dHeVETA48iEWpcwctUrBOshRT63LYyf+J4HViu2sUybQjNxOYT9eXV00+gZp09jLhp5/E+jIOVYEL04AwWfWBfBlnqNbtFqluOY+UzIDVRftFJoQxYSmeR7zRBEFVPqpmevVnFpbMyMHWZmjOXSEKU40q2m1ZwMOZ1LGBzTyCVW+Oi9qsb2GE7genzXFSDQwISg9pRAsOApO0Zwgt47PEe5nLWCc2DLE5L4gqaZKgpWydI6MpC1c/0XcTYfbbq3I68g70vQIeW5D0Izh5OK0B2NbzjK9gKnV2t57GP/wEd5/d/S+x6TRA+ZFrYxWX2+Pjtb5vscUxrXE13ieqPzGOW8+7HeO1IpMgIxPA/4QrIUczaINzFEBYabmZABzW5oQuVU5vZjqxVTPzFRvPqzzXVkLn1jpjbN811q/2BIynBPQgyRKmTY2GwYCrXIVenChCT1BcAvAGSoDGgO59qZ699hN5cnNyQEZyVYiRykLqzT0UJDklw9qaHix1ou1npG13nXvq1NWtkENl7Xa1/kbe53sSr4lI+3BeekgEObxVpoQGTA2viqnrb1WL747Q8g/BH4x1YupnpepjvZle4KFoktYajjzXE09jp2eM/xNuPV0tjNuJaJAhzkFchxgKQzmtDXlfo5ToOIoBYZshwm+7U6HbQ+68bml9dDImda011Psjgkb6VRVRF84khjWy3MKmU3FoBlDI/SQiYHoz4/7tiCDij91kfv+cquQSiSivpnrckvHFGchFIN+H83iMLM+UHqoNeZ46APKrz1pc8GQPMnSqbCIG4ftwXRzx89YqrGSpotnvB8ueT9cNoKthXwIw1VpLBbWHsOpuZwf76GXHe83tI9dN3ZzhQwDFM7OVUr+1sDWD4Kn+FpPJi2sMsEDmvjKoxxI62o5pzyY80nnpijJ10HR0a1hSVoXvbobfMLjiaY5OZy1qD7ZlLTv3Zpbc3Dw52+///XHrzAcXYxHH0+uRsODgwGc0QzlIjJRJ8pxwUeCo9zOKeWpZFqG0rGyIku+B9dsOB5+1Kz5J4ejKTVHgdGLaLPC+pBjPO4bUT/qgQ3Cl+vL4/EdjWIDPYR+oVEZzhjFtGxkeVP3shYm9/g4NrojTpGIwbbP7hLBCuTty+UEPV07XVX89beSHEvvLhHx8J+wzm6WIlWeP6er0+3RYl6NGwO+hqdadm+ZzZdoFlwR6pL/Eon4Sos9J0d1VyUiI0zJRbz1qhMpqQid/Tu3NLtqZfnh6Gx0NRJV9TcAjDkN
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete a vector store."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/openai/v1/vector_stores/{vector_store_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete a vector store.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"vector_store_id","in":"path","description":"The ID of the vector store to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A VectorStoreDeleteResponse indicating the deletion status.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deleted vector store"},"object":{"type":"string","default":"vector_store.deleted","description":"Object type identifier for the deletion response"},"deleted":{"type":"boolean","default":true,"description":"Whether the deletion operation was successful"}},"additionalProperties":false,"required":["id","object","deleted"],"title":"VectorStoreDeleteResponse","description":"Response from deleting a vector store."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/delete-an-agent-by-its-id-and-its-associated-sessions-and-turns.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: delete-an-agent-by-its-id-and-its-associated-sessions-and-turns
title: "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."
sidebar_label: "Delete an agent by its ID and its associated sessions and turns."
hide_title: true
hide_table_of_contents: true
api: eJztV8FuGzcQ/ZUBT4mxlpwgQRrd3EhFjTqIYTuHwjaKETnSMuGSG3JW8ULYb+i9p35Gv6c/0F8ohruy5chpfcglgHURteTMvJl5b6hdq0ipDj5RUpO1en5wIF+Gko62Zhu8mqh3v6iuUC/u2zovCSJ9aigxfMYE1q/QWQMhQoVuEWJFRhVKB8/kWeyxrp3VKPbjD0mcrFXSJVUoK25rUhMV5h9IsypUHUNNkW2PLjFyk7bOWc+0pKiKL2D9fH5+Av1p0MGQ4GfLjrZsE0frlzumsxhDhHy4AIRUhsiQmqrC2EJYAJcElM98Lq0uwfZJR4ueYREioB/2c5xO/DNa99DI/WkJ7YJfUoSyqdDvR0KDc0ewZXMHjkSyPjF6/YAsn7zLK3RP4RDenx4PyWj0MCdoEhngAJE4WloRVCESWC/9zJ0DnIeGc/BUk7YLqyFo3cRIXtMXuLpCoTG2j3ey1dAFukSFEv7YSEZNLjYd3nTrpnhXN/3ry/SV4m24DIsYqozh8ORoBKehWZauhUVwLnxOcPrTG3j1w8GrkRSNrrGqe2Zs+PXi4OA23o9o4LSn+C2eBzK/6yT7F89f368c7Sx5hhITJFlwCFChbzeOxSsgLO2KPGAVGs+5traiR1E9iuo7E9Xz17fxzkOAt8L0QVlpW1q/hgZKXBHQtSYyUjYRGzKBs5XlEZw4wkTAsQVcovXgkCmOBr29/NpNlSiuKAJ5LVKiSEaI1Xi6rkkzmaG4j9J6lNZ3Ja2X2/fVkTDbo4Oznu238Qd5He5SflMMM4J3TQQmrPKtNCfy4APbhSWzkZehBTaOdyX2X44fRfUoqu9LVAf3RXuAhLJKhGq4TJLN4ZI8JwF/F+yUHDEJU1BOwLwFywmOpoDe5CWmFLRFCZEoJRt8ynvcRJ9GIgyMWBFTlEBr5bEStNndb1YkZyVQjVzulEquw6Pppkk9Ag5gMijxfdsQjg0Vu/IcSNV1ObM6khakm+MVcRmMmqjeYwbLpZqo8erZOIdL4/UGaacK1d/NfSJNlCKXzPVkPEbf7pchMZl957DC/cSoP450qJSETqSbaLnNhtPNaLq4kj0ha0Y89PFY7OFM7OFsoGxP5X2Y3qQgdBH2CZy+WKtn99RPNJ/usB+39bgdi0tkqGNYWUPp0sMXH4RE+Y89eVMH63loc0k2gg6xJ7Sxfgky6+ICNaXeKUa69ELKELNad53P5QXF0YoiLjeo3gZDLo0u/aXf2/v7jz//+et3mM5OTmdvDs9n0729CRzTEnWbK9EHqrCVoRCpCisy8l6yaLiJBEOV0gjei+Tk9ccuY1+KSAsahoF3bRZaHRJXmAf+QNdvoIM7rVnfXjTfwvfAdqZrHtcOrZcsMkHXA6Uven70pFaFmtwI8KpQwlw5sl7PMdH76LpOHn9qKAplrwqVr4258PNirYxNsjY3c/GrqT05HQT6FP5Xy/fmMDxE3wrX0TXySxXqI7XbQ6S76gpVEhqKGWG/fag11bxluHOji/5uhsB0djw7n6mu+xfNDGte
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete an agent by its ID and its associated sessions and turns."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/agents/{agent_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete an agent by its ID and its associated sessions and turns.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/delete-an-agent-session-by-its-id-and-its-associated-turns.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: delete-an-agent-session-by-its-id-and-its-associated-turns
title: "Delete an agent session by its ID and its associated turns."
description: "Delete an agent session by its ID and its associated turns."
sidebar_label: "Delete an agent session by its ID and its associated turns."
hide_title: true
hide_table_of_contents: true
api: eJztV81uGzcQfpUBT4mxlpwgQRvd3EhFjTqI4TiHwjaKETnSMuGSG3JWsSDsM/TeUx+jz9MX6CsUw139OHIKp+klgH3xapfDb+ab7xvurlSkVAefKKnRSj09OpJ/hpKOtmYbvBqp1z+rtlDP7np0URJE+tBQYviICaxfoLMGQoQK3SzEiowqlA6eybPEY107q1Hih++SbLJSSZdUoVzxsiY1UmH6jjSrQtUx1BTZdtklRm7SzjrrmeYUVfFJWj9dXJxBtxp0MCT5s2VHO7GJo/XzvdBJjCFCXlwAQipDZEhNVWFcQpgBlwSU13wsrS7BdkVHi55hFiKg759nnFb2Z7TuvsjdaoF2wc8pQtlU6A8jocGpI9iJuZWOIFmfGL2+R5WPXucrdI/hGN6en/bFaPQwJWgSGeAAkThaWhBUIRJYL/3MnQOchoYzeKpJ25nVELRuYiSv6ZO82kKhMbbDO9tp6AxdokKJfmwko0aX6w6vu7Uh73rTv46mz5C31jLMYqhyDsdnJwM4D828dEuYBefCxwTnP76E774/+m4gpNENVnWnjLW+nh0dbfF+QAPnncS3+dxT+W0r1T97+uJu52hnyTOUmCDJBYcAFfrlemPZFRDmdkEesAqN58ytrejBVA+m+sZM9fTFFu8iBHglSu+dlXat9UtooMQFAd1oIiO0idmQCZytLA/gzBEmAo5LwDlaDw6Z4qD32/PPnVSJ4oIikNdiJYpkRFiNp5uaNJPpyX2w1oO1vilrPd89r05E2R4dvOnUvsXv7XW8L/k1GWYAr5sITFjlU2lK5MEHtjNLZm0vQzNsHO9b7N82fjDVg6m+LVMd3YV2Dwtll4jUcJ6kmuM5eU6S/O1kx+SISZSCsgISpSSsTpdgOcHJGNCbfIkpBW1RoLiJPg3EExixIqYoGCvlscqN7vb41YrfrKDUyOUeT3IWnozXHVoDcwCTc5L9t/3g2FCx785eU21bbNBzHV+G3ZW+Qb6VzyzEL8skU1xH0kLVenlFXAajRqpDyNRxqUZquHgyzPBpuFpn3g578OFqS2WrCtW9OXRcN1EkUDLXo+EQ/fKwDInJHDqHFR4mRv1+oEOlJJ9EuomWlzlwvB6cl9fyTKyUy+hVdirx8Ebi4U1vqM5ohzDe1CViFm9IOh2jiyd3kCwTKd3yJu5Oi10sLpGhjmFhDaUrD5/8ISTKnx3kTR2sF0H6/EpmI+gQO7sZ6+cgkzjOUFPqNsVIV14sE2KeJfubT+XzydGCIs7XWb0KhlwaXPkrf3Dw1+9//P3nbzCenJ1PXh5fTMYHByM4pTnqZWaiA6pwKSMrUhUWZOSradZwEwl6ltIA3spAkI8zO48dFZFm1I8q75Z5DNQhcYX5OOo1/XUuvdWV1fYE/Mpte+Ez3fCwdmi95J5luerVfdmpotO3KtRox5s9ltzdmRfXhRIdS+hqNcVEb6NrW7n9oaEoAr4uVD7ipqLWy5UyNsm12czwz1b76Lz38GO4x+i5s7r+JvqlaB9dI79Uod7T8vbck3n0P2R2j8H0H/LcdKG9bgtVEhqKmcvu8bHWVPNO4N57ksyNzUQbT04nFxPVtv8A/bHhRA==
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete an agent session by its ID and its associated turns."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/agents/{agent_id}/session/{session_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete an agent session by its ID and its associated turns.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"session_id","in":"path","description":"The ID of the session to delete.","required":true,"schema":{"type":"string"}},{"name":"agent_id","in":"path","description":"The ID of the agent to delete the session for.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/delete-file.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: delete-file
title: "Delete file."
description: "Delete file."
sidebar_label: "Delete file."
hide_title: true
hide_table_of_contents: true
api: eJztWMFuGzcQ/ZUBT4mxlpwgQRvd1EhBDTiIoTgoCtsoRuRIy4RLbkiu7IWw39B7T/2Mfk9/oL9QDHdXki0ZdYBeAlgXrXbJmcc375E7WgtPoXQ2UBCjtXh5csJfioL0uozaWTESYwsfSrLj03fa0IQMRZp1k0BbpSVGbZcQKikphEVlQPEg7exAZEI6G8lGDotladJoZ4efA8deiyBzKpCvYl2SGAk3/0wyikyU3pXko26RabUzJkSv7VJk94Be5AQLbQi0Ihv1QpOHmGOEGwwtJlKiyfoUB+JJZ0MUI8FRUvgFVubOjfv52ljAgTK4ybXMQQdAc4N1gKs070pw0j7/NuvcOUNo98L+klPME/RuOQx/y66pt2tpMoFKaZ6I5nyHsAWaQJnw9LXSnrNeMoPZlt0+xHUmoo6G8TxU5D2Am+ovnO9qbZeAHfe9WoAjBRifnw5E0zDUV4fUxSQyTAptnbRdodEKnIcCzcL5gtT/J6MQMVZhZ5y2kZbk99b488XFObSjQTpFXMKOqP+S4dR75yENzgAh5M5HCFVRoK/BLVJdKY3Z6IUX7TXamChF2z1PeZJ2Imrz2MztaE5tnF2Sh7wq0B57QoVzQ7Az5w4czqRtiGjlI1b57EPZyu45jOHT7KxbjEQLc4IqkILowFP0mlYEhfOsDa5nqhzg3FUxJQ8lSb3QEpyUlfdkJd3D9S0y7yrcV2tD3o7QE00PkOc32vauSBhYwDBz1TI3NSycMe4mwOzdW/jhx5MfBkwa3WJRtsro9fXq5GSb7ydUMGslvsXzSOV3znn55rBzpNFkI+S8Q/BFdA4KtHUfmKMCwlKvyAIWrrIxcasLejLVk6m+M1O9fLPNd+EcvGeld84Ku9b61VWQ44qAbiWRYtrYbBgJjC50HMC5IQwE0deAS9QWDEby/Un1+qGTKpBfkQeykq1EnhQLq7J0W5KMpDpyn6z1ZK3vylqvd8+rU1a2RQMfW7Vv83f2Gu9LvidDDeBD5SESFulUmhNZsC69javeXpv36gOtxoOBn0z1ZKrvy1Qnh7I9wkLJJSw1XAZeTWqkGPtdrG2XlroubrRL9FhQJM9z1sJiQV3j+ltq/TTPKTHmB/vY00lPd+riouPqJSHGXIf+dZLzbHmOvqJs33WdVpomIS49SYzb4QXF3Ckx6jrQBDzmYiSGqxdDV5JFzVeMIgzXHfxGZKI9etvFVZ45zGMsR8Mh2vo4dyGSOjYGCzwOEeWXgXSFYAiBZOV1rNPESb/zXF7zM9ZiQt6V6Yznw0eeDx87RbZKPYbJZimsBhYXw2kZXL04QCpbOtwRN+7abTdX+pei9G6lFYUrC/c+CIHSeztZVTptYwC06Z1Ge5DOt3pV3IXzVuYXKCm0QdHTlWXNOZ/MuB98zv2HoRV5XPao3jtFJgyu7JU9Ovr7jz//+et3mEzPZ9O344vp5OhoBGe0RFknJtpEBdbseU+FW5HitmNRxcoTdCyFAXzqFFXopW+p8LSgzuvW1MlHpQuxwLSfdxK+p/M7NK+3Z8L9cZ0aI93GYWlQW46ehLPuJHfZ1q0VHdeTfyXhiUyMeudcZ4LVxcPX6zkG+uRN0/DtrxV5ltV1JtLOPWcNXa6F0oGv1WZrehDys1lnpufwbSY8uLjuJtqaF4Om4l8iE1+o3tkJmusmEzmhIp/Qtk/HUlIZd+btHbDsl415J9Oz6cVUNM2/lckMtA==
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete file."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/openai/v1/files/{file_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete file.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"file_id","in":"path","description":"The ID of the file to use for this request.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An OpenAIFileDeleteResponse indicating successful deletion.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The file identifier that was deleted"},"object":{"type":"string","const":"file","default":"file","description":"The object type, which is always \"file\""},"deleted":{"type":"boolean","description":"Whether the file was successfully deleted"}},"additionalProperties":false,"required":["id","object","deleted"],"title":"OpenAIFileDeleteResponse","description":"Response for deleting a file in OpenAI Files API."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/describe-an-agent-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

19
docs/docs/api-deprecated/eval.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: eval
title: "Evaluations"
description: "Evaluations"
custom_edit_url: null
---
Llama Stack Evaluation API for running evaluations on model and agent candidates.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

72
docs/docs/api-deprecated/evaluate-a-list-of-rows-on-a-benchmark.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

19
docs/docs/api-deprecated/files.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: files
title: "Files"
description: "Files"
custom_edit_url: null
---
This API is used to upload documents that can be used with other Llama Stack APIs.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

72
docs/docs/api-deprecated/get-a-benchmark-by-its-id.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: get-a-benchmark-by-its-id
title: "Get a benchmark by its ID."
description: "Get a benchmark by its ID."
sidebar_label: "Get a benchmark by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztWMFuGzcQ/ZUBT4mxlpwgQRvdnNhNDTiI4TiHwjaMEXekZcwlN+SsbEHQN/TeUz+j39Mf6C8Uw92VVrbspEAvAayLVtwhZ+bxPVIzCxUoVt5Fimq0UC/39uQrp6iDqdh4p0ZqH96S00WJ4XqgMqW9Y3IsdlhV1mgUu+GXKMYLFXVBJcoTzytSI+XHX0izylQVfEWBTePK5OTYTAyFnm3kYNxULZPxzOQUrgJFXwdNVyZ/3PCB983A3ReZIleXanSuSp+TVZmKhSGbq0zNSLMPV5F9IJWpHBkjSfxRe5l7NamdTtBkatwBozLF3tv262oafF01KZcVq8uEWmQ12piR0wRre3+0D/5ZQdBBAJJDBmhvcB5hPWe5inIrCHeXPFohD34CXBC0s4E91JFg4kMaXnkAmqGt0z6Ls7tAxJ5PDAHnKlOGqYxbN2QzmGMTWcJo14RuTVjzI0pcQrU55HUy2gynJEbJYBvnMM+N2KE92WCfd/RxokbnqxmutlYts9XvsfeW0PWHXF2OKfRHVkndSb830EayvLyX+Yc27BZuE3tpAWO8VsvlQwlM0EbKVKCvtQmUC497etoURSuBDY5s28MekJeZYsNW4n/7IDP3e/xYMVRy6dJwU0jigorCxIcSnaaBWi4lrVfbDpqG619rigw3GMG4GVqTgw9QopUlKP//DqDIyHWfosYxTRN8m2H9enZ2Ao01aJ9TOlUaeL4ltcMQZHPFOAOEWPjAEOuyxDDvxEfJ5qYwugDTJB0MOk5YomvfJz+JQ4zGfq/nxlpcW++mFKCoS3S7gTDHsSXozdkIRzwZF1m27Nu+nn2sGoo+h334fHrcJqPRwZjkRMlFwYE4GJoRlD4QGJcokTzj2NecnMeKtJkYDV7rOgRymu7E9V8k0e5wt1sr8Hr0TjA9AF53M8Ik+DLFsH9yNIBTX08LO4eJt9bfRDj95R389PPeTwMBjW6xrBpmdPx6tbfXkxPmcNpQfB3PdzK/Vc7LN9uVo60hx1BghCgP7D2U6ObdwrIqIEzNjBxg6WuXDl42JT2J6klUP5ioXr5Z+zvzHj4I01tlxb60fvM1FDgjoFtNlAtsIjZkAmtKwwM4sYSRgMMccIrGgUWm0N1Urx+6qSKFGQUgp0VKFCgXYtWObivSTHkL7pO0nqT1Q0nrdf++OhJmO7TwqWH72n8rr/37lO/AyAfwsQ7AhGW6lcZEDpxPf1LzTl6rGuhe1fnIwk+iehLVjyWqvW3evkNCSSVCNZxGyWZVjkVJYDPg98SAvaJsPAfDEY4OpGtTYcCSmEJMVa/Dkvp9h6YoNLJMhVxsbUMcHXTbsPbBHqbE4mCNOYeasvsK7IrlZQq8CqSR1+YlceFzNVLT1GtJQYzUcPZiKOXkcOUxDhf9oJdSyqajqcmrDoJowVyNhkN0893CR6Z811oscTcy6uuB9qWSICLpOhiep4kH3Tl0finvhJkp9nbTjmU+fJL58KnlZ8PbXThYJSPciKmFFGKD2+zFFihF4HGD6tgXX98XF8jQVvPxwsGdD4K0bfwEyOWVN44joEv/cEwA7UPD3lxKcTnYwgQ1xWZRDHThhIE+JGneX3ws1YilGQWcdlF9kII+Di7chdvZ+fuPP//563c4ODw5PXy3f3Z4sLMzgmOaop4nJBpHJc7lBAhU+hnlUoRMaq4DQYtSHMDntulUmmlooAg0oVb5zs6TqiofucR0urfsfZTwG6Av1vfF47NarjLd8rCyaFKDKZFq0XLyvNlTYWW/ASjbPtqQ02WmhHwyY7EYY6TPwS6XMvy1piCsu8xUOubHQrHzhcpNlOd8dY49mMOz01Ztz+HbytyaU9evctKsk4aN/FKZuqb53XMh9a4KwlxateeL1mRfa6q4N/neNSw6Wsn6/eGZWi7/Bbtc1oc=
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get a benchmark by its ID."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/eval/benchmarks/{benchmark_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get a benchmark by its ID.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"benchmark_id","in":"path","description":"The ID of the benchmark to get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Benchmark.","content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string"},"provider_resource_id":{"type":"string"},"provider_id":{"type":"string"},"type":{"type":"string","enum":["model","shield","vector_store","dataset","scoring_function","benchmark","tool","tool_group","prompt"],"const":"benchmark","default":"benchmark","description":"The resource type, always benchmark"},"dataset_id":{"type":"string","description":"Identifier of the dataset to use for the benchmark evaluation"},"scoring_functions":{"type":"array","items":{"type":"string"},"description":"List of scoring function identifiers to apply during evaluation"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Metadata for this evaluation task"}},"additionalProperties":false,"required":["identifier","provider_id","type","dataset_id","scoring_functions","metadata"],"title":"Benchmark","description":"A benchmark resource for evaluating model performance."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/get-a-dataset-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/get-a-model-response.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

79
docs/docs/api-deprecated/get-a-paginated-list-of-rows-from-a-dataset.api.mdx Normal file
View file

@ -0,0 +1,79 @@
---
id: get-a-paginated-list-of-rows-from-a-dataset
title: "Get a paginated list of rows from a dataset."
description: "Get a paginated list of rows from a dataset."
sidebar_label: "Get a paginated list of rows from a dataset."
hide_title: true
hide_table_of_contents: true
api: eJztWV1uGzcQvsqAT4khy06QoI3e3NhNDeTHcBwURWwEo93ZXSZcckPOyhYMnaHvfeoxep5eoFcohtyV1pbi2EWAIoD9YosmOd/MfN8MSV0qT6FxNlBQk0v1eHdXfuUUMq8b1s6qidqDIyy1Rab8uJs8ViOVOctkWeZj0xidoczf+Rhk0aUKWUU1yl88b0hNlJt+pIzVSDXeNeRZJ5M58nAWeo9zNVKaqQ6bVmOeazGE5ujKPs7Sm0JN3i9X2NYYtRgtP0+dM4R2OGTbekp+OBLYa1sORxKgwUCHZHG2WIyuReqkIjA6MLgCogNQOA9cEWSt92QZGixJLUaqwvChdp4GHvb4rm/6a0VcUdzGE6AnkIXd/jhDbXBqCLDgOEkHCMRio/VmsH3n2SbI745fRqCYZRSCtmXaRjxR4uTmkBdoAo2Up8+t9pSryfuUy4FzZyPFmo2YX6PQGpI9KMmS15kEKc2FnpzAFTIUzhh3HgAh6LoxJKBr5LFaLATmk03kFf8EIgWGcwyg7QyNzsF5qNHIBpR/OzIHRm6HtNWWqSS/5uwvJydHkGZD5vLIiS5UX8vYgfdCKpk8klBUzjOEtq7Rz4V4QjeKc84rnVWgk9Neo+WUZtv9P9qJJGbUt+BKspxmi2njbEkeqrZGu+0J80jEwZorcMSStoHRZrfw8sGbJlHuIexFgiZnMrQwJWgD5cAOPLHXNOslYRMhxDJOXcvReGgo04XOwGVJhRldw3UXincZ7rO1DN6A6jFMXwjektCFd3XEsHd0OIZj15aVmS8Zfvzzc/jhx90fxhI0ukBh+5BfT3Z3V/Z+whyOE8VXeG7J/E45j59tVk5mtFStCqWoWAZ2Dmq0835j2RUQSj0jC1i71sbax7qme1Hdi+o7E9XjZyt7J87BK2F6p6wwlNZvroUKZwR0kRHlEjYRG7K0/1rzGI4MobQtPwcsUVswyOT7TvX0S50qkJ+RB7KZSIk85UKs1tJFQ5k0ROrCcC+te2l9R9J6OuxXh8JsiwbeJrav7Hfy2lunfB+MfAxvWg9MWMeuNCWyYB3rQlPeyyunAlvDG24yN2x8L6p7UX1fotrdZO0WEooqEaphGcSbfWQMxIdvBP9VvC+IAQf3sf5y6wVfRI+Qp+XjU/suUABXFIF4e4qSnW6l5OJcrq+TU7stjPf8QducLiYQu54MyLUzjsGD3bT64RgOC3jtLI3SlM7klEptrbblWHaLDXcCr+NVfnXxTrxovV1uIgff7UejbjgAGpPmjk/tqU2n5S4v2mamzSlEuOLfBF5+9Vof0fRX3wn8p2u7vKs06LEmJh/ia4bFWjLcRfmDlkKlJTcNcrXxOn+431O7WyTBKCkJYZk5MbXiNPuWRusVrn8OkeePDsggez2Szy35+RqUw5hMbdktcfRhK7QPLFA6ZGOIRDMmwdMpYVcRdjJcg9gX1yHGyImb0Umg7JIz0WyH5Y5Wo2YaT5kIpA9kTVy5XE1USbE/SKomamf2aKcLhXY7mkWW52HncpXbhRqpdAZMyY9POKpibiY7O2jn25ULTPm2MVjjdmDMPo0zVytBEShrveZ5XLjft8D3Z/I/KYoRfVcvXsp6eCvr4W1XGpNMt2F/6Y2UJalyAidFbfZoQyClt4QrVRaHdX9oKz7jNN7NdE7h1MK1HxQNyDqyeeO05QBo4+Fae8icTwLNU6lg8gVmFNKm6OnUSvFzPnaF9c2nchE2NCOPZY/qlcvJpAKwtfX3H3/+89fvsH9wdHzwfO/kYH9rawIvqcRsHiORDNU4l+bjqXYzyuX+W7TceoIuSmEM70J8moJalz6FwlNBXdOxZh4LeuMC1xgPFh1r71Jsr6fhcnV4uS/a/0PR7soC0wXvNAa1HTzAJvW/78TT6z+9cccKoEZqMqjvZyMlMpcll5cS1HfeLBYynEqZ6DvXQZCsKtQX2fBNyvBG9z7RfK0fzNC0MjM+mN8e5I3V+AbjfaFfmT2TD16L3TsG6sFxV/Ufwt266EZ8/bcHdj6E1+MeZHtxJl8HEObkI+A0YS/LqBl6tnYhEU+XbebFwYlaLP4FqUYCjg==
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get a paginated list of rows from a dataset."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/datasetio/iterrows/{dataset_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get a paginated list of rows from a dataset.
Uses offset-based pagination where:
- start_index: The starting index (0-based). If None, starts from beginning.
- limit: Number of items to return. If None or -1, returns all items.
The response includes:
- data: List of items for the current page.
- has_more: Whether there are more items available after this set.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"dataset_id","in":"path","description":"The ID of the dataset to get the rows from.","required":true,"schema":{"type":"string"}},{"name":"start_index","in":"query","description":"Index into dataset for the first row to get. Get all rows if None.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The number of rows to get.","required":false,"schema":{"type":"integer"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A PaginatedResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The list of items for the current page"},"has_more":{"type":"boolean","description":"Whether there are more items available after this set"},"url":{"type":"string","description":"The URL for accessing this list"}},"additionalProperties":false,"required":["data","has_more"],"title":"PaginatedResponse","description":"A generic paginated response that follows a simple format."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/get-all-training-jobs.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: get-all-training-jobs
title: "Get all training jobs."
description: "Get all training jobs."
sidebar_label: "Get all training jobs."
hide_title: true
hide_table_of_contents: true
api: eJztmM1uGzcQx19lwFNirCUnSJBGNzd20xQJYtjKobCNYkSOtHS45GY4K1sQ9Ay999TH6PP0BfoKxeyubFlxUgfoJYB1kSBxvn9/cqmlYcp1ipmyGS3N0709fXOULftafIpmZPbhrc9ylLKMGX30cfZLmuTj3m5gCmNTFIqipljXwVtU0+FFVvulybakCvWTLGoyI5MmF2TFFKbmVBOL76I7lM1VyIwLUxgvVOX/tr5Ik9+axruNlVnYx5lZrQqDznlNCsPRhtUUQ6bCMH1qPJMzo9MbN+eFES9B/WzVblbf5LEta8Pb17qprleFeXbXHMYlgfqlLHCJGXycY/AOEkOFYZq4Ivf/DSMLSrPZdh+FZsSm2Err5/H4CLrVYJMjs7oudXsQ26aHzImhXVwAQi4TC+SmqpAXkKYgJQG1ay5Lb0vwXdHsMQpMEwPG/vc2zkr9C/pw38jdag0dUpwRQ9lUGHeZ0OEkEGzY3EpHI/mYBaO9R5WP3tcdJ49hHz4cv+2LsRhhQtBkciAJmIQ9zQmqxAQ+6jzbyQFOUiNt8FyT9VNvIVnbMFO0tJXXt3DZT3g9revmbaDatukLzVtvHDDlVLU57B+9GcBxamZlWMA0hZAuMxz/9Ape/LD3YqBNoyus6o6MNV/P9vZu4v2IDo47xG/yuSf5vXKevrxbOTZ4igIlZsj6QVKCCuNi7Vi9AsLMzykCVqmJ0vbWV/QgqgdRfWeievryJt44JXinpPfKypvS+jU1UOKcgK4skdO2qdhQCIKvvAzgKBBmAuEF4Ax9hIBCPOj19vxLJ1UmnhMDRatSIianYDWRrmqyQq5v7oO0HqT1XUnr+eZ59UbJjhjgpKP9Jn4vr/3PkV83ww3gfcMghFV7Kk2IIsQkfurJreXlaIpNkDseyr/i+EFUD6L6vkS1d1e0e0ioVYmihrOs1Wxeq+DRq1Tp+0lK8bEWdLuA1ySAIYCs11+kSdbbbI2MFQmxumzNaiaLog0TbqgwFUmZnBmZGbWaQSnNyAznT4Z1yrK79jhUj6Yw3VGo3pamYa2pFKlHwyHGxW6ZspDbDQEr3M2C9uPApsqsztXONuxl0RoerHeC03P9TdloqVtfKtUeTtQeTnpCOnJ24eC6AJ2OZqTpdF2YP/lssuNSJZZvwYab+G/GkhIFak5z7yifRdh6IWRqn6Mpujr5KBkwts8YnsEm7vhx2n7dWniKlnLnFJnOojKQuBXH584neh8INCfG2Tqrd8lRyIOzeBZ3dv7+489//vodDg6Pjg9f7Y8PD3Z2RvCWZmgXbSe6QBUuVINMVZqT02vAtJGGCfou5QF8UML1tuFn3LWCaUq99mJYtFzr7Cts99eIFX0NsVsNX97s1l+26HcXoSsZ1gF91IgtTMuev9NulrcINIVpGTwvjHKmi5bLCWb6wGG10q8/NcSLjvN2T50oTafnq8KUhI64Ze8jLVSI1lKtvM8xNO0fNNsni4J5rY3Xh2OzWv0Lc2BthQ==
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get all training jobs."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/post-training/jobs"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get all training jobs.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListPostTrainingJobsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"job_uuid":{"type":"string"}},"additionalProperties":false,"required":["job_uuid"],"title":"PostTrainingJob"}}},"additionalProperties":false,"required":["data"],"title":"ListPostTrainingJobsResponse"}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

73
docs/docs/api-deprecated/get-chat-completion.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/get-the-artifacts-of-a-training-job.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/get-the-result-of-a-job.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: get-the-result-of-a-job
title: "Get the result of a job."
description: "Get the result of a job."
sidebar_label: "Get the result of a job."
hide_title: true
hide_table_of_contents: true
api: eJztWMFuGzcQ/ZUBT4khS06QII1ubuymARLEkJ1DYRvBiDvapcMlN0OubEHQN/TeUz+j39Mf6C8Uw11Ja1k27CCHprAvXnF3yJk37w05nCumUHkXKKjhXD3f25N/GQXNporGOzVUJwUBU6htBD+BWBBc+HFf9ZT2LpKLYoFVZY1GsRhcBDGbq6ALKlGe4qwiNVR+fEE6qp6q2FfE0TSL5uSIk2nofIzMOFM9ZSKVYdskmGVGjNAeXZvOO/o4UcPTlYWrrVWL3ur32HtL6LpDri7HxN2RENm4vDvSONQZaD1ZnC8WvS2QdcKCCfsyIUdTtHUa7KtFTwXtmR4U3d1Qpvk+s7/8XyEpURmXL0k48QyEugD2l304bJ/ABEAosRKSam/r0oHDkiB6ENApAY55zpRjpOxzM9t/HZBNPD40AZYU2ehVgOuwmliVALk9ignaQD3F9LU2TJkannZZsxWh856KJlpx7LhJxSi9UZvO7W9LFUIwLreU0qVuTTDdppKHRNItJSt1ddw/bCamUVv0bkTQ1rr0svEH3YY74tCL2+vk15pChEsMYNwUrcnAM5RoJ55Lyr5f1QwRY91lr3GRcuIbIf16cnIEzdegfUaSghaPTUpumh4ye4b0cU/yWHiOEOqyRJ4t9wJK31wWRhciQQmaDbo29659n9ZJuY9o7H1Xbr6Wpa13OTEUdYlulwkzHFuCjs01d2Ql40JEp+8R5ZOPVUOup7APn0bv22A0OhgT1IEykRiL4mhKUHomME7ymTIHOPZ1TIuHirSZGA1e65qZnKYNvx4kyybDy2ytwOvyOc26HbzrNBYf9o/e9WHk67ywM5h4a/1lgNEvb+DVT3uvkjTpCsuqYcaSXy/29tbr/YwZjBqKr/25J/Nb5Tx/vV052hpyEQoMEOQheg8lutlyYpkVEHIzJQdY+to1xxFT0qOoHkX1g4nq+ev1eifewwdhequs0JXWb76GAqcEdKWJMoFNxIaRwJrSxD4cWcJAEHkGmKNxYDESL3eql7ftVIF4SgzktEiJmDIhVu3oqiItBwlqYXiU1qO0fiBpvezuV++E2Q4tHDdsX6/fymv/JuWXYGR9+FgzRMIy7UpjIgfORzMxlC3lldEE5SR8Q2J3TfwoqkdR/Vii2tu22j0klFQiVMM8SDTSf4nr1119Sw1y60smXF4xVchYUiQOqe2WflfabHK6KJG/fDYiJiOTVBiLre3cu4Ml/CuzlMrabfSaIP1dF/3INfVuanHZv0u/3jp04ccPc+XCj8WJfDPyhzmQkKyYtLTry89LioXP1FDllAqGODNUg+mzgYQ6WIEQBvMujovBhR+HwbwJZTHgZYvfHBQa/GuWjBcxVsPBAN1st/AhUrZrLZa4GyLqL33tSyWeBdI1mzhLhgfLOnl6Lu9EOSmgllTvxR6OxR6OW/00OdmFg1WEwl2RgrjTgDp9tgVnKUDhmhSxWxy6a8UCI1TspyajcOZg4w8hUOIjuazyxsUA6NIJzDBoz426MrnwkMLLE9QUmkmR6cyJQjyn0nFz8rF0S5amxJgvvfrgM7Khf+bO3M7O33/8+c9fv8PB4dHo8M3+yeHBzs4Q3lOOepaQaBYqcSYViqn0U8qkSZrUsWaCFqXQh0+if+nFTN5cjgDThNrK5Owsqb7yIZaYdp+W1HfI8hrk8/VudpdNS95IV3FQWTRyS9YQat6S9LTJp9BU9dYil5QPNyQvXJXhlfBaup73lFBS5prPxxjoE9vFQoa/1sTCxfOeSpvTWIh3OleZCfKcrarvrbE9GbXCfArfUle2xr+8AHRyQdtc3Q2V6qkvNNusc1JuvoOzd1Web3CxTUC6qSwIM+KEavNyX2uqYsfsxllHisGqYL09PFGLxb+pbpGR
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get the result of a job."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}/result"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get the result of a job.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"benchmark_id","in":"path","description":"The ID of the benchmark to run the evaluation on.","required":true,"schema":{"type":"string"}},{"name":"job_id","in":"path","description":"The ID of the job to get the result of.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The result of the job.","content":{"application/json":{"schema":{"type":"object","properties":{"generations":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The generations from the evaluation."},"scores":{"type":"object","additionalProperties":{"type":"object","properties":{"score_rows":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The scoring result for each row. Each row is a map of column name to value."},"aggregated_results":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Map of metric name to aggregated value"}},"additionalProperties":false,"required":["score_rows","aggregated_results"],"title":"ScoringResult","description":"A scoring result for a single row."},"description":"The scores from the evaluation."}},"additionalProperties":false,"required":["generations","scores"],"title":"EvaluateResponse","description":"The response from an evaluation."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/get-the-status-of-a-job.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: get-the-status-of-a-job
title: "Get the status of a job."
description: "Get the status of a job."
sidebar_label: "Get the status of a job."
hide_title: true
hide_table_of_contents: true
api: eJztV0tu3DgQvUqBq8SQu50gQZLeeWJPJoMEMfxZDGwjKJHVEm2KVEiq7UZDZ5j9rOYYc565wFxhUJT6427bcYJsAtgbqyWR9erVe0XVTHgKtbOBghjNxPOdHf6nKEiv66idFSNxXBKEiLEJ4MYQSwKaoGmQH8OFywciE9LZSDbyYqxro2V6OrwIvMNMBFlShXwVpzWJkXD5BckoMlF7V5OPuot/4fLPWq28F6LXthDZGqQTq780BFqRjXqsycPY+QTtwuWizUSH97aNyDaVGJ0K6araUCQlMqHt59q7wlMIIhNj1CbdZtSq6a4lWkmGr8/XwbxtvCcbga5JNomUm2wlSG0mUCnNj9EcrCQ9RhMoE56+NNqTYmg9C4sszjMRdTScxu8u3yBjlyOsRNc2REYLVzqWcyzRo7zUthiItmUwL+6qNAOhEOEKA2g7QaMVOA8VmrHzVcfFjyn2Ro20jVSQ30jwt+Pjg3ke0iniAveEfE0o+96zMPjlDBBC6XyE0FQV+ulCzemdq1LLEnSXtNdoY9IU2v55itPy/hG1eWjk7m0ObZwtyEPZVGi3PaHC3BCsrLkBhyPN6/j1WE8+1Z2wnsIunBx+6JORaCEnaAIpiA48Ra9pQlA5T6At17MzMeauiSl4qEnqsZbgpEyylrSG61uE3Fd4Xq0FeSuCTjTdQd68NcHYuyph2D14P4BD1xSlmcLYGeOuAhz++hZevd55NWDS6BrZ16v6erGzs4z3Cyo47CS+xPNA5ffOef7mdudIo7kNlBgg8EV0Diq00/nGvCsgFHpCFrByjY2JW13Ro6keTfWTmer5m2W8Y+fgIyu9d1ZYtdYfroESJwR0LYkU08Zmw0hgdKXjAA4MYSCIfgpYoLZgMJKfn1Qv7/wmIT8hD2QlW4k8KRZWY+m6JhlJ9eQ+WuvRWj+VtV6unlfvWdkWDRx1al/G7+21uyn5ORlqAJ8aD5GwSqdSTmTBuvTFrOb2UjTGxsRNi9238aOpHk31c5lq57ZoD7BQcglLDYvA2exP0GyOgO+oZ24x+OF8Mq7RY0WRPC+fCYsVY8jJyrJCf9kNepo3qTGWGyTwQfd+b07/YlkqZWPXp3FnOeSS/egbyja92CuobbMFoMXM+VAoPHNGB8V65t8GIDFZe5IYl69XFEunxEgUlBoGgxmJ4eTZkFMdLkgIw9kqj+3wwuVhOOtSaXl+Tj2zI77xXOoyxno0HKKdbpcuRFLbxmCF2yGivBxIVwmGFEg2XsdpWrg3b5Cn5/yMLZMy6dX0gdfDEa+Ho944XTG2YW+RGouWPcBwOjYnz24hmDtPuOFBXO0Kq7FiiRFq7yZaUTizsPaHECiNF2RV7bSNAdCmTy/tQTrf2UppWwB3XD9GSaHbFD2dWbaG86lnbG6e85hkaEIeizmqj06RCYMze2a3tv796+///vkT9vYPDvff7h7v721tjeADFSiniYkuUIVTbk2eKjchxdPRuImNJ+hZCgM4YePzEKYL31HhaUx9S7JmmuxeuxArTMdOr+Z7/HiD8tnyGLtvTa/aSNdxWBvUlqMmQc16dZ529WR9imzpbi75aM3rLFK+3TvuPBOsRN5iNssx0Ik3bcu3vzTkWYLnmUiHUc56O50JpQNfq0W3vTOlJ4e9EZ/C9/SRW9Pub6KdspzRNPxLZOKSput9jdvLDwB7X6f5Dog97+15m4mSUJFPrHYPd6WkOq4s2/i24R6waFDv9o9F2/4PhdlmYQ==
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get the status of a job."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get the status of a job.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"benchmark_id","in":"path","description":"The ID of the benchmark to run the evaluation on.","required":true,"schema":{"type":"string"}},{"name":"job_id","in":"path","description":"The ID of the job to get the status of.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The status of the evaluation job.","content":{"application/json":{"schema":{"type":"object","properties":{"job_id":{"type":"string","description":"Unique identifier for the job"},"status":{"type":"string","enum":["completed","in_progress","failed","scheduled","cancelled"],"description":"Current execution status of the job"}},"additionalProperties":false,"required":["job_id","status"],"title":"Job","description":"A job execution instance with status tracking."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/get-the-status-of-a-training-job.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

23
docs/docs/api-deprecated/inference.tag.mdx Normal file
View file

@ -0,0 +1,23 @@
---
id: inference
title: "Inference"
description: "Inference"
custom_edit_url: null
---
Llama Stack Inference API for generating completions, chat completions, and embeddings.
This API provides the raw interface to the underlying models. Two 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.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

72
docs/docs/api-deprecated/list-all-agents.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: list-all-agents
title: "List all agents."
description: "List all agents."
sidebar_label: "List all agents."
hide_title: true
hide_table_of_contents: true
api: eJztWMFuGzcQ/ZUBT60hy06QoI1uauy2ARzEcBwUhW0EI+7sLhMuuRlyFQuGvqH3nvoZ/Z7+QH+hGHIlrS0lcYBeAtgXW+vhzJvH90jN3iim0HoXKKjJjXp8eCi/CgqaTRuNd2qipnCKlXEYqTjrg8dqpLR3kVyUeGxbazRK/MG7IItuVNA1NSh/xUVLaqL87B3pqEaqZd8SR5NLFhiHUciMCzVSJlITdq3GojBSCO3prTze0atSTS7WK1xnrVqO1p9n3ltCN3zkumZGPHwSIhtXDZ9kQIMHPZLl1XI5usPUeU1gTYjgS0gNQOkZYk2gO2ZyEVqsSC1HqsbwtvFMgw5X+O4m/a2mWFNKwwTIBLKwz49zNBZnlgDLmIJMgEBRanRsB+n7znZBfnN2koCi1hSCcVVOI50oaXI35SXaQCPF9KEzTIWaXOS9HDR3NVLRRCvltyS0hWQKFTlio4WkHAsrcUKsMULprfUfAyAE07SWBHSDcayWS4H5ZJd4pT+BSCHCRwxg3BytKcAzNGglARX/n5hDxNgNZWtcpIp4q9lfz89PIUeD9kXSRE/Vl3bsmFlEJcEjoaL2HCF0TYO8EOGJ3CjFfKyNrsHkptmgi3mbXf//VCeJOKK5h1Zy5Rwtpa13FTHUXYNunwmLJMTBmltwpJJxIaLT9+jyu1dtltz3ME0Czc1odDAj6AIVED0wRTY0X1nCZUFIZZz5LqbioSVtSqPB6+xCTXdwfY3E+x1e7daavIHUE02fIG8t6JJ9kzBMT1+M4cx3VW0Xa4Wf/fwcfvjx8IexkEbXKGof6uvJ4eGm3k9YwFmW+AbPPZXfO+fxs93O0dbIqVWjHCouQvQeGnSLVWLJCgiVmZMDbHzn0tkXTUMPpnow1TdmqsfPNvXOvYeXovTeWWFord99BzXOCehaExVCm5gNo1z/jYljOLWEcm3xArBC48BiJF7dVE8/dVMF4jkxkNNiJWIqRFido+uWtFyI1NPwYK0Ha31D1no6vK9eiLIdWnid1b6p39trui35FRnFGF51DJGwSbfSjMiB89GUhoqVvQoqsbNxxyTzmcQPpnow1bdlqsNd1e5hoeQSkRpWQbqZVuRiEPC3wZ7IJIvWAqYAmflbZGwoEoc0aTts8u4hx7fGFXQtk7us/dARL3YOmylMti2tSt33857smDAihTZs9/RvmW9lqqWM5j2QdPl+GUIe+2X/c2e9iDp2X1s6cdYyaZlW1SRyRyPVUKx9oSaqonQ4YKzVRB3MHx3kcmqk8j2fSUxjuqpjbCcHB+gW+7UPkYp9a7HB/RBRvx9r3ygpFkh3bOIiLTxaHXMXV/I/EX4C2WviRNbDa1kPr3v5Z5L34WgNWqQniAROZmj+aAdpcn6EW07CobeHtdKo3rKfm4LCpYM7PyivJ2QduaL1RuhHl75AGQbtOZujkLcQwjOXqCnkpMh06UTgnpPzt5PPZNixNCfGaoXqpS/IhvGlu3R7e//8+de/f/8BR8enZ8fPp+fHR3t7EzihCvUiMZELNbiQA4ap8XMqZMYpu9gxQc9SGMObkF4/QGMqzlQwldQfLM4ukmlbH2KD6fLoFbrDU7eovtlcQrtiewFGuo4HrUXjBu95ss4u8v7h2tOiJnl8czPDQG/YLpfyOLtDZFSYIEf2Ru+fBHR/++7E+Z4WW4fFHG0nkekF29ch+byLP4NgdUpsal/JBzZSPLlppGrCgjjxkxdNtaZ2uGrrG4JkWVv/l+NztVz+ByRJdLg=
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"List all agents."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/agents"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List all agents.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"start_index","in":"query","description":"The index to start the pagination from.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The number of agents to return.","required":false,"schema":{"type":"integer"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A PaginatedResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The list of items for the current page"},"has_more":{"type":"boolean","description":"Whether there are more items available after this set"},"url":{"type":"string","description":"The URL for accessing this list"}},"additionalProperties":false,"required":["data","has_more"],"title":"PaginatedResponse","description":"A generic paginated response that follows a simple format."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/list-all-benchmarks.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: list-all-benchmarks
title: "List all benchmarks."
description: "List all benchmarks."
sidebar_label: "List all benchmarks."
hide_title: true
hide_table_of_contents: true
api: eJztmM1uGzcQx19lwFNrrGUnSNBGNyd22wAJYjjOobANY8Sd1TLmkpshV/FC0DP03lMfo8/TF+grFMNdSStZThyglwD2RTLF4Xzw959dcq6YQu1doKDGc/X08FA+cgqaTR2Nd2qsjuCNCfElOV1WyDfhrLcYqUxp7yK5KEZY19ZoFKODj0Es5yrokiqUb7GtSY2Vn3wkHVWmavY1cTSd3xzjcBYyY6syZSJV4evWJicXTWGIB3NDZOOmapEmz0xOfM0UfMOark3+5Yn3/N4NbP+QKXJNpcYXqvI5WZWpUBqyucrUjHT0fB2iZ1JZyjKQxB+0F9vronE6VTlTk2V9Vaai97b/uJ6yb+ou5aqO6irVPEQ13rDIqcDG3h0d7uN5SbAsAUgOGaD9jG2Atc1iFeXOImwv+XpVefAFxJKgt4booQkEhec0vPIANEPbJErE2XYhwgMoWG/IZjBCqYTRrwnLNWHNR5C4BNQW8iZN2gynoohbLK6Ywzw3Mg/t6QZ93tG7Qo0vVhausVYtstX/E+8toRsOuaaaEA9HVkltpT8Y6CNZXN3J/G0fdl9uEwZpQcRwoxaL+xIo0AbKFNOnxjDlwvFAT5ui6CWwwciuPRwU8ipT0UQr8b+8l8yjAR8rQiWXZRpuCklcUBMXnit0mkZq8U1ZbYezu6nJootMPdvVCDsBfWooRPiMAYyboTU5eIYKrcRF+f/XE0PE2Ay5Ny7SNO3JZli/nZ+fQjcbtM8ptaouya/p94RZiJHJGSCE0nOE0FQVcrtUNKU5n0ujSzBd0mzQxbRB6Prfk58EZkRjH+q5my2urXdTYiibCt0+E+Y4sQQDm41wxJNxIQoHX/f1w7u6I+RHOIIPZ2/6ZDQ6mJC0qVzaAlNkQzOCyjOBcYmz5BknvonJeahJm8Jo8Fo3zOQ0bcX1LUT2O7zcrVXxBpCmMt1TvOWTGwr2VYrh6PT1CM58My1tC4W31n8OcPbLK/jp58OfRlI0usWq7shY8vXs8HCgUczhrEN8Hc8Dye+V8/TFbuVoa8hFKDFAkC/Re6jQtcuFZVVAmJoZOcDKNy5182gqehTVo6i+M1E9fbH2d+49vBXSe2WFobR+9w2UOCOgW02US9lEbBgJrKlMHMGpJQwEkVvAKRoHFiPxqNfb8/ueVIF4RgzktEiJmHIBq3F0W5OOlPfFfZTWo7S+K2k9Hz6vXgvZDi2872hf++/ldXQX+WUx8hG8axgiYZWeShMiB86nN998Ka/VwerOqfgLCz+K6lFU35eoDnd5e4CEkkoENZwGyWZ9oJIEdpzP0dr1YS/IFVKNjBVFYlkgGdVMGqOUJ3JD6TBZ+lyN1TRdntQYSzVWB7MnB3I+PFgvJ4fR1AdCOo83LOGXMdbjgwN07X7pQ6R831qscD9E1Dcj7Su1uBI73bCJbTI8Xor+4kp+EwwSYMuTo9jDe7GH9z0MHST7cLyKXjYipEsgDl0BZk923MmImsIGVzgkfegrlhihP4+HSwdbfwhy8eILIJfX3rgYAF16nTAM2nOHSi6HaekiXKCm0C2KTJdOtttz0sHdxSfy6m9pRozTZVRv5UgeRpfu0u3t/fPnX//+/Qccn5yenbw6Oj853tsbwxuaom5TJTpHFbYiN6bKzyiXN/6iiQ0T9FUKI/jQXxtVZspdKZgK6mXmbJsQrn2IFaZW6rCi++naKPd83Zbvm983kUi38aC2aNK1UAJp3oN30e2joDe8tkvAC2AyYz6fYKAPbBcLGf7UELcd3alvTgSjC7nHKQlzuba8mKsbakVsWlMtlMvNR7oG2n56CJErRfx6cq4Wi/8AmjuiAw==
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"List all benchmarks."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/eval/benchmarks"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List all benchmarks.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListBenchmarksResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"provider_resource_id":{"type":"string"},"provider_id":{"type":"string"},"type":{"type":"string","enum":["model","shield","vector_store","dataset","scoring_function","benchmark","tool","tool_group","prompt"],"const":"benchmark","default":"benchmark","description":"The resource type, always benchmark"},"dataset_id":{"type":"string","description":"Identifier of the dataset to use for the benchmark evaluation"},"scoring_functions":{"type":"array","items":{"type":"string"},"description":"List of scoring function identifiers to apply during evaluation"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Metadata for this evaluation task"}},"additionalProperties":false,"required":["identifier","provider_id","type","dataset_id","scoring_functions","metadata"],"title":"Benchmark","description":"A benchmark resource for evaluating model performance."}}},"additionalProperties":false,"required":["data"],"title":"ListBenchmarksResponse"}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/list-all-datasets.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/list-all-responses.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/list-all-session-s-of-a-given-agent.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: list-all-session-s-of-a-given-agent
title: "List all session(s) of a given agent."
description: "List all session(s) of a given agent."
sidebar_label: "List all session(s) of a given agent."
hide_title: true
hide_table_of_contents: true
api: eJztWMFuGzcQ/ZUBT4khS06QoI1uauy2ARzEUBwUhW0Eo93RLhMuuRlyFQuCvqH3nvoZ/Z7+QH+hGHJXWltKYgO9BLAvtnfJmTcz7w13uFJMvnbWk1fjlXp6dCS/cvIZ6zpoZ9VYTeAMC20xUD5tFw/VQGXOBrJB1mNdG52hrB998LJppXxWUoXyV1jWpMbKzT5QFtRA1exq4qCTyxxDfxUy41INlA5U+X27Mc+1OEJzdsOOs/RmrsYXmx22MUatB5v/Z84ZQtt/ZJtqRtx/4gNrW/SfJEC9By2S9dV6PbiVqfOSwGgfwM0hBgBzxxBKgqxhJhugxoLUeqBK9O8rx9SLsMN32+hvJYWSohkmQCaQja19XKA2ODMEOA9xkfbgKYiPhk3PfBvZPsjvpqcRKGYZea9tkcxIJEqC3J/yORpPA8X0qdFMuRpfpFr2grsaqKCDEfc7FNpBMoGCLLHOJElpLXTkhFBigLkzxn32gOB1VRsS0BWGoVqvBeazfeSV+AQi+QCf0YO2CzQ6B8dQoREDlP9/ZPYBQ9OnrbaBCuKdYH89Pz+DtBoyl0dOtKn6VsVOmIVUsnggqSgdB/BNVSEvhXhCN4prPpc6K0GnoFmjDanMtn0f/UQSB9R34ErynFaLa+NsQQxlU6E9ZMI8ErG35wYc8aStD2izO0T56E2dKPcYJpGgKZgMLcwIGk85BAdMgTUtOknYRAjxjDPXhOjc15Tpuc7AZUmFGd3CdR+KtxXuqrVJXo/qMU1fSN6G0HN2VcQwOXs1hKlritIsNwyf/vwSfvjx6IehJI2uUdje59ezo6Otv58wh2mi+BbPHZnfKufpi/3KyYyWrlWiNBUbIDgHFdplZ1isAkKhF2QBK9fY2PuCruhBVA+i+s5E9fTF1t+5c/BamN4qy/el9btroMQFAV1nRLmkTcSGQY7/SochnBlCObZ4CVigtmAwEHcn1fMvnVSeeEEMZDOREjHlQqzG0nVNmRyI1KbhQVoP0vqOpPW8f169EmZbNPA2sX3rv5XXZJfyXTLyIbxpGAJhFU+lGZEF64Kea8o7eeU0x8aEPZPMVww/iOpBVN+XqI72ebuDhKJKhGpYeIlmUpANXsDfBHsqkywaA16mQmcf+ceSs83nnmyTi4AaGSsKxD6O3xarODfL6/dadKXFWo2h3Dt9vjruKhG3SEXjDN16jTO0uNkWIHBDg105drO7zOotCB+Qw3ttc7rucHxqiJd7gcRl4j7uiojaSVS4JLW6CaMlxg6OTu59IPGz4NsQ0oWE5GMTfSJ4w/a+zmM9a6ZMJukuaRWF0uVqrAqKjUuKMlajxZNRTL4frbq6rUcdBDVQ6bsk1TdeK6gyhHo8GqFdHpbOB8oPjcEKD33A7OMwc5USAJ6yhnVYxo3HXVu+uJJ3ItQIvOXwqeyHt7If3rZyTak/hONNICIVQSRwUt4WT/akUvqdv6F87Peivq94tVCzW+ic/KWFWz8o1ymyj2xeO22DB7Txg08zZI6TmHO5NZHc8xwz8skoMl1aEaTj2Kl2jc9kODO0IMaiQ/Xa5WT88NJe2oODf/7869+//4Djk7PpycvJ+cnxwcEYTqnAbBkzkRxVuJSGyFS5BeUyk82b0DBBmyU/hHc+XpdApQtOqWCaU9sIrVnGJlM7HyqMh13L27v2gBv5X21P0jsbaOkb6DqMaoPa9m6wEksvUqUTT9VAjXsdZkPVq4ESOsrq1WqGnt6xWa/lcRKd8DDXXs6orYi+CP7uXWEv/I+03OlBCzSNrIw3ivdD8q3m8BUMXfvZer+Sf1iL+3sm5dG0bUKP4T7tey+67o7VLvvgOtSbAq+v5MqUMCeOYNPrSZZR3Y9q56NNotx0vF9OztV6/R+4sv74
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"List all session(s) of a given agent."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/agents/{agent_id}/sessions"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List all session(s) of a given agent.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to list sessions for.","required":true,"schema":{"type":"string"}},{"name":"start_index","in":"query","description":"The index to start the pagination from.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The number of sessions to return.","required":false,"schema":{"type":"integer"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A PaginatedResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The list of items for the current page"},"has_more":{"type":"boolean","description":"Whether there are more items available after this set"},"url":{"type":"string","description":"The URL for accessing this list"}},"additionalProperties":false,"required":["data","has_more"],"title":"PaginatedResponse","description":"A generic paginated response that follows a simple format."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/list-chat-completions.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/list-files-in-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

73
docs/docs/api-deprecated/list-files.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/list-input-items.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/list-models-using-the-open-ai-api.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: list-models-using-the-open-ai-api
title: "List models using the OpenAI API."
description: "List models using the OpenAI API."
sidebar_label: "List models using the OpenAI API."
hide_title: true
hide_table_of_contents: true
api: eJztWMFu20YQ/ZXBnlqDlp0gQRLd3NhtAziI4SiHwjaK0XIkbkLuMrND2YSgb+i9p35Gv6c/0F8oZpeyZctpHaCXANZFFLkz82bmvV2OloYptsFHima8NE/39/WrpGjZteKCN2NzAO9a8gdvjl2Ut6GkOp4ONiNTGBu8kBc1w7atnUU12/sY1XZpoq2oQb2SviUzNmH6kayYwrQcWmJxOXKJsrkKmbE3hXFCTfxva1durInCzs/Nqliv3nqUUEcxY9NoPqYwJc2wq2/urApjmVBo07HzQnPi5PnSU/nrtL8n7KowWJZOq4D1yQbMGdaRCsP0uXOsjs8Ud3GT0zrihvuLwoiTWv3nJry9Bny7RQk2zDg0Q7dGZvVVUFIDtsJt91zdrgrz7D6mTCoC9UlR4BIjOL/A2pUQGBqsZ4GblN3/RJkoKF28pz93q/PzZHICeTXYUJI2cEhzmxm3TY+YA0NaXABCrAILxK5pkHsIM5CKgNKay8rZClxOmh16gVlgQD88T3FW6l/Q1Q+NnFdr6Dr4OTFUXYN+lwlLnNYEGza34Ggk56Ogtw/I8rt3bebI93AAH06Ph2QsepgSdJFKkABMwo4WBE1gAue1n6lzgNPQSQoeW7Ju5iwEaztm8pbu4PoaTg4dXnfrungbNE1l+kLx1ltbloViODh5M4LT0M2ruodZqOtwGeH0x9fw4uX+i5EWja6waTMz1vx6tr9/E+8HLOE0U/wGzwOZPyjn6av7lWNrR16gwghRLyQEaND3a8fqFRDmbkEesAmdl1Rb19CjqB5F9Y2J6umrm3iTEOCtMn1QVtyU1i+hgwoXBHRliUotm4oNhaB2jZMRnNSEkUC4B5yj81CjEI8GvT3/0kkViRfEQN6qlIipVGJ1nq5askLlUNxHaT1K65uS1vPN8+qNMttjDe8z22/iD/I62Kb8uhjlCN51DELYpFNpSuTBB3EzR+VaXtdvzltjw784fhTVo6i+LVHt3xftARJKKlGq4TxqNnmYUvC3weqglYe4CF10fp6g5iEsIVbmI2NDQqyekoeWyeYhVbijwjQkVSjN2MwpSQWlMmOzt3iyF1ry6PQqBzGFyeef+lqajjWRSqQd7+2h73erEIXK3brGBnejoP00sqExqwu1sx076ZPh4Vr+Zxf6TAmRqDbU6ljt4b3aw/uBFpkuu3B4DV8TVEQKJ5dj8WSrnZNKdRVvMQw3Ob8ZSyoUaDksXEnx3MOdD0Kk9PJMvmyD8xIBfXqxcAw2cCZNqW3Q/YRnaClmp8h07rXxgZMitp1PdQioaUGM8zWq3PbRuT/3Ozt//f7H33/+BodHJ6dHrw8mR4c7O2M4pjnaPlUiB2qwV+ExNWFBpb77zzrpmGCoUhzBB6W1jhhuzrkUTDMaBOfrPpG5DVEaTJuqx4YeyLVbtV/e7NYPMh42GqEr2WtrdF5xJIotB06e5Q5nVmrn9VdzrQ1lny5aLqcY6QPXq5Xe/twR95n7aXudKsfOLlaFqQhL4sTIT9SrJq2lVjWwwLpL/yjdPWSUrtd6+eloYlarfwA9haIZ
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"List models using the OpenAI API."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/openai/v1/models"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List models using the OpenAI API.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A OpenAIListModelsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"model","default":"model"},"created":{"type":"integer"},"owned_by":{"type":"string"}},"additionalProperties":false,"required":["id","object","created","owned_by"],"title":"OpenAIModel","description":"A model from OpenAI."}}},"additionalProperties":false,"required":["data"],"title":"OpenAIListModelsResponse"}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

44
docs/docs/api-deprecated/llama-stack-specification-deprecated-apis.info.mdx Normal file
View file

@ -0,0 +1,44 @@
---
id: llama-stack-specification-deprecated-apis
title: "Llama Stack Specification - Deprecated APIs"
description: "This is the specification of the Llama Stack that provides"
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---
import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";
<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: v1"}
>
</span>
<Export
url={"https://raw.githubusercontent.com/meta-llama/llama-stack/main/docs/static/deprecated-llama-stack-spec.yaml"}
proxy={undefined}
>
</Export>
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Llama Stack Specification - Deprecated APIs"}
>
</Heading>
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.

19
docs/docs/api-deprecated/models.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: models
title: "Models"
description: "Models"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

19
docs/docs/api-deprecated/post-training-coming-soon.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: post-training-coming-soon
title: "PostTraining (Coming Soon)"
description: "PostTraining (Coming Soon)"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

72
docs/docs/api-deprecated/register-a-benchmark.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: register-a-benchmark
title: "Register a benchmark."
description: "Register a benchmark."
sidebar_label: "Register a benchmark."
hide_title: true
hide_table_of_contents: true
api: eJztWM1u20YQfpXBnlpDlp0gQRrdnNhFgyawIduHwjaC0XIobrLcZWaXsgVBz9B7T32MPk9foK9QzJKUKFt23aaXANbBppY7PzvzffORWiimUHkXKKjRQj3f35d/GQXNporGOzVSxz+r5UC92HbrrCBg+lJTiHCNAYyboTUZeIYSbe65pEwNlPYukotij1VljUax3/sUxMlCBV1QiXIV5xWpkfKTT6SjGqiKfUUcTZNdiBjr0NtnXKQpsRrcSuuns7MTaHaD9hlJ/tFESz3bENm46R3TI2bPkDYPACEUniOEuiyR5+BziAUBpT3XhdEFmObQbNBFyD0DuvZ+irMU/xGNfWzkZreEtt5NiaGoS3S7TJjhxBL0bDbSkUjGhYhOP+KU3x2nK7TfwwGcj9+3h9HoYEJQB8ogemCKbGhGUHomME76mToHOPF1TMFDRdrkRoPXumYmp+lWXsuBwiwzTbyTXkNztIEGSvBjmDI1uug63HVrVbyrVf+aMt1TvA7LkLMvUw4HJ++GMPb1tLBzyL21/jrA+Me38OqH/VdDKRrdYFk1yOjw9WJ/fx3vDWYwbiC+zueRyF8u5fQvnr/ezhxtDbkIBQYIchG9hxLdvHMsXgFhambkAEtfu5hqa0p6ItUTqb4xUj1/vY535j18EKS3zAp9av3iayhwRkA3miiTsgnZMBJYU5o4hBNLGAgizwGnaBxYjMTDlm8v71OqQDwjBnJaqERMmQCrdnRTkY6UtcV9otYTtb4par3s69U7QbZDC6cN2tfxW3od3IV8V4xsCMc1QyQskypNiBw4H01uKOvolVGOtY13KfaQ4ydSPZHq2yLV/rZoj6BQYolADadBTvOGnC5K5M9BDrCZ8JimJkRiQJh024aCeGQsKRKLh6umOhTiG5/NJcX/iUmrkB9N9s9oEQF9d9i1dWXbQKQ5RiplhhEDxf/gs7UUj7W0T+jTD5XcB+3F1ce8dlq89CcBMuNcDZSJVIa70Zfbwrf+YOXv4fAV+5nJiD9+TfE6J5tVfETQrwj1YICSIkr1t2FmO20Xyjs6ztXoYmXhamvVcrD6PvHeErr+kqvLCXF/ZdWaW03sLbSZLK+29q9L/aED/pvhs9HXDTRvw15vJHVcXvG9e2lM02AdInJN6SQVk8bYLaUmFD5TI1X59KpZYSzUSO3Nnu3RDO3eZD1IBqp5lA2p/jXLTCpirEZ7e+jmu4UPkbJda7HE3RBRfx5qX6rlldjpmk2cJ8PDTskvruSezI/xetIcrWfiJth7yOtxfb26haIX3d2reym0tt+A+3q5B9Jl0rncJ7y29X8vp4VTOS2ctnrU6NQuHK6KLVog9ZPiNSCaPdtCIRH0sCFt2BfbfqxYYOxoFi4d3PogyEjzOZDLKm9cDIAuvdEYBu25UatMRpA8yHCOmkLjFJkunSiO5yTFd51P5NcHSzNinHZZffAZ2TC8dJduZ+fP337/649f4fDoZHz09uDs6HBnZwTvaYp6nirRBCpxLorPVPoZZfKjQ17HmgnaKoUhnLfUKs2Um1Iw5dQqvbPzZk75EEtMGuSwpAcEbqPePUG716CdBZFu4l5l0chYaYC/aIly0XRSqKIGarKhukII2bFYTDDQOdvlUpa/1MTzRmHTw9tEgHQhc6YgzIgTST7TXI3U2ybD3TPJQ7bbOg2r2/Irc6uxONCaqvjg3qse6U+OT88k71biS3lgHSnGazVIf0dKDZSvVpKX1hbKopvWOJW9jU/5/A1qqKOz
sidebar_class_name: "post api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Register a benchmark."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/eval/benchmarks"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Register a benchmark.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"benchmark_id":{"type":"string","description":"The ID of the benchmark to register."},"dataset_id":{"type":"string","description":"The ID of the dataset to use for the benchmark."},"scoring_functions":{"type":"array","items":{"type":"string"},"description":"The scoring functions to use for the benchmark."},"provider_benchmark_id":{"type":"string","description":"The ID of the provider benchmark to use for the benchmark."},"provider_id":{"type":"string","description":"The ID of the provider to use for the benchmark."},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The metadata to use for the benchmark."}},"additionalProperties":false,"required":["benchmark_id","dataset_id","scoring_functions"],"title":"RegisterBenchmarkRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/register-a-new-dataset.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

73
docs/docs/api-deprecated/resume-an-agent-turn-with-executed-tool-call-responses.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/retrieve-a-vector-store-file-batch.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/retrieve-an-agent-session-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/retrieve-an-agent-step-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/retrieve-an-agent-turn-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

73
docs/docs/api-deprecated/retrieve-file-content.api.mdx Normal file
View file

@ -0,0 +1,73 @@
---
id: retrieve-file-content
title: "Retrieve file content."
description: "Retrieve file content."
sidebar_label: "Retrieve file content."
hide_title: true
hide_table_of_contents: true
api: eJztV8FuGzcQ/ZUBT4mxlpwgQRLd3NhpAySIoTiHwjaKETnSMuGSmyFXtiDsN/TeUz+j39Mf6C8Uw921FMsuXLSXAPbF1JKcefP4Hmd3rZhiHXykqCZr9fTgQP4ZipptnWzwaqJOSwLGS5hbR6CDT+QTYASEmfXIKxhCjFSh+nmJgnXtrEaJMv4cJdRaRV1ShTJKq5rURIXZZ9JJFSrZ5OTBtA+m2rZtC/XsTkT0taGY4BIjWL9EZw0EhgrdPHBF5r9gqTnUxMl2pMSEqYlb66xPtCBWxQ1YP52enkC3GnQwpNrrsq73xsTWL3a2HjMHhry4AIRYBk4Qm6oSfsMcUklAec1laXUJtiuaLfoE88CAvp/PeVqJn9C6+2buVktqF/yCGMqmQr/PhAZnjmBrzzdwJJP1MaHX96jy0Yc8QvcYDuHT9F1fjEYPM4ImkoEUgCmxpSVBFZjAejnPfHKAs9CknDzWpO3caghaN8zkNd3A1RYKjbFdvpOtA52ji1Qo0Y9lMmpyNpzwcFrX5F1sZJlpuoO8Qf8w51BlDIcnb0cwDc2idCuYB+fCZYTpm9fw4uXBi5GQRldY1Z0yBn09OzjY5PsBDUw7iW/w3FP5vXOevrrdOdpZcXCJEaIMUghQoV8NgSUqICzskjxgFRqfMre2ogdTPZjqOzPV01ebfKchwHtReu+suG2tn0MDJS4J6EoTGaEtN75E4Gxl0whOHGEkSLwCXKD14DARj3q/Pb+rU0XiJTGQ12IlYjIirMbTVU06kenJfbDWg7W+K2s93+5Xb0XZHh187NS+yd/b63BX8gMZZgQfGoZEWOWuNCPy4EOyc0tmsJehOTYu7VrsnwI/mOrBVN+XqQ5uy3YPC2WXiNRwEaWaN9ZRFOzfYp0OtG5/zI3O/ZRSwz5m3P3TOHDZ00wmb5KPvBoZK0rEkmqtPFaCV2Z/seI5K6lqTOUOV9IP3x4NkTOIFOTQs35TaePwFip5NseTuKFi16y9xNo2F1ozaUyb5RWlMhg1UQvKhhZAEzVePhmHmjxaGQmEOF732NvxcF0UqmvbXYUNC/9lSvVkPEa/2i9DTGT2ncMK92NC/WWkQ6UERyTdsE2rvPFouLXOLmROdJzh90f8TvbDR9kPH3s1dyrfh6PrekRJIkyB09G4fHILs3IdxG+MgdtW3c6VSkxQc1haQ/Hcw40/hEj5nZ+8qYMVLaDP70OWQQfutG6sX4BcgzxHTbELikznXvQaOBt5N/hMvl0cLYlxMaB6Hwy5ODr3535v78/ffv/rj1/h6Phkevz68PT4aG9vAu9ogXqVmegSVbiS+4KpCksy8skyb1LDBD1LcQSfellVdsEdFUxz6u8J71bZg3WIqcLcC3od3+6Rm4SvN53lf3JVr+lEV2lcO7Re4GXlrXvtnnUH36lXBCG/soJVoSYb/w3ILgolQpWN6/UMI31i17by+GtDLAq9KFRuIDOR49laGRtlbK5vyDtrfjTtzfkY/p2pby2zf4h+JWWha+SXKtQXWm3dLO1FW6iS0BBntN3sodZUp619O31erHd9Gfx4fKra9m8/Lp3n
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Retrieve file content."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/openai/v1/files/{file_id}/content"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Retrieve file content.
Returns the contents of the specified file.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"file_id","in":"path","description":"The ID of the file to use for this request.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The raw file content as a binary response.","content":{"application/json":{"schema":{"type":"object","title":"Response"}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

73
docs/docs/api-deprecated/retrieve-file.api.mdx Normal file
View file

@ -0,0 +1,73 @@
---
id: retrieve-file
title: "Retrieve file."
description: "Retrieve file."
sidebar_label: "Retrieve file."
hide_title: true
hide_table_of_contents: true
api: eJztWM1uGzcQfpUBT4mxlpwgQRrd1NhpDSSwodiHwjKCETnSMuGSG5IrWxH2GXrvqY/R5+kL9BWK4e7qx5JRB20PAeyLV7uz83E+ft9wyaXwFEpnAwUxWIrnR0f8T1GQXpdROysGYmjhrCQ7PH2rDZ1NPpGMIJ2NqK22M5hqQ6Dt1PkC+Y2eyAQ/Jhs5F5al0TI96X8KnHApgsypQL6Ki5LEQLiUVWSi9K4kH3UznPb2Oi5Er+2sAQhRDASDi0wommJltm5sVnCREzS5gBNlcJNrmYMOgOYGFwHG6b2xEHUmtNoHuJuwqVuRjXqqyXdJJVqYEHiakicrSYG2EHOC4fkpkFWl0zYGBposYlNmi6VtpBn5vWBBfyVw05SIgTPO2iSoMyE9YST1EeMD011afQtRFxQiFiU80RYCSWdVeApT5+EmJ7vCghsM0EIwGt2W2lP4v9Da9IzEvy0W9LAJ4chNjjhDWfnShb0JyFaFGFwJDEGHiDwpmZhglLm43peeK7SKFLQ5t6HqTKBSmuPRnG+oeIomUCY8fam0J8WIK7VrJToZbE3iFscbNKzruc5E1NFwQXe9ucNNEwAc0bkAAyiaartW50ZQYKn2RF1zUS/2dQSmgwuiEJM4tJ2j0QqchwINdwJS/10XCBFj9RCj/HxxcQ5NNEinkgBalv5JPyfeOw8pOAOEkDsfIVRFgX7RTTSlmFXr4KK9RhuThtG2zxNOzfkjavNQ5CaaoY2zM/KQVwXaQ0+ocGIINt7ZGk5qWJblKx9Q5ZOzshHoUxjC5ejddsuqAimIDjxFr2lOUDi/1dkBJ66KCTyUJPVUS3BSVj41ujvj+hZDtDPczdaKvA2VJ5ruIa9bwmDqXdH12h6MXDXLzQKmzhh3E2D09g28+uHoVa9pYliUjTI6fb04Olrj/YgKRo3E1+N5oPJb5zx/vd850miyEXIMEPgiOgcF2kWXmLMCwkzPyQIWrrIxcatTB3g01aOpvidTPX+9xrtwDt6z0ltnhU1r/eIqyHHOHwCSiBdaBvUYCYwudOzBuSEMBNEvAGeoLRiM5LuV6uV9K1UgPycPZCVbiTwpFlZl6bYkGUm15D5a69Fa35W1Xm6uV6esbIsGPjRqX+O39hruSr4jQ/XgrPIQCYu0Kk2ILFiX9jWqs9dqi7Vne3hv4kdTPZrq+zLV0T60B1gouYSlhrPA1aSN1O5GctTRynu63tiOKFbehj0E45reFMuOQI8FRfKMsBTNzjjtDj+mnaRmhBJjvnd7fHq8uWPlOa6YLVZrrkP38ck461mJvqJs16Otsuo61Vd6kulsoA0vKOZOiYGYUfIxD2gg+vNnfVeSRc1XPITQX7Zjr0UmmlW6qazyTHceYzno99EuDnMXIqlDY7DAwxBRfu5JVwjGDyQrr+MivXjcNamra37GrKZhtzP6jt+HD/w+fGjZbTg/hONVHSwc1iEPp6Fv/mwPo+z+sOUD3HTmJlbMMULp3VwrCmMLd/4QAqVP/NXxEKBNnz/ag3S+kbbiwzbuen6KkkKTFD2N+STOOJ98u5t8wlsVQ3PyOOtG9d4pMqE3tmN7cPDnb7//9cevcHxyPjp5M7w4OT44GMA7mqFcJCYaoAIXzbFW4ebNqcG0ipUnaFkKPbhs5VTomW+oWB2CgbNmkSxXuhALTK2/1e+2Je4SvVwvIP/OPK10I93GfmlQWx5NEtqylehVM8+NSHn+n7VnLyyGQWez60ywGjl8uZxgoEtv6ppvf6nIswyvM5EWhQlr7moplA58rVZd794Cn4xa5z2Fb3Ps3uLam2gXXAyain+JTHymxUbbqK/rTOSEinwabfN0KCWVceO9nbWb/bVy+k8nF6Ku/wYZzsO3
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Retrieve file."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/openai/v1/files/{file_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Retrieve file.
Returns information about a specific file.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"file_id","in":"path","description":"The ID of the file to use for this request.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An OpenAIFileObject containing file information.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"file","default":"file","description":"The object type, which is always \"file\""},"id":{"type":"string","description":"The file identifier, which can be referenced in the API endpoints"},"bytes":{"type":"integer","description":"The size of the file, in bytes"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the file was created"},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the file expires"},"filename":{"type":"string","description":"The name of the file"},"purpose":{"type":"string","enum":["assistants","batch"],"description":"The intended purpose of the file"}},"additionalProperties":false,"required":["object","id","bytes","created_at","expires_at","filename","purpose"],"title":"OpenAIFileObject","description":"OpenAI File object as defined in the OpenAI Files API."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/retrieves-a-vector-store-file.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/retrieves-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/retrieves-the-contents-of-a-vector-store-file.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: retrieves-the-contents-of-a-vector-store-file
title: "Retrieves the contents of a vector store file."
description: "Retrieves the contents of a vector store file."
sidebar_label: "Retrieves the contents of a vector store file."
hide_title: true
hide_table_of_contents: true
api: eJztWE1uGzcUvsoDV4khS06QII12buy0RpPa8E+BwjaCJ86ThgmHnDxyZAuCztB9Vz1Gz9ML9ArF48xYI0tubCSbAPbGoyH5fr/v45BzxRRK7wIFNZyr5zs78i+joNmU0XinhmoXrAkR/BgOXCS2hFPK3ngXyUVgKpkCuWjcBGJOMDaWQNejoa96qnkWu1iW1mgUu4OPQYzPVdA5FShPcVaSGio/+kg6qp4q2ZfE0dShid0PJutMDJGNm6jerXDPnPlcEZhMghobYhh7vglNLXrJlMOCvmzrVyxIEu+uxhjZjKpYh3U7aMwyI4vRHq2E7x0djtXw/GaFq6xVi97N75H3ltB1X7mqGBF33zRhdt4gM866L5pIFpeL28n8QrPtKdqKYJkCYAheG4yUwZWJ+Uqmnc6teOspE6nYmP5qz+rR9SJr70JUQxXpOq7VvEWWLOqBrpjJRTsD7+wMLtKaCwUmQKjK0nOkTGJNpr7Yz9OcAHWs0IIsaHGqFou7OjdGG6inmD5XhilTw/PaRePxsqeiiVZc/kY6ej6JnqlJ4c7UpHwwZl8AwjQtgyDravLIL0LWOTCFysa+Wmvlu4aQumMw1BaXDXxITi27OuRYQfoSDJszfmtsm3U4bhRlLf12oA6UKbKhaasbrWRIWhuq0leLhWT0YpNCSVslGwoRrjCAcVO0JpNKFmjHngvKvp0ShYix6qLfuEgT4rV8fz49PYJ6NmifJU41tfsSUPeZRbRkcg8QQu45QqiKAnnWChKlOVe50bnQQZJmgy4mvUPXjCc/CUARjb2v53q2uLbeTYghrwp020yY4cgSdNashCOejAsRnb5Hlk8OyxqdT2EXzo7fNclodDAiqAJlEH0LFIJCwGCc9DN1DnDkq5ich5K0GRsNXteKoelWXA9hQ9Phtls3xetgP5XpjuLxCs4lht2jgz4c+2qS2xmMvbX+KsDx2zfw6oedV4nfdI1FWSOjxdeLnZ2lvx8xg+Ma4st47on8hjnPX29mjrZGNCTHACEJr/dQoJu1hsUqIEzMlBxg4SuXtCeaJBKPpHok1fdEquevl/5OvYf3gvSGWaFLrd99BTlOCehaE2VSNiEbRgJrChP7cGQJA0HkGeAEjQOLkbjdqV7etVMF4ikxkNNCJWLKBFiVo+uStHyIUVOGR2o9Uus7otbL7n6VjooOLZzUaF/6b+i1uw75thhZHw4rhkhYpF1pROTA+XSay1p6ZTTGysYNx9X/MfxIqkdSfV+k2tnk7R4USiwRqOEkSDb1We3gUMK/fSqrKxvudwzrqRIZC4rEId1n1Dcpqp76IU2tT5JGrJcY843H8IO9tjcrTsQ/Grdym9Rpv/hfNilyRb11yra3JHIr0kS3PN/eN6qv85yqXDJpuVlppxcUc5+poZpQEhQJYqgG02cDX5JDI0/dMobB/FZVFwMJKwzmTT6Lgb65aqg/K+qeVCz4yGMsh4MButl27kOkbNtaLHA7RNSf+toXSuIMpCs2cZYW7rWqen4pY8KzlF4DwXeyHk5kPZw0bKtZuA17N/kK0oU4Ek5d2umzDdUWuQorxMWulHR9xRwjlOynJqNw4eDWH0KgdCYhl5XeCHzRpe81w6A911zMBFQi0zxGneCOEZDpQhBnPSehWTc+krOVpSkxTtqo3vuMbOhfuAu3tfXPn3/9+/cfsLd/dLz/Zvd0f29rawjvaIJ6lipROypwJnrGVPgpZXKkGlexYoF/qlLow5mohZzczITrUjCNqdExZ2dJI0ofYoFpr2qw/WACrzRivtwRH26pgb1chQ1Ki0auL2vwzRt4n9e9rwEumHiWgNEBueqp4bp4JJzL0JK5nRsogbPYns9HGOiM7WIhrz9XxILjy55K2+BIQHs+V5kJ8pzd6PydFXhy3FD8KXydSG2sTHuL6uQONV3FqqFSPfWJZhsUVOTrG0T+jaJr+5AulnPCjDjVth7d1ZrK2Fm39m0lcnIjgD/tn6rF4j8bAZMk
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Retrieves the contents of a vector store file."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/openai/v1/vector_stores/{vector_store_id}/files/{file_id}/content"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Retrieves the contents of a vector store file.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"vector_store_id","in":"path","description":"The ID of the vector store containing the file to retrieve.","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","description":"The ID of the file to retrieve.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A list of InterleavedContent representing the file contents.","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","description":"Unique identifier for the file"},"filename":{"type":"string","description":"Name of the file"},"attributes":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Key-value attributes associated with the file"},"content":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","description":"Content type, currently only \"text\" is supported"},"text":{"type":"string","description":"The actual text content"}},"additionalProperties":false,"required":["type","text"],"title":"VectorStoreContent","description":"Content item from a vector store file or search result."},"description":"List of content items from the file"}},"additionalProperties":false,"required":["file_id","filename","attributes","content"],"title":"VectorStoreFileContentsResponse","description":"Response from retrieving the contents of a vector store file."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/returns-a-list-of-vector-store-files-in-a-batch.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/returns-a-list-of-vector-stores.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/run-an-evaluation-on-a-benchmark.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/run-preference-optimization-of-a-model.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: run-preference-optimization-of-a-model
title: "Run preference optimization of a model."
description: "Run preference optimization of a model."
sidebar_label: "Run preference optimization of a model."
hide_title: true
hide_table_of_contents: true
api: eJztWkluHMkVvcpHriShSBblHty1Y5OSLUNqFjigYVBE4Vfkz8wQMyNSMRRZTdQZvPfKx/B5fAFfwfiRY40kBXohgFywiKyIP78/Je8jQ7bUypKNRvfR2+GQP2KywsjSSa2iUXQEY23dhUGppEr/pqf70SASWjlSjk9jWeZSIJ8++GL5yn1kRUYF8l9uXlI0ivT0CwkXDaLS6JKMkxXDL3o68V7GvZPWGanSaLEYRBjHksliPu7dSjC3NIgMffXSUByNrjoy14PISZcznRWho8WCSf6wScOLjIDJkXVwixakmmEuY9AGCswTbQqKn09n69B52zsnlaOUTDRYEeuvFxdjqE6D0DFFi1a7VWutXn1njDYQDg8AwWbaOLC+KNDMQSfgMgIKZ24zKTKQldJGonKQaAOo6u8DnwXTdyjzx3KuTjPrXKuUDGS+QLVnCGOc5gS9O0viMCeprEMlHqHlq9OyCo/XcASXZx9rZQQqmBJ4SzE4DYackTQjKLQhkIr9GTwHONXeBea2JCETKUAL4Y0hJWhFrqeEY+3hxlut8XrRGcy0xXgNJCExuggyHI0/7MOZ9mmWzyHRea5vLZy9P4af/zz8eZ+NRndYlFVkNPH1w3DY8fsVYzirQryT55GRXyPn7S+bkSNyScpBhhYs/+G0hgLVvCHMVAEhlTNSgIX2ygXbyoJeQPUCqu8MVG9/6fhdaA2fONJrZNk+tP6uPWQ4I6A7QRSz2Rhs6AhyWUi3D+Oc0BI4MwdMUSrI0ZHZr/H247ZKZcnMyAApwVAiQzEHlld0V5JwFNfGfYHWC7S+K2j92K9XHziyFeZwXkV7x7+G19F6yDfGiPfh1BtwhEWoSlMiBUo7mUiKG3jFlKDP3YZ2dwfhF1C9gOr7AtVwE7dHQCighEMNU8va9KcpeHWsC/4811q9ZoWWFTjzCkpDCdUmLJ0s5B/Y+Bmh0DHlPEWWaLAgR4Z5XFf2I+t+1fGclfi/D5mrknN5vbz8cNK4/YuecvAIQ+gomDiRipxXFE+CEo8jGY4yIb69x9cDLcxTbaTLionQKpHp5nLfnoLqlDfBCmy+3WpPyfWNo3wx3ZBfLqgoyaDzhqB1R0A/G+BkfAq5tpbF5c9JRey+S5+RlWmhZbxRcT7NtuSrkHglQgw4zbAMPE7Gp50erQVJ+SJAqCWdSZUyhmSpo0F04/SkRGn6WDoZn37U1l6ETPUUnAYz9bVbJnqUy1QVpNxx5SPGRI2DnW5rDj3Va2pCpRbZY0rDb8GjIVYbZtXdkPC8YlkLvJtYR6WdlGQq0lso1/48XOXyCe9k4QtQLbdAr+YBJbeigexiEKUGYx4GJyiEL3wedK74P5Hrb+vcWpoEDR+u7QkndF/G6MLaqFI5TLHfzr1XU9bV72jXsi2ZIEaHWwOjR/e4HxYBC3wTco0xOxJVDFWNchUmdkcN37XkJo9JcpdKfvUEMiYVWqIO7W0Y1eRYnyk6kU2s/IOeFJE2VKLKNi3ZQIuJ2swnyVILM9U6J1RrFH/PyGVMQ0N9KUhaCwixZxVbDq0DKtOtO+B9eN6k94bKK+42jBeO9x6xxFynr3ekpeY0CxsOL6WMimbFiOXpheJTvNQLle0O64Viz2UlihuKtxi3Dvk6EW7l2bM7k4PC506WObWOlYohCVaqlJ9y4eZiz5JRkkghSYl5my0nWk2kKr17NqmELkrPszSXFq0gUAenb0hZQAu3lOf8qb3rvnhaZei5awkHXfwuR9tKFHQFo+6AyHxbYmBPLzVRbUvwYF7oOHeFe6lS1QW6PdcU51cYYzEA/n07YFjYNN6FCT4YDcLHLRsoXdrFnzbkL+pBIjcPdyYfCU1IG2FnsmIIClPCLck0c5OYBM4fJvh7OA3hNAjdhGk16xhKfY6mNjETV76Y3KIpfLmzhuyqWkw4X1KjIvi0OFxxYrDeiu4bpN1k/i4kO4x+W0wWVGjeW6m4RWI/RO2DkUmKZ8AJCidnVXYUGYmbUksVKt5z5QkO5o4JLDGpBsPYC2r08RbTEKDr4ukkqYvzs8lWk+zJFxqd4/FlqHe8PPzL+LKWLbQ24a9JG7mTxMbl5NZg+az2qtjsdQB5f34yBmZT1kU28BWlb6zy7CYJHLvxsDbLw7hph902vruYj5scuF55m2Fmmhz+tKsUc16vppoAgjDX9aR8xfcHkJTV7z+9ff00pLfN/+bGfXeD3QN8M6l3umfzkkyQdGIJjch6sF8F6mZx7yOt6DSJRle9PJvn0WKw5vreozoV954073e7J2gMzvsPakkW14tNQ2WnClSqrI5YYVZN06Vy+53pWMm/ptg3vRNfX1psWD2sT7U7YmbVvv237u3epyk6zVvHsE7qBHTGU1C9NCTQNY84x7lMx9EoKnV4V1miy6JRdDA7POAne42cB92Kaa+pkNx5hH2xDS70htdcmXPl6OAA1Xwv09ZRvJfnWOCedShu9oUuosU13xPeSDcPF0+ahHB1zd/xwumsW02969Zs3WqpyyZrK6Luq00bn2pNM1zar7Sbj83bhm5HMNwy4R8+MIsfbhuTD9cn2N7Q0mnSHwuHvYGu8uHSDNafl7YMQx3dZnZp0vnK8BAeb+moV3vdpiflXnO42isON/V3w22N0YPNSi3u7q6hPrSriNdH1stro3jcpCEuVLvz+oY0uAib9USHjFgj9iODAc4ZDHBeb8CrXmkPTlp08vaZyxJjq0pTs8MNKz9+hWCXlunt2pcf9nm5DB2URs9kTPazgpUfBJ7MdQKk4mBnG5pNl5HkvGiq/XjYlXA3bhIUZCuiaOiz4h23NmH5v058yv/vkNOMDKaNVJ8YrHb/s/qs3rz5zz//9d9//wNO3o3P3h0fXbw7efNmBB8pRTEPlqgYFTjndwyGCj2jmP/NIfFhkVpbye7DZb3oLGRad8+9xbjK56FacV4rMOy0FRb0pBX6kgd6K/MnkKhDytGdOyhzlGH6Cbnzvs6+V5W3l/Jv6OjXM/D1IOIsy3fu76do6dLkiwU//urJzKs9f3jJNOXwu+L6lxHGZELmvaF5NIqOKy32Lqp5Z4a5D4BefQnA9bS6cSQElW7n2etebRmfnl9wFqtfNLApolFkkGdX/j2KoirJ8Cgzuq+e3Uc5qtTzhDCKKpr88z91mecP
sidebar_class_name: "post api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Run preference optimization of a model."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/post-training/preference-optimize"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Run preference optimization of a model.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"job_uuid":{"type":"string","description":"The UUID of the job to create."},"finetuned_model":{"type":"string","description":"The model to fine-tune."},"algorithm_config":{"description":"The algorithm configuration.","type":"object","properties":{"beta":{"type":"number","description":"Temperature parameter for the DPO loss"},"loss_type":{"default":"sigmoid","description":"The type of loss function to use for DPO","type":"string","enum":["sigmoid","hinge","ipo","kto_pair"],"title":"DPOLossType"}},"additionalProperties":false,"required":["beta","loss_type"],"title":"DPOAlignmentConfig"},"training_config":{"description":"The training configuration.","type":"object","properties":{"n_epochs":{"type":"integer","description":"Number of training epochs to run"},"max_steps_per_epoch":{"type":"integer","default":1,"description":"Maximum number of steps to run per epoch"},"gradient_accumulation_steps":{"type":"integer","default":1,"description":"Number of steps to accumulate gradients before updating"},"max_validation_steps":{"type":"integer","default":1,"description":"(Optional) Maximum number of validation steps per epoch"},"data_config":{"description":"(Optional) Configuration for data loading and formatting","type":"object","properties":{"dataset_id":{"type":"string","description":"Unique identifier for the training dataset"},"batch_size":{"type":"integer","description":"Number of samples per training batch"},"shuffle":{"type":"boolean","description":"Whether to shuffle the dataset during training"},"data_format":{"description":"Format of the dataset (instruct or dialog)","type":"string","enum":["instruct","dialog"],"title":"DatasetFormat"},"validation_dataset_id":{"type":"string","description":"(Optional) Unique identifier for the validation dataset"},"packed":{"type":"boolean","default":false,"description":"(Optional) Whether to pack multiple samples into a single sequence for efficiency"},"train_on_input":{"type":"boolean","default":false,"description":"(Optional) Whether to compute loss on input tokens as well as output tokens"}},"additionalProperties":false,"required":["dataset_id","batch_size","shuffle","data_format"],"title":"DataConfig"},"optimizer_config":{"description":"(Optional) Configuration for the optimization algorithm","type":"object","properties":{"optimizer_type":{"description":"Type of optimizer to use (adam, adamw, or sgd)","type":"string","enum":["adam","adamw","sgd"],"title":"OptimizerType"},"lr":{"type":"number","description":"Learning rate for the optimizer"},"weight_decay":{"type":"number","description":"Weight decay coefficient for regularization"},"num_warmup_steps":{"type":"integer","description":"Number of steps for learning rate warmup"}},"additionalProperties":false,"required":["optimizer_type","lr","weight_decay","num_warmup_steps"],"title":"OptimizerConfig"},"efficiency_config":{"description":"(Optional) Configuration for memory and compute optimizations","type":"object","properties":{"enable_activation_checkpointing":{"type":"boolean","default":false,"description":"(Optional) Whether to use activation checkpointing to reduce memory usage"},"enable_activation_offloading":{"type":"boolean","default":false,"description":"(Optional) Whether to offload activations to CPU to save GPU memory"},"memory_efficient_fsdp_wrap":{"type":"boolean","default":false,"description":"(Optional) Whether to use memory-efficient FSDP wrapping"},"fsdp_cpu_offload":{"type":"boolean","default":false,"description":"(Optional) Whether to offload FSDP parameters to CPU"}},"additionalProperties":false,"title":"EfficiencyConfig"},"dtype":{"type":"string","default":"bf16","description":"(Optional) Data type for model parameters (bf16, fp16, fp32)"}},"additionalProperties":false,"required":["n_epochs","max_steps_per_epoch","gradient_accumulation_steps"],"title":"TrainingConfig"},"hyperparam_search_config":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The hyperparam search configuration."},"logger_config":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The logger configuration."}},"additionalProperties":false,"required":["job_uuid","finetuned_model","algorithm_config","training_config","hyperparam_search_config","logger_config"],"title":"PreferenceOptimizeRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A PostTrainingJob.","content":{"application/json":{"schema":{"type":"object","properties":{"job_uuid":{"type":"string"}},"additionalProperties":false,"required":["job_uuid"],"title":"PostTrainingJob"}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/run-supervised-fine-tuning-of-a-model.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

19
docs/docs/api-deprecated/safety.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: safety
title: "Safety"
description: "Safety"
custom_edit_url: null
---
OpenAI-compatible Moderations API.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

73
docs/docs/api-deprecated/search-for-chunks-in-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

518
docs/docs/api-deprecated/sidebar.ts Normal file
View file

@ -0,0 +1,518 @@
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
const sidebar: SidebarsConfig = {
apisidebar: [
{
type: "doc",
id: "api-deprecated/llama-stack-specification-deprecated-apis",
},
{
type: "category",
label: "Agents",
link: {
type: "doc",
id: "api-deprecated/agents",
},
items: [
{
type: "doc",
id: "api-deprecated/list-all-agents",
label: "List all agents.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/create-an-agent-with-the-given-configuration",
label: "Create an agent with the given configuration.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/describe-an-agent-by-its-id",
label: "Describe an agent by its ID.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/delete-an-agent-by-its-id-and-its-associated-sessions-and-turns",
label: "Delete an agent by its ID and its associated sessions and turns.",
className: "menu__list-item--deprecated api-method delete",
},
{
type: "doc",
id: "api-deprecated/create-a-new-session-for-an-agent",
label: "Create a new session for an agent.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/retrieve-an-agent-session-by-its-id",
label: "Retrieve an agent session by its ID.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/delete-an-agent-session-by-its-id-and-its-associated-turns",
label: "Delete an agent session by its ID and its associated turns.",
className: "menu__list-item--deprecated api-method delete",
},
{
type: "doc",
id: "api-deprecated/create-a-new-turn-for-an-agent",
label: "Create a new turn for an agent.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/retrieve-an-agent-turn-by-its-id",
label: "Retrieve an agent turn by its ID.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/resume-an-agent-turn-with-executed-tool-call-responses",
label: "Resume an agent turn with executed tool call responses.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/retrieve-an-agent-step-by-its-id",
label: "Retrieve an agent step by its ID.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/list-all-session-s-of-a-given-agent",
label: "List all session(s) of a given agent.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/list-all-responses",
label: "List all responses.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/create-a-model-response",
label: "Create a model response.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/get-a-model-response",
label: "Get a model response.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/delete-a-response",
label: "Delete a response.",
className: "menu__list-item--deprecated api-method delete",
},
{
type: "doc",
id: "api-deprecated/list-input-items",
label: "List input items.",
className: "menu__list-item--deprecated api-method get",
},
],
},
{
type: "category",
label: "Benchmarks",
link: {
type: "doc",
id: "api-deprecated/benchmarks",
},
items: [
{
type: "doc",
id: "api-deprecated/list-all-benchmarks",
label: "List all benchmarks.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/register-a-benchmark",
label: "Register a benchmark.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/get-a-benchmark-by-its-id",
label: "Get a benchmark by its ID.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/unregister-a-benchmark",
label: "Unregister a benchmark.",
className: "menu__list-item--deprecated api-method delete",
},
],
},
{
type: "category",
label: "DatasetIO",
link: {
type: "doc",
id: "api-deprecated/dataset-io",
},
items: [
{
type: "doc",
id: "api-deprecated/append-rows-to-a-dataset",
label: "Append rows to a dataset.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/get-a-paginated-list-of-rows-from-a-dataset",
label: "Get a paginated list of rows from a dataset.",
className: "menu__list-item--deprecated api-method get",
},
],
},
{
type: "category",
label: "Datasets",
link: {
type: "doc",
id: "api-deprecated/datasets",
},
items: [
{
type: "doc",
id: "api-deprecated/list-all-datasets",
label: "List all datasets.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/register-a-new-dataset",
label: "Register a new dataset.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/get-a-dataset-by-its-id",
label: "Get a dataset by its ID.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/unregister-a-dataset-by-its-id",
label: "Unregister a dataset by its ID.",
className: "menu__list-item--deprecated api-method delete",
},
],
},
{
type: "category",
label: "Evaluations",
link: {
type: "doc",
id: "api-deprecated/eval",
},
items: [
{
type: "doc",
id: "api-deprecated/evaluate-a-list-of-rows-on-a-benchmark",
label: "Evaluate a list of rows on a benchmark.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/run-an-evaluation-on-a-benchmark",
label: "Run an evaluation on a benchmark.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/get-the-status-of-a-job",
label: "Get the status of a job.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/cancel-a-job",
label: "Cancel a job.",
className: "menu__list-item--deprecated api-method delete",
},
{
type: "doc",
id: "api-deprecated/get-the-result-of-a-job",
label: "Get the result of a job.",
className: "menu__list-item--deprecated api-method get",
},
],
},
{
type: "category",
label: "Files",
link: {
type: "doc",
id: "api-deprecated/files",
},
items: [
{
type: "doc",
id: "api-deprecated/list-files",
label: "List files.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/upload-file",
label: "Upload file.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/retrieve-file",
label: "Retrieve file.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/delete-file",
label: "Delete file.",
className: "menu__list-item--deprecated api-method delete",
},
{
type: "doc",
id: "api-deprecated/retrieve-file-content",
label: "Retrieve file content.",
className: "menu__list-item--deprecated api-method get",
},
],
},
{
type: "category",
label: "Inference",
link: {
type: "doc",
id: "api-deprecated/inference",
},
items: [
{
type: "doc",
id: "api-deprecated/list-chat-completions",
label: "List chat completions.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/create-chat-completions",
label: "Create chat completions.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/get-chat-completion",
label: "Get chat completion.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/create-completion",
label: "Create completion.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/create-embeddings",
label: "Create embeddings.",
className: "menu__list-item--deprecated api-method post",
},
],
},
{
type: "category",
label: "Models",
link: {
type: "doc",
id: "api-deprecated/models",
},
items: [
{
type: "doc",
id: "api-deprecated/list-models-using-the-open-ai-api",
label: "List models using the OpenAI API.",
className: "menu__list-item--deprecated api-method get",
},
],
},
{
type: "category",
label: "PostTraining (Coming Soon)",
link: {
type: "doc",
id: "api-deprecated/post-training-coming-soon",
},
items: [
{
type: "doc",
id: "api-deprecated/get-the-artifacts-of-a-training-job",
label: "Get the artifacts of a training job.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/cancel-a-training-job",
label: "Cancel a training job.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/get-the-status-of-a-training-job",
label: "Get the status of a training job.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/get-all-training-jobs",
label: "Get all training jobs.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/run-preference-optimization-of-a-model",
label: "Run preference optimization of a model.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/run-supervised-fine-tuning-of-a-model",
label: "Run supervised fine-tuning of a model.",
className: "menu__list-item--deprecated api-method post",
},
],
},
{
type: "category",
label: "Safety",
link: {
type: "doc",
id: "api-deprecated/safety",
},
items: [
{
type: "doc",
id: "api-deprecated/create-moderation",
label: "Create moderation.",
className: "menu__list-item--deprecated api-method post",
},
],
},
{
type: "category",
label: "VectorIO",
link: {
type: "doc",
id: "api-deprecated/vector-io",
},
items: [
{
type: "doc",
id: "api-deprecated/returns-a-list-of-vector-stores",
label: "Returns a list of vector stores.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/creates-a-vector-store",
label: "Creates a vector store.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/retrieves-a-vector-store",
label: "Retrieves a vector store.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/updates-a-vector-store",
label: "Updates a vector store.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/delete-a-vector-store",
label: "Delete a vector store.",
className: "menu__list-item--deprecated api-method delete",
},
{
type: "doc",
id: "api-deprecated/create-a-vector-store-file-batch",
label: "Create a vector store file batch.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/retrieve-a-vector-store-file-batch",
label: "Retrieve a vector store file batch.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/cancels-a-vector-store-file-batch",
label: "Cancels a vector store file batch.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/returns-a-list-of-vector-store-files-in-a-batch",
label: "Returns a list of vector store files in a batch.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/list-files-in-a-vector-store",
label: "List files in a vector store.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/attach-a-file-to-a-vector-store",
label: "Attach a file to a vector store.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/retrieves-a-vector-store-file",
label: "Retrieves a vector store file.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/updates-a-vector-store-file",
label: "Updates a vector store file.",
className: "menu__list-item--deprecated api-method post",
},
{
type: "doc",
id: "api-deprecated/delete-a-vector-store-file",
label: "Delete a vector store file.",
className: "menu__list-item--deprecated api-method delete",
},
{
type: "doc",
id: "api-deprecated/retrieves-the-contents-of-a-vector-store-file",
label: "Retrieves the contents of a vector store file.",
className: "menu__list-item--deprecated api-method get",
},
{
type: "doc",
id: "api-deprecated/search-for-chunks-in-a-vector-store",
label: "Search for chunks in a vector store.",
className: "menu__list-item--deprecated api-method post",
},
],
},
],
};
export default sidebar.apisidebar;

72
docs/docs/api-deprecated/unregister-a-benchmark.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: unregister-a-benchmark
title: "Unregister a benchmark."
description: "Unregister a benchmark."
sidebar_label: "Unregister a benchmark."
hide_title: true
hide_table_of_contents: true
api: eJztV0tu20gQvUqhV4lBS06QIIl2TqzBBOMghj+LgW0MSs2S2Emzm6kuKhYEnmH2s5pjzHnmAnOFQZHUx5YdeBvA2ogS6/vqvWpyaZhSFUOiZEZL8/LgQL9ySpZdJS4GMzKffzNNZl7dd+u8IGD6VlMS+I4JXJijdzlEhhL9NHJJucmMjUEoiPpjVXlnUf2HX5IGWZpkCypRr2RRkRmZOPlCVkxmKo4VsbiuuiQoddqyc0FoRmyyO2X9en5+Ap012JiT1i9OPG35JmEXZjuuY+bI0BpngJCKyAKpLkvkBcQpSEFArc33wtkCXNc0OwwC08iAob/f5mk0vqDzj83cWWtqH8OMGIq6xLDPhDlOPMGWz61yNJMLSTDYR3T57HN7hf45HMLF6XHfjMUAE4I6UQ4SgUnY0ZygjEzggs6znRzgJNbSJk8VWTd1FqK1NTMFS3fqajKDee66fCdbA52iT5QZ5Y9jys3ocjXh1bTW4F2v59fB9AB4Ky7DlGPZ1nB48nEAp7GeFX4B0+h9/J7g9JcP8ObtwZuBgkY3WFYdM1b8enVwsMn3HnM47Si+qeeRzG8a7f7Vy3f3K8d6R0GgwARJLyRGKDEsVoE1KiDM3JwCYBnrIC22rqQnUT2J6icT1ct3m3znMcInZXqvrLQtrd9jDQXOCejGEuUKm4oNhcC70skATjxhIhBeAM7QBfAoxINeb68fOqkS8ZwYKFiVEjHlSqw60E1FVijvwX2S1pO0fippvd4+rz4qswN6OOvYvsnfy+twl/IrMPIBfK4ZhLBsT6UJUYAQxU0d5St55TTF2suuxH4U+ElUT6L6uUR1cF+2R0ioVYlSDWdJu3lPwRYl8tekDdwu+CIwzVwSYkCYrAwHynlkLEmINcbSBCy1kLXJH04V5TRGhVLsIKGn3cej1QzWbjrPep1T82xwF64p21Vhz52maYuvmCzKxrwkKWJuRiYnT0Jt4VKYkRnOXwxpjn64zp2Gy+3yG5OZ7jzuOqxZgS1EqtFwiGGxX8QklO97jyXuJ0H7dWBjabSORLZmJ4vW8Wi1ji6v9Z4StC2/n92x+sOZ+sNZT9OOvvtwtO5HKaKM03I6BOcv7gFVdZ5uMR63NbidSwoUqDjOXU7pKsCdD0Ki9mGeQl5FFyQBhvZBxzHYyB2JcxdmoPuNp2gpdUGR6SooESO3Ct0NPtGXEk9zYpytqvoUc/JpcBWuwt7ev3/9/d8/f8LR+OR0/OHwfHy0tzeCY5qhXbRIdIlKXOgiYCrjnHJ9F5nWUjNBj1IawIXKTF953Iw7KJim1C+A4BetuKqYpMR2yfc8fpj3txBfbs6MH7j0RBW6kWHl0QXN2dJp2bPxspum8tFkGxHpwEe3JHWdGaWdeiyXE0x0wb5p9O9vNbHy7Toz7Z6fKLkulyZ3Sa/z9SJ7sIFnp73UnsOj1Xlva/2fGBZKWPS1/jKZ+UqLuyuiuW4yUxDmxG21ncmhtVTJlvPOcaxCWkv7aHw8Ph+bpvkfsu9WWQ==
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Unregister a benchmark."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/eval/benchmarks/{benchmark_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Unregister a benchmark.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"benchmark_id","in":"path","description":"The ID of the benchmark to unregister.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/unregister-a-dataset-by-its-id.api.mdx Normal file
View file

@ -0,0 +1,72 @@
---
id: unregister-a-dataset-by-its-id
title: "Unregister a dataset by its ID."
description: "Unregister a dataset by its ID."
sidebar_label: "Unregister a dataset by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztV81u20YQfpXBnhKDlhwjQRrd3EhFjTqI4Z9DYRvFaHcobrLcZXaHigmBz9B7T32MPk9foK9QDElZcuS0vhqwLqLI+fn2m+/bFVcqUqqCT5TUZKUODw7ky1DS0VZsg1cT9fEX1Wbq9UOPLgqCSF9qSgxfMYH1S3TWQIhQostDLMmoTOngmTxLPlaVsxolf/wpSZGVSrqgEuWKm4rURIX5J9KsMlXFUFFk26NLjFynrTjrmRYUVfYNrJ8vLk6hjwYdDAl+tuxoKzdxtH6xkzqLMUTogjNASEWIDKkuS4wNhBy4IKAu5mthdQG2X3S06BnyEAH98Lzr00p9Ruse27mPltYu+AVFKOoS/X4kNDh3BFs59+BIJ+sTo9ePWOWLj90VupdwBJdnJ8NiNHqYE9SJDHCASBwtLQnKEAmsl3l2kwOch5q75qkibXOrIWhdx0he0ze42kyhMbbvd7o10BxdokyJfmwkoyZX6wmvp3VH3s3d/HqavkPeWsuQx1B2GI5Oj0dwFupF4RrIg3Pha4Kzn97D2x8O3o6ENLrFsuqVsdbX64ODTb8f0cBZL/ENnkcqv21l9a8P3z3sHO0seYYCEyS54BCgRN+sC0tVQFjYJXnAMtSeO25tSc+mejbVEzPV4btNv4sQ4IMofXBW2rbWr6GGApcEdKuJjNAmZkMmcLa0PIJTR5gIODaAC7QeHDLF0eC3N987qRLFJUUgr8VKFMmIsGpPtxVpJjOQ+2ytZ2s9KWu92T6vjkXZHh2c92rf9B/sdbQr+TUZZgQf6whMWHan0pzIgw9sc0tmbS9DOdaOdy32X4WfTfVsqqdlqoOHuj3CQp1LRGq4SLKaKTIm4iTw78O99JEWNjFFQDB9GMwbsJzgeDoS5WPEkpiiVFopj6XAGUJ/s+IqK5Uq5GKHDTnxjqfrOazrc4D6rq/02DDPsaZs14eDetq2W0AVSSNvwkviIhhBRY6YOtBcqIkaL1+Nh6ZpvNpgblWm+oO4X1QdhdGCuZqMx+ib/SIkJrPvHJa4nxj155EOpZL2iXQdLTdd4nS9D13dyDNRZod6GNqJ5MO55MP5oM9et/swvVuGaEOkJnB62pavHmBSDJ7uSR23zbfdiwtkqGJYWkPp2sM3HwSZQsiBvKmC9ZwAffcPx0bQIfbqNdYvQDa2mKOm1BfFSNdeFBhiZ83d4nN5G3G0pIiLNaoPwZBLo2t/7ff2/v7jz3/++h2ms9Oz2fuji9l0b28CJ7RA3XRM9I1KbGQHiFSGJRl5CclrriPBwFIawaX4S9517CL2VETKaXC+d03nqiokLrHb3Qfp/r/k7zG/2hwaj0gd9Mp0y+PKofWCoZPXahDl1TDdtSUzNdky002mRHsStlrNMdFldG0rt7/UFEV0N5nqdvm5KOxqpYxNcm3utrHvon9xNtjsJTzSlw+uZriJvhHNoqvll8rUZ2rubwztTZupgtBQ7JD2AUdaU8VbqTsHsTjpztLT2cnsYqba9l9601J2
sidebar_class_name: "delete api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Unregister a dataset by its ID."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/datasets/{dataset_id}"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Unregister a dataset by its ID.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"dataset_id","in":"path","description":"The ID of the dataset to unregister.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

72
docs/docs/api-deprecated/updates-a-vector-store-file.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

72
docs/docs/api-deprecated/updates-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

78
docs/docs/api-deprecated/upload-file.api.mdx Normal file
View file

@ -0,0 +1,78 @@
---
id: upload-file
title: "Upload file."
description: "Upload file."
sidebar_label: "Upload file."
hide_title: true
hide_table_of_contents: true
api: eJztWM1uG0cMfhViTk6wkmUnaRrdnMRBAySw4Z8ChWUU1A6lnWR2ZjMzK3tr6Bl676mP0efpC/QVCs7sSitbQRykPQSwL5LWHHJIfh+55I1w5CtrPHkxvhH7oxF/SPK5U1VQ1oixODBwVJE5ePtGaTqafqA8gKPKkScTlJlDKAjqSluUJGGmNA1FJnJrApnA6rCqtMqR1e1+8KzzRvi8oBL5W2gqEmNho2KRicrZilxQ6Ubt47WcD06ZeTLggxgLNigyIWmGtd540HfirCBIuoAVZXBVqLwA5QH1FTYeJvHcRIhlJpTcZvCuQj4BSnIYZopcpzRHA1MCRzNyZHKSoEwM0sHxWyAjK6tM8Gxo2oTkZmtLmUBzcluNefUbgZ1FRWw4Y61JwTITuSMMJH/FcE9150ZdQ1Al+YBlBTvKgKfcGukfwcw6uCrIrGzBFXpoTbA1uq6UI/9/WWvVsyX+bbCk+yWEJfsxYg1V7SrrtyogU5difCHQe+UDclIyMcWQF+Jym3r20DDIW52bppaZQCkVy6M+7qF4htpTJhx9qpUjyRZXaFdSdDDYSOJGjHthWPtzmYmggmaHbtPzTmySALBExwL0IGmmzBqdPSHPUB2K5ZKderqtKHA42CHyIYJDmQVqJcE6KFHPrCtJ/ndVwAcM9X2I8tPZ2TEkacitjABoo/Ql/Bw6Zx1E4QwQfGFdAF+XJbqmSzRFmVXpYKedQhMihtG0/492lqw/oNL3tZyk2bS2Zk4OirpEM3CEEqeaoHdm4zqxYBmGb34PL3eOqgTQR3AA5yfvNktW7UlCsOAoOEULgtI6hj3nM2YOcGrrEI37inI1UznYPK9dLHS37vU1hGgz3GVrFbweymOYPhO8rovBzNmyq7VDOLH1vNANzKzW9srDyZtX8PzH0fNhKmJYVgkZHb6ejkZrey9RwkmC+Po+90R+y5z9F9uZk2tFJkCBHriJQrAWSjRNp5i1AsJcLcgAlrY2IcZWxQrwQKoHUn1PpNp/sbZ3Zi28Z6S3zPJ9av1iayhwwS8AORE3WjbqMBBoVaowhGNN6AmCawDnqAxoDOS6TvXsc53Kk1uQAzI5U4kcSQZWbei6ojyQbIP7QK0Han1X1HrW71dvGdkGNZwmtK/tt/Q6uAv5LhhyCEe1g0BYxq40JTJgbJxrZEev1Yi1ZUL8rOIHUj2Q6vsi1WibtXtQKLKEoYZzz97EQeruIHkeNyVpTzIx7S9Mg28oMGykAXNnvQdGmK39enkwnJiJWa0g0vKF0VpryWcRyloHVaGLqCzXL6wqFOOJGcRzY2AN/aFwx9iQVPKw+YhRMF3vdoZ8sB0/09nPDcSb2yA+tppmZ4HcGDoAptstUNfkW3BPeaUUxRPYmFXdkM2LpQodlhTIcZAvE4DIh5dWNpzFXrFZxWCXrQwkBvyaehOn+i1cSjwQYzFVBl3zTTuGuxP8cavqNmx+jkNGF+c2YhybLWN7b3nA4f6yq2jywrpt1++2bL3VxDIT7e5mSy3+Kr63Ztf6+kRPHhxEB24H45U1wVndh4mdbaKOKXLMUPHjiYEBJFsZlLUPDOpJz6WJiCLtLdYyyvBHuOJm+OSH0QjQSNh/9mJ/NBrBzh4UlnumhScjkNj4R9H7voPtKnK1slluCgRXU2wRlaM87tbio0yUFAorxVhUNg6fFYZCjMXuYm/XVmRQ8bfoZQwet3tmw42oHVepIoRqvLuLphkU1geSA62xxIEPmH8c5rYUy8sY9Nqp0MSDr7vefnHJ/+NqH7PbZuMdn4dTPg+nbc1PcR/A69X1GX58I75OStRib8uejpum32gf2G9ofVuxIFbOLpQkPzFw6w/BU5yMV4UxpigUpBzk1qWOILmiMEDdDHPySSk6mhiu6tbFdndX+ZQLpqYFOZx3t3pvJelUfR8//vuPP//563d4fXh8cvjq4Ozw9ePHY3hHc8ybGIlkqMQmbYNLu0jLtlkdakfQRskP4Zx7Fu8P1LxF82p3DNboJlKaoVBifGNKC9GNTnI7zL1C+NBxvrHjtCUu0HXYrTQqw+mITLtpmXmRgJ64yQTYa3e2saQxB1nm5maKns6dXi758aeaXJN6WHyDnDLTLi6XmSgIJZftixvxkZq23pEJgzO+CYvrmm+0rcEts+7QQZ5TFXrid16+memrUnN8dHrGrantoyW/OI9js4t6s/VXvuRy+S+RpSkR
sidebar_class_name: "post api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Upload file."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/openai/v1/files"}
context={"endpoint"}
>
</MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Upload file.
Upload a file that can be used across various endpoints.
The file upload should be a multipart form request with:
- file: The File object (not file name) to be uploaded.
- purpose: The intended purpose of the uploaded file.
- expires_after: Optional form values describing expiration for the file.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"},"purpose":{"type":"string","enum":["assistants","batch"],"title":"OpenAIFilePurpose","description":"Valid purpose values for OpenAI Files API."},"expires_after":{"type":"object","properties":{"anchor":{"type":"string","const":"created_at"},"seconds":{"type":"integer"}},"additionalProperties":false,"required":["anchor","seconds"],"title":"ExpiresAfter","description":"Control expiration of uploaded files.\nParams:\n - anchor, must be \"created_at\"\n - seconds, must be int between 3600 and 2592000 (1 hour to 30 days)"}},"required":["file","purpose"]}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An OpenAIFileObject representing the uploaded file.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"file","default":"file","description":"The object type, which is always \"file\""},"id":{"type":"string","description":"The file identifier, which can be referenced in the API endpoints"},"bytes":{"type":"integer","description":"The size of the file, in bytes"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the file was created"},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the file expires"},"filename":{"type":"string","description":"The name of the file"},"purpose":{"type":"string","enum":["assistants","batch"],"description":"The intended purpose of the file"}},"additionalProperties":false,"required":["object","id","bytes","created_at","expires_at","filename","purpose"],"title":"OpenAIFileObject","description":"OpenAI File object as defined in the OpenAI Files API."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

19
docs/docs/api-deprecated/vector-io.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: vector-io
title: "VectorIO"
description: "VectorIO"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

41
docs/docs/api-experimental/agents.tag.mdx Normal file
View file

@ -0,0 +1,41 @@
---
id: agents
title: "Agents"
description: "Agents"
custom_edit_url: null
---
APIs for creating and interacting with agentic systems.
## Agents API (Experimental)
> **🧪 EXPERIMENTAL**: This API is in preview and may change based on user feedback. Great for exploring new capabilities and providing feedback to influence the final design.
Main functionalities provided by this API:
- Create agents with specific instructions and ability to use tools.
- Interactions with agents are grouped into sessions ("threads"), and each interaction is called a "turn".
- Agents can be provided with various tools (see the ToolGroups and ToolRuntime APIs for more details).
- Agents can be provided with various shields (see the Safety API for more details).
- Agents can also use Memory to retrieve information from knowledge bases. See the RAG Tool and Vector IO APIs for more details.
### 🧪 Feedback Welcome
This API is actively being developed. We welcome feedback on:
- API design and usability
- Performance characteristics
- Missing features or capabilities
- Integration patterns
**Provide Feedback**: [GitHub Discussions](https://github.com/llamastack/llama-stack/discussions) or [GitHub Issues](https://github.com/llamastack/llama-stack/issues)
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

68
docs/docs/api-experimental/append-rows-to-a-dataset.api.mdx Normal file
View file

@ -0,0 +1,68 @@
---
id: append-rows-to-a-dataset
title: "Append rows to a dataset."
description: "Append rows to a dataset."
sidebar_label: "Append rows to a dataset."
hide_title: true
hide_table_of_contents: true
api: eJztV81u20YQfpXBnhKDkpwgQRrdnMRFjSa1ICtAC1sohsuRuMlyl9ldyhYEPUuPBfp0fYRidsmIthTDAXoJYF1EUfO3M9/3DbkRjnxtjScvxhvx/PiYvwry0qk6KGvEWJz/KraZeHHor1lJ4OhLQz7ANXpQZoVaFWAdVKgX1lVUiExIawKZwP5Y11pJZP/RJ89BNsLLkirkq7CuSYyFzT+RDCITtbM1uaBSdT5gaHzPTplAS3Iiu1PWL7PZBJI1SFsQ1x9U0NTz9cEps9xzPXXOOojGGSD40roAvqkqdGuwCwglAUWb61LJElQ6tFNoAiysAzTt/zHPluMHVPqhmZM1p9bWLMlB2VRoBo6wwFwT9HxulcOZlPEBjXzAKZ+cxyvUT+EEPk7ft4eRaCAnaDwVECw4Ck7RiqCyjkAZnmecHGBumxCT+5qkWigJVsrGOTKS7tS1zQQWhUr5Jr2BLlB7ygTjRzkqxPiym3A3ra/Nm3+dX2rTN5rXYRkWzlaxhpPJ2RCmtlmWeg0Lq7W99jD9+S28+un41ZCbRjdY1QkZHb5eHB/v8r3BAqYJ4rt6Hoj87ZZP/+L568PMkVqRCVCiB88XwVqo0Ky7wBwVEJZqRQawso0JsbeqokdSPZLqByPV89e7fDNr4QMjvWWW71PrD9tAiSsCupFEBbeNyYaBQKtKhSFMNKEnCG4NuERlQGMgN2z59vJbm8qTW5EDMpKpRI4KBlZj6KYmGahom/tIrUdq/VDUetnfV2eMbIMaLhLad/lbep3sQ75rRjGE88ZBIKziVsqJDBgb1EJR0dGroAU2OuxT7L7Aj6R6JNWPRarjQ9keQKHIEoYaLj2f5h0G9BTOzrn+O4SpazIFOC4nWEAoku2QQY8OKwrkOMhGGKy4ktbgT8WEUhyjxlDuNYKX3dm7bgStU0yRMsZ9mrJyrl3zg2so26diC6Dtdp6MyYc3tlizxf/Eaq6mZ4XO4ZqPGKjyh7wPg2kjrKHzRexY62EarcU2+/o7t1YTmv4t01Q5uf6d7rzZnYJ6N9pKtvMkiXsvxd1M24bb/iSG38eH2Jse+BNspvbad+8lEXC3pxirqh1JDHyrDVtRKG3BsLHxdSaiZyxGq2c5BRy19Sk7SnUPOPVos0PdVmQiPUUlWDaO6VCGUI9HIzTrQWl9oGKgNVY48AHl56G0lWDgeJKNU2EdHd91S+Ryzv8xXKY7YJ3u6JiAcbnZzqO2LWxEQ9uJ95wGLjgNXLQalLRpAKc3NTlVkQmoWQFYULjuNKPVswOkYRn3twQN+xLbzxZKDFA7u1IF+SsDdz4ITDi7ADJFbZUJHjDxTjmQ1iWNKpRZAq8vt0BJPgVFR1eGdca6KMD7wXN+59S0IofLrqoPtiDth1fmyhwd/fvX3//A6e+T0+nZh9PfZifvj47GMHE0cJQenLkd8GT1DHVdYgZp+k9T/grXIEs0S4KcFqz5OUlbcak+8PaJgsn4qTBSvJWm+8TsVqN7mnGvU0u0QDdhVGtUzNkEuE2L20uRKucMHXJZG3bYFZkY9zRzngkGKHtuNjl6+uj0dsu3vzTkGJnzTMQ9njO+LjeiUJ6vdwz65lGeTFv+PYXvlN+DB+10x7AMrlA3/Etk4jOtb++BSIySsCAXK04Gb1NdgxmH2QXYk2hWtORxIiXV4V7beU9AJucXM5GJvF0DFT9gjYXDa94neJ2KtbFPSeD53kZoNMsGl2ybYvLnPxaJJpg=
sidebar_class_name: "post api-method"
info_path: docs/api-experimental/llama-stack-specification-experimental-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Append rows to a dataset."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1beta/datasetio/append-rows/{dataset_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Append rows to a dataset.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"dataset_id","in":"path","description":"The ID of the dataset to append the rows to.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The rows to append to the dataset."}},"additionalProperties":false,"required":["rows"],"title":"AppendRowsRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

19
docs/docs/api-experimental/benchmarks.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: benchmarks
title: "Benchmarks"
description: "Benchmarks"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

68
docs/docs/api-experimental/cancel-a-job.api.mdx Normal file
View file

@ -0,0 +1,68 @@
---
id: cancel-a-job
title: "Cancel a job."
description: "Cancel a job."
sidebar_label: "Cancel a job."
hide_title: true
hide_table_of_contents: true
api: eJztV8Fu20YQ/ZXBnhKDlpwgQRrd3ERFjSaN4ThAC9sohsuRuM5yl5kdKhYEfkuPBfp1/YRiSMqSLadwgl4CWBdR5M7OmzfvzVIrw5TqGBIlM1mZpwcH+lVQsuxqcTGYiXn3i2kz8+yuR6clAdOnhpLAZ0zgwgK9KyAyVOhnkSsqTGZsDEJBNB7r2juLGj++TLrJyiRbUoV6JcuazMTE/JKsmMzUHGticT26JChN2lrngtCc2GS3YP18enoM/WqwsSDFL048bcUmYRfmO6FT5sjQLc4AIZWRBVJTVchLiDOQkoC6NZ9LZ0twfdHsMAjMIgOG4XmXp9X9BZ2/b+Z+tab2McyJoWwqDPtMWGDuCbZibsDRTC4kwWDvUeWjd90V+sdwCB9O3gzFWAyQEzSJCpAITMKOFgRVZAIXtJ9d5wDz2EiXPNVk3cxZiNY2zBQs3cLVZgaLwvX5jrcaOkOfKDOqH8dUmMnZusPrbl2Td3Hdv56mL5C31jLMOFYdhsPjoxGcxGZe+iXMovfxc4KTn17Bix8OXoyUNLrCqu6VsdbXs4ODTb4fsYCTXuIbPPdUfttq9c+evrzbOdY7CgIlJkh6ITFChWG53lh3BYS5W1AArGITpOPWVfRgqgdTfWemevpyk+80RnirSh+clbat9XtsoMQFAV1ZokJpU7OhEHhXORnBsSdMBMJLwDm6AB6FeDT47fmXTqpEvCAGClatREyFCqsJdFWTFSoGch+s9WCt78paz7fPqyNVdkAP73u1b/IP9jrclfyajGIE7xoGIay6UyknChCiuJmjYm2vgmbYeNm12H9t/GCqB1N9X6Y6uCvbPSzUuUSlhvOk1UwX2EG/CfWVtsgDwmXMR6pxZKxIiDVmZQJWmjinYMsK+eMfTh3kNLJGKXcq19Pt6PWa8+uwrn9N6BuxQN/0jYtBU24oF24o2zXgIJu2za4BXcb866BcxlxB2K7cr8vacVYzWRRdPgilIiljYSamIE9CHXVSmokZL56gr0sca6HjawrSeLXNYju+jHkar/pCWpOZ/qWgp71h7W4pUk/GYwzL/TImoWLfe6xwPwnajyMbK6PYEtmGnSy7wNfrmXh2oc/UJV1Jg4DeaDy813h4P3ilb8U+TK9qYldREPSqVBW+AurZXDy5g2AdN+mG8XB7FGxnkxIFao4LV1A6D3Drg5Co+09BoaijC5IAQ/e+5Rhs5N5LhQtz0DHLM7SU+k2R6TyoHyJ3g2J381z/G3laEON8jeptLMin0Xk4D3t7//z5198w/e14enL0dvrr6eGbvb0JHDPtM/UveEoHPBoam8HiSU6Cj/v8FS7BlhjmqveZzqacbKwUahKdkp2x65ikwu6AGSR823k3yF1tTqmdhYM+ha5kXHt0QffvFLMaNHhmBqgmM6pCk20crG2d3PKzSlFvD666yIzqTfdZrXJM9IF92+rtTw2xCu0iM90pk6uqzlamcEmvN+74YjGPTgbfPYZvmRV31j7cxLBUyaJv9JfJzEda3p5dOkL+B7A70+QbcA1ktxdtZkrCgrijsn94aC3VshW286ai9r6eQa+nb6anU9O2/wIVX6/a
sidebar_class_name: "delete api-method"
info_path: docs/api-experimental/llama-stack-specification-experimental-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Cancel a job."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1alpha/eval/benchmarks/{benchmark_id}/jobs/{job_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Cancel a job.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"benchmark_id","in":"path","description":"The ID of the benchmark to run the evaluation on.","required":true,"schema":{"type":"string"}},{"name":"job_id","in":"path","description":"The ID of the job to cancel.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

68
docs/docs/api-experimental/cancel-a-training-job.api.mdx Normal file
View file

@ -0,0 +1,68 @@
---
id: cancel-a-training-job
title: "Cancel a training job."
description: "Cancel a training job."
sidebar_label: "Cancel a training job."
hide_title: true
hide_table_of_contents: true
api: eJztV1Fv2zYQ/isHPrWBbKdFi7Z+S9sMy9YuRuIAGxJjOFFniylFquTJiWH4t+xxwH7dfsJwlBQ7TdplwF4KRA+2IPF4H7/7viO1VoFi7V2kqMZr9Xx/X/4KijqYmo13aqyOf1abTL2479W0JAj0uaHIcIURjFuiNQX4ABXauQ8VFSpT2jsmxxKPdW2NRokfXUaZZK2iLqlCueNVTWqsfH5JmlWm6uBrCmxadJGRm7gzzjimBQWVfQHrx+l0Au1o0L4gwc+GLe3ERg7GLe6EHobgA6TBGSDE0geG2FQVhhX4OXBJQGnMVWl0CaZddDDoGOY+ALrufcqzkfkZjX1o5na0pLbeLShA2VToBoGwwNwS7MTcgiOZjIuMTj9glU+O0x3ap3AAZycfusVodJATNJEKYA+BOBhaElQ+EBgn9UyVA8x9wyl5rEmbudHgtW5CIKfpC1ybTGFRmDbfZKegc7SRMiX6MYEKNT7vK9xX64a82U39Wpq+Ql6vZZgHXyUMB5OjIZz4ZlHaFcy9tf4qwskP7+DV6/1XQyGNrrGqW2X0+nqxv7/N9xYLOGklvsXzQOVvNrL6F8/f3O8cbQ05hhIjRLlh76FCt+onllkBYWGW5AAr3zhO3JqKHk31aKrvzFTP32zzTb2Hj6L0zllx11q/+QZKXBLQtSYqhDYxGzKBNZXhIUwsYSTgsAJcoHFgkSkMO7+9/NpOFSksKQA5LVaiQIUIq3F0XZNmKjpyH631aK3vylovd/erI1G2Qwunrdq3+Tt7HdyVfE9GMYTjJgATVmlXyokcOM9mbqjo7VXQHBvLdy32rYkfTfVoqu/LVPv3ZXuAhZJLRGq4iLKaiY88DWiccQt48s5X8n/qvXsqC7q9gHdSOAsI3Adc+nwoFsCAFTEFmXLW0kWR3/piJZj/J2td+vz3pjHFv0tHdtOzs6P3fZUvfS5a0Qn/8L+V+ybrTn1bInrafvJ5fwJP1G6jOTSU3FUH0sjyqMtQEZe+UGNV+3Rwr5FLNVaj5TO0dYkjeTzoaR5d+nzUgleZao8JwvRaNUHqXTLX49EI3WpQ+shUDKzFCgeRUX8aal+pzUzidBMMr1Lg+75Lns/knZTiZFu0w63etqT3ZCcTz32qQsfHB0kHp5IOTjuztSYcwOF1TcFU5BitSF2cI/jbSi2f3VM86VfxlnNxt5fsZuMSGergl6ageOHgiwshUvooIVfU3jiOgC4d2EwA7UNrxkKkLH06zFFTbCfFQBdODOVD6jR3J8/l48rSkgIuelQffUE2Di/chdvb+/uPP/+Cw18nhydHHw9/mR582NsbwyTQIFB7QhQ64ElX8wyWz3JifNrmr3AFukS3IMhpLs0tJ93aM7K02dQZRCcVJhs5rOhbJr3F8o4pvx7RmYzpmke1ReMkY5LcuhPsuerAqxbKjWRVJsqRbbWV7SxTIk2JWK9zjHQW7GYjjz83FFZt20hbVC6KOp9tMlUSFhSSXD/RSoC2kAdTwSXDbSP47vSUTdZHHGhNNX9z7GzHjJPj06nKVN71rUq25bEKeKWy9DtWKlM+UZg6Unq2VhbdosGFjG3nlOsfJUWINg==
sidebar_class_name: "post api-method"
info_path: docs/api-experimental/llama-stack-specification-experimental-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Cancel a training job."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1alpha/post-training/job/cancel"}
context={"endpoint"}
>
</MethodEndpoint>
Cancel a training job.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"job_uuid":{"type":"string","description":"The UUID of the job to cancel."}},"additionalProperties":false,"required":["job_uuid"],"title":"CancelTrainingJobRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

68
docs/docs/api-experimental/create-a-new-session-for-an-agent.api.mdx Normal file
View file

@ -0,0 +1,68 @@
---
id: create-a-new-session-for-an-agent
title: "Create a new session for an agent."
description: "Create a new session for an agent."
sidebar_label: "Create a new session for an agent."
hide_title: true
hide_table_of_contents: true
api: eJztWM1uGzcQfpUBT4mxkpwgQRrdlMRFDSSNIMtAC1soRuRIy2SXXJNcyYKgZ+mxQJ+uj1AMuWutI7txilwCWBfLu+T8fd835GgrHPnKGk9eDLfi+fEx/1HkpdNV0NaIoRgZGC3JhDPyXlvz1hEGmjTb+iIT0ppAJvBOrKpCS+Sdg0+et2+FlzmVyN/CpiIxFHb+iWQQmaicrcgFnZz7ZP8PrTprfXDaLEX2RUznRl/VBFqRCXqhycHCOgg5gYzhKWisid0uE6iU5o1YjDseF1h4yoSjq1o7UmJ40Q1hlomgQ8Ex3J/9QVztC3AUamdIwTonk4LSZgkIhtaAbLCNsC92Ow7yxV21n+Zs6qomH2CNHrRZYaEVWAclFgvrSlLfEYGAofadddoEWpI7SPOX6XQMaTVIq0jsbqr1NeROnGOkeHEGCD63LoCvyxLdBuwiYkhxzTrXMgedknYaTYggo2neRz87th9QFw/1nFaz68KaJTnI6xJNzxEqnBcEnT23wmFP2viARj4gyycfq0S4pzCC88n7JhmJBuYEtScFwTJJnKYVQWkdgTaMZ0QOcG7rEJ37iqReaAlWyto5MpK+iOubCJ4QbtG6KV6H7bFM9xSvbRawcLaMMYzGp32Y2HqZFxtY2KKwaw+Tn9/Cq5+OX/W5aHSNZZWY0fLrxfHx3t8bVDBJFN/H80DmN8p5/vpu5chCs9By9OD5S7AWSjSb1jBbBYSlXpEBLG1tQqytLulRVI+i+sFE9fz13t/UWvjATG+U5bvS+t3WkOOKgK4lkeKysdgwEBS61KEP44LQEwS3AVyiNlBgINeeVC/vO6k8uRU5ICNZSuRIMbFqQ9cVST6UqSnDo7QepfUDSetl97w6ZWYbLOAssX3vv5HX6JDybTFUHz7WDgJhGU+lOZEBY+MVVrXyUrTAugh3XsTvNfwoqkdR/ViiOr7L2wMkFFXCVMOl52zidOY5+NvBpkmtmbiaWavlThzAeHSt0GFJgRyb2gqDJccTX/MQyGiLoagw5AfF4APv9F0LQxrpgm3mz4Ta3in72kMQXE3ZoSAbGu12s7SYfHhj1YZXfOcRO+X5Nf5yhryyzbHN5ybL/v+brqP3DtkSUt0pu50HItC36xa1XjmSPOXfuCkp5FYxVDaOERGxoRisnmFR5TiI8PjBtkV2N2h/H8hEurUkAtSO6ZeHUA0HAzSbXm59INUrCiyx5wPKz31pS8EQeZK102ETN75rm/bFjN8xMJM9hCcd+t+C4AZzZtrCRkyaqrxnl3DGLuGs0X/qCz04ua7I6ZJMwILVx2LmHBJuq2d3QMkt1N9qJthtb11vIccAlbMrrchfGvjig+ApzklkVGW1CR7QxDukdiCtS/1B8c8dfHS4BUryySg6ujSsceti8zs0Pud5r6AVOVy2UX2wigrfvzSX5ujonz//+htOfhufTE4/nPw6Hb0/OhrC2FHPUbq0cjngSQN8Bqtncwr4NPkvcQMyR7MkmNOC++2cpC05VB+488dmxRwqMQqrQelBveRWxTuSfdjuRoqBrsOgKlAbjiTScduw+UI0SYksdShGfdjpVS2lZ5lg2vKO7XaOns5dsdvx46uaHPN1lol4ms6ZaRdbobTn73s93ZvLk0mjxqfwzQ3wzhSbh2g2zGEsav5PZOIzbbqdeDfbZSInVORixOn12xRXb8pG9tsPWuQua3eMpKQq/OfaWaedjD+eTUUm5k0bLvmaMxQO19zPcZ1CtbFOscHGZ1tRoFnWuOS1ySZ//gVFyn38
sidebar_class_name: "post api-method"
info_path: docs/api-experimental/llama-stack-specification-experimental-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create a new session for an agent."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1alpha/agents/{agent_id}/session"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new session for an agent.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to create the session for.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"session_name":{"type":"string","description":"The name of the session to create."}},"additionalProperties":false,"required":["session_name"],"title":"CreateAgentSessionRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An AgentSessionCreateResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":"string","description":"Unique identifier for the created session"}},"additionalProperties":false,"required":["session_id"],"title":"AgentSessionCreateResponse","description":"Response returned when creating a new agent session."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

68
docs/docs/api-experimental/create-a-new-turn-for-an-agent.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

68
docs/docs/api-experimental/create-an-agent-with-the-given-configuration.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

19
docs/docs/api-experimental/dataset-io.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: dataset-io
title: "DatasetIO"
description: "DatasetIO"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

19
docs/docs/api-experimental/datasets.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: datasets
title: "Datasets"
description: "Datasets"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

68
docs/docs/api-experimental/delete-an-agent-by-its-id-and-its-associated-sessions-and-turns.api.mdx Normal file
View file

@ -0,0 +1,68 @@
---
id: delete-an-agent-by-its-id-and-its-associated-sessions-and-turns
title: "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."
sidebar_label: "Delete an agent by its ID and its associated sessions and turns."
hide_title: true
hide_table_of_contents: true
api: eJztV8FuGzcQ/ZUBT7GxlpwgQRLd3FpFjdq1YTtAC9soRuRIy4RLbshZ2YKw39JjgX5dP6EY7sqSI6f1IZcA1kXUkjPzZuY9zmqpIqU6+ERJjZbq1f6+fBlKOtqabfBqpE5/UW2hXj+2dVkSRPrcUGK4xQTWz9FZAyFChW4aYkVGFUoHz+RZ7LGundUo9sOPSZwsVdIlVSgrXtSkRipMPpJmVag6hpoi2w5dYuQmbZyznmlGURVfwPr58vIMutOggyHBz5YdbdgmjtbPtkzHMYYI+XABCKkMkSE1VYVxAWEKXBJQPnNbWl2C7ZKOFj3DNERA3+/nOK34Z7TuqZG70xLaBT+jCGVTod+LhAYnjmDD5gEciWR9YvT6CVm+OM0rdDtwAB/Oj/tkNHqYEDSJDHCASBwtzQmqEAmsl37mzgFOQsM5eKpJ26nVELRuYiSv6QtcbaHQGNvFO9to6BRdokIJf2wko0ZXqw6vunVfvJv7/nVl+krxVlyGaQxVxnBwdjSA89DMSreAaXAu3CY4/+lHePtu/+1AikZ3WNUdM1b8er2/v473Axo47yi+xvNE5retZP/61fvHlaOdJc9QYoIkCw4BKvSLlWPxCggzOycPWIXGc66trehZVM+i+s5E9er9Ot5lCHAiTO+VlTal9XtooMQ5Ad1pIiNlE7EhEzhbWR7AmSNMBBwXgDO0HhwyxUGvtzdfm1SJ4pwikNciJYpkhFiNp7uaNJPpi/ssrWdpfVfSerM5r46E2R4dXHRsX8fv5XWwTflVMcwATpsITFjlqTQh8uAD26kls5KXoSk2jrcl9l+On0X1LKrvS1T7j0V7goSySoRqOEuSzcGMPCcB/xDsITliEqagnIDJAiwnODoE9CYvMaWgLUqIRCnZ4FPe4yb6NBBhYMSKmKIEWiqPlaDN7v6wIjkrgWrkcqtUMg6PDldN6hBwAJNBie91Qzg2VGzLsydV2+bM6khakN43tCIug1Ej1bnMaLlUIzWcv0RXlzjMQdNwucLbqkJ1E7pLp4lS6pK5Hg2H6Bd7ZUhMZs85rHAvMepPAx0qJQAS6SZaXmTDw9UFdXUje0LZjLvv5rHYw4XYw0VP3I7QezC+qynaijyjE9oICwVQV7T5y0fqKNpPD1SAm7rcjMYlMtQxzK2hdO3hiw9CovyCT97UwXru212SjaBD7IhtrJ+B3HlxippS5xQjXXshZ4hZtdvOJ/JHxdGcIs5WqE6CIZcG1/7a7+7+8+dff8P4t7Px+dHJ+NfLg+Pd3RGcRdqL1L1tSTngRd+9AuYvJ8S408WvcAG6RD8jmNBULooJ6VAJ1MRyZWWV1SFxhfm277n6DUTwoB/L9ZT5Fr57qjPd8bB2aL1kkXm57Ol8pfqCqKITnjBmdC/Bm0IJa+XccjnBRB+ia1t5/LmhKHS9KVQeHBPh5tVSGZtkvRbSV/N7cd5LdAf+V82PJtI/RL8QlqNr5Jcq1CdabF4j7U1bqJLQUMwIu+0DranmDcOtmS7au78FDsfH48uxatt/AYQrauE=
sidebar_class_name: "delete api-method"
info_path: docs/api-experimental/llama-stack-specification-experimental-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete an agent by its ID and its associated sessions and turns."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1alpha/agents/{agent_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete an agent by its ID and its associated sessions and turns.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

68
docs/docs/api-experimental/delete-an-agent-session-by-its-id-and-its-associated-turns.api.mdx Normal file
View file

@ -0,0 +1,68 @@
---
id: delete-an-agent-session-by-its-id-and-its-associated-turns
title: "Delete an agent session by its ID and its associated turns."
description: "Delete an agent session by its ID and its associated turns."
sidebar_label: "Delete an agent session by its ID and its associated turns."
hide_title: true
hide_table_of_contents: true
api: eJztV9tuGzcQ/ZUBn2JjLTlBgjR6c2sVNeo0huMALWyjGJEjLRMuuSFnFQvCfksfC/Tr+gnFcFcXW07hNH0JYL1otcuZczhzznC1VJFSHXyipEZL9ezwUL4MJR1tzTZ4NVJvflZtoZ7f9+iiJIj0saHE8AkTWD9HZw2ECBW6aYgVGVUoHTyTZ4nHunZWo8QP3ydJslRJl1ShXPGiJjVSYfKeNKtC1THUFNl27BIjN2lrnfVMM4qquEPrp4uLM+hWgw6GhD9bdrQVmzhaP9sJHccYIuTFBSCkMkSG1FQVxgWEKXBJQHnNp9LqEmy36WjRM0xDBPT984zTSn5G6x6K3K0WaBf8jCKUTYX+IBIanDiCrZhbdATJ+sTo9QN2+eRNvkK3B0fw7vy034xGDxOCJpEBDhCJo6U5QRUigfXSz9w5wEloOIOnmrSdWg1B6yZG8pru8GoLhcbYDu9sq6FTdIkKJfqxkYwaXa46vOrWunjX6/51ZfpM8VZahmkMVeZwdHYygPPQzEq3gGlwLnxKcP7jD/Dyu8OXAyka3WBVd8pY6ev54eEG73s0cN5JfMPngcpvW9n982ev7neOdpY8Q4kJklxwCFChX6wSS1ZAmNk5ecAqNJ5zbW1Fj6Z6NNU3ZqpnrzZ4FyHAa1F676y0ba3fQgMlzgnoRhMZKZuYDZnA2cryAM4cYSLguACcofXgkCkOer+9+NxJlSjOKQJ5LVaiSEaE1Xi6qUkzmb64j9Z6tNY3Za0X2+fViSjbo4O3ndo3+L29jnYlvyqGGcCbJgITVvlUmhB58IHt1JJZ2cvQFBvHuxb7t8SPpno01bdlqsP70B5goewSkRrOkuzmaEaek5C/TfaYHDGJUlBWQKKUpKqTBVhOcHIM6E2+xJSCtihQ3ESfBuIJjFgRUxSMpfJY5UZ3OX634jcrKDVyuVMnOQtPjlcdWgFzAJM5Sf5NPzg2VOy6s9dU2xZr9LyPL8Putr5GvsVnGuKXMcklriNpKdVaWRVxGYwaqQ4i145LNVLD+VN0dYnDTCINlyv+7bCnMFxuCtqqQnXvD13FmyhCKJnr0XCIfnFQhsRkDpzDCg8So/4w0KFSwiqRbqLlRQ48Xo3Py2t5JobKm+m1dirx8Fbi4W1vq85uBzC+qSnaijyjE1GLR4RQV9n503uKLZMp3fIobk+NbTQukaGOYW4NpSsPdz4IifLfD/KmDtaLMH1+NbMRdIid7Yz1M5CJHKeoKXVJMdKVF+uEmGfKbvKJ/I1yNKeIsxWr18GQS4Mrf+X39//+48+/YPzr2fj85PX4l4uj0/39EZxFOojUvQtKOeBJ39IC5k8nxLjX4Ve4AF2inxFMaCpjbEI6VEI1sQzUPAPqkLjCfBb1gv46i95qxXJz/H1l2l71TDc8rB1aL9yzGpe9si9VXwZVdJ4UnYy23NkDyt2tiXFdKNGwxC+XE0z0Lrq2ldsfG4oi3utC5UNuIkq9XCpjk1xvvPbZLT857128Bw8YPvdusb+JfiGqR9fIL1WoD7S4PflkIv0PzB4wmv4Dz3UX2uu2UCWhoZhr2T0+0ppq3grceVOSmbEeacfj0/HFWLXtP8nB4Mc=
sidebar_class_name: "delete api-method"
info_path: docs/api-experimental/llama-stack-specification-experimental-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete an agent session by its ID and its associated turns."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1alpha/agents/{agent_id}/session/{session_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete an agent session by its ID and its associated turns.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"session_id","in":"path","description":"The ID of the session to delete.","required":true,"schema":{"type":"string"}},{"name":"agent_id","in":"path","description":"The ID of the agent to delete the session for.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

68
docs/docs/api-experimental/describe-an-agent-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

19
docs/docs/api-experimental/eval.tag.mdx Normal file
View file

@ -0,0 +1,19 @@
---
id: eval
title: "Evaluations"
description: "Evaluations"
custom_edit_url: null
---
Llama Stack Evaluation API for running evaluations on model and agent candidates.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

68
docs/docs/api-experimental/evaluate-a-list-of-rows-on-a-benchmark.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

68
docs/docs/api-experimental/get-a-benchmark-by-its-id.api.mdx Normal file
View file

@ -0,0 +1,68 @@
---
id: get-a-benchmark-by-its-id
title: "Get a benchmark by its ID."
description: "Get a benchmark by its ID."
sidebar_label: "Get a benchmark by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztWMFuGzcQ/ZUBT4mxlpwgQRrdnMZNDdiN4ThAC9swRtyRljGX3JCzsgVB39JjgX5dP6EY7q60smUnBXoJYF0kcYecmcf3hstZqECx8i5SVKOFerm3J185RR1MxcY7NVL78I6cLkoM1wOVKe0dk2Oxw6qyRqPYDb9EMV6oqAsqUX7xvCI1Un78hTSrTFXBVxTYNK5MTo7NxFDo2UYOxk3VMhnPTE7hKlD0ddB0ZfLHDR943gzcfZApcnWpRueq9DlZlalYGLK5ytSMNPtwFdkHUpnKkTGSxB+1l7lXk9rpBE2mxh0wKlPsvW2/rqbB11WTclmxukyoRVajjRk5TbC290f74J8VBB0EIDlkgPYG5xHWc5arKLeCcHfJwxXy4CfABUE7G9hDHQkmPqThlQegGdo67bM4uwtE7PnEEHCuMmWYyrh1QzaDOTKRJYx2TejWhDU/osQlVJtDXiejzXBKYpQMtnEO89yIHdqTDfZ5Rx8nanS+muFqa9UyW/0fe28JXX/I1eWYQn9kldSd9HsDbSTLy3uZH7dht3Cb2EsLGOO1Wi4fSmCCNlKmAn2tTaBceNzT06YoWglscGTbHvaAvMwUG7YS/7sHmbnf48eKoZJLl4abQhIXVBQmPpToNA3UcilpvdpWaBquf60pMtxgBONmaE0OPkCJVpag/P8rQJGR6z5FjWOaJvg2w/r17OwEGmvQPqdUVRp4viW1gxBkc8U4A4RY+MAQ67LEMO/ER8nmpjC6ANMkHQw6Tliia58nP4lDjMZ+r+fGWlxb76YUoKhLdLuBMMexJejN2QhHPBkXWbbs276efawaij6Hffh8etQmo9HBmKSi5KLgQBwMzQhKHwiMS5RInnHsa07OY0XaTIwGr3UdAjlNd+L6L5Jod7jbrRV4PXonmB4ArzsZYRJ8mWLYPzkcwKmvp4Wdw8Rb628inP7yM7z5ae/NQECjWyyrhhkdv17t7fXkhDmcNhRfx/OdzG+V8/LtduVoa8gxFBghyg/2Hkp0825hWRUQpmZGDrD0tUuFl01JT6J6EtUPJqqXb9f+zryHY2F6q6zYl9YfvoYCZwR0q4lygU3EhkxgTWl4ACeWMBJwmANO0TiwyBS6k+r1QydVpDCjAOS0SIkC5UKs2tFtRZopb8F9ktaTtH4oab3un1eHwmyHFj41bF/7b+W1f5/yHRj5AD7WAZiwTKfSmMiB8+klNe/ktboD3bt1PrLwk6ieRPVjiWpvm7fvkFBSiVANp1GyWV3HoiSwGfAHYsDepWw8B8MRDt9L16bCgCUxhZhuvQ5L6vcdmkuhkWUq5GJrG+LwfbcNax/sYUosDtaYc6gpu6/A7rK8TIFXgTSymLd7VhIXPlcjNU3NlhTFSA1nL9BWBQ7lUjlc+Y3DRT/0pVxoU4FqsquD4FowV6PhEN18t/CRKd+1FkvcjYz6eqB9qSSUSLoOhudp4vuuGp1fyjPhZ8qg3bojmQ+fZD58alnasHcXDm4rCqYkx2iFIzG1kkJs8Ju92AKpCD1uUB77Iux74wIZ2lt9vHBw54Mg7Rs/AXJ55Y3jCOjSm44JoH1oWJzLlVwKXJigptgsioEunDDRhyTR+4uP5VZiaUYBp11Ux3Kxj4MLd+F2dv7586+/4eD3k4PTw+OD3872j3Z2RnASaDdQ82olcMCzdiszmL0YE+Pzxn+Jc9AFuqnQaiJVYUzalxJqZKlPSVKVj1xiKu0tdR9l+wbSi/Vh8fislqhMtzysLJrUXUpcWrR8PFdtEtJAnKHttwBlw0cbgrrMlBBPpi0WY4z0OdjlUoa/1hSEcZeZSoV+LPQ6X6jcRPm9VsWDiTw7bfX2HL6tza2JdR0rJ+06adnIP5Wpa5rfrQype1UQ5tKsPV+0JvtaU8W9yfcOYtHQStcfDs7UcvkvnLDWCg==
sidebar_class_name: "get api-method"
info_path: docs/api-experimental/llama-stack-specification-experimental-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get a benchmark by its ID."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1alpha/eval/benchmarks/{benchmark_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a benchmark by its ID.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"benchmark_id","in":"path","description":"The ID of the benchmark to get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Benchmark.","content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string"},"provider_resource_id":{"type":"string"},"provider_id":{"type":"string"},"type":{"type":"string","enum":["model","shield","vector_store","dataset","scoring_function","benchmark","tool","tool_group","prompt"],"const":"benchmark","default":"benchmark","description":"The resource type, always benchmark"},"dataset_id":{"type":"string","description":"Identifier of the dataset to use for the benchmark evaluation"},"scoring_functions":{"type":"array","items":{"type":"string"},"description":"List of scoring function identifiers to apply during evaluation"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Metadata for this evaluation task"}},"additionalProperties":false,"required":["identifier","provider_id","type","dataset_id","scoring_functions","metadata"],"title":"Benchmark","description":"A benchmark resource for evaluating model performance."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

68
docs/docs/api-experimental/get-a-dataset-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

75
docs/docs/api-experimental/get-a-paginated-list-of-rows-from-a-dataset.api.mdx Normal file
View file

@ -0,0 +1,75 @@
---
id: get-a-paginated-list-of-rows-from-a-dataset
title: "Get a paginated list of rows from a dataset."
description: "Get a paginated list of rows from a dataset."
sidebar_label: "Get a paginated list of rows from a dataset."
hide_title: true
hide_table_of_contents: true
api: eJztWVFPHDcQ/isjPxF0d0CUqM290YamSCQgQtRWAUVzu3O7Trz2xp49OKH7LX2s1F/Xn1CNvXu3cBcCVaQqErzAGdvzzcz3zdi+a+Up1M4GCmp8rZ7u7sqvnELmdc3aWTVW+3CChbbIlJ+2k0dqoDJnmSzLfKxrozOU+Tsfgyy6ViErqUL5i+c1qbFyk4+UsRqo2ruaPOtkMkfuz0Lvca4GSjNVYdNqzHMthtCc3NjHWTqeqvH75QrbGKMWg+XniXOG0PaHbFNNyPdHAntti/5IAtQbaJEsLhaLwa1InZUERgcGN4XoAEydBy4JssZ7sgw1FqQWA1Vi+FA5Tz0PO3y3N/2tJC4pbuMJ0BPIwnZ/nKE2ODEEOOU4SQcIxGKj8aa3fevZJsjvTo8iUMwyCkHbIm0jnihxcnPIp2gCDZSnz432lKvx+5TLnnMXA8WajZhfo9Aakn0oyJLXmQQpzYWOnMAlMkydMe4yAELQVW1IQFfII7VYCMxnm8gr/glECgyXGEDbGRqdg/NQoZENKP92ZA6M3PRpqy1TQX7N2V/Pzk4gzYbM5ZETbai+lrED74VUMnkgoSidZwhNVaGfC/GEbhTnXJY6K0Enp71GyynNtv1/tBNJzKjvwZVkOc0W08bZgjyUTYV26AnzSMTemhtwxJK2gdFm9/By67hOlHsC+5GgyZkMLUwImkA5sANP7DXNOknYRAixjBPXcDQeasr0VGfgsqTCjG7hegjF2wx32VoGr0f1GKYvBG9J6Kl3VcSwf3I4glPXFKWZLxl++svP8MOPuz+MJGh0hcL2Pr+e7e6u7P2EOZwmiq/w3JP5rXKevtisnMxoqVolSlGxDOwcVGjn3cayKyAUekYWsHKNjbWPdUWPonoU1XcmqqcvVvbOnIPXwvRWWaEvrT9cAyXOCOgqI8olbCI2ZGn/leYRnBhCaVt+DligtmCQyXed6vmXOlUgPyMPZDOREnnKhViNpauaMmmI1IbhUVqP0vqOpPW8368OhdkWDbxNbF/Zb+W1v075Lhj5CI4bD0xYxa40IbJgHeuppryTV05TbAxvuMncsfGjqB5F9X2JaneTtXtIKKpEqIZFEG9eImMgPjwW/DfxviIG7N3HusutF3wRPUKelo/O7btAAdx0GoiHE5TstCslF5dyfR2f26Ew3vMHbXO6GkPsejIg1844Blu7afWTERxO4Y2zNEhTWpMTKrS12hYj2S023DG8iVf51cU78aLxdrmJHHyHe4N2OAAak+aOzu25TaflNi/aZqbJKUS44t8Yjr56rY9ouqvvGP7TtV3eVWr0WBGTD/E1w2IlGW6j/EFLodKSmxq53HidP3zZUbtdJMEoKAlhmTkxteI0+4YG6xWuew6R548WSC97HZLPDfn5GpTDmExt2S1xdGGbah9YoLTIRhCJZkyCp1PCbiJsZbgGsSuufYyRE3ejk0DZJWei2RbLA61GzdSeMhHIckFFXLpcjVVBsUFIrsZqZ7Y3IcadNh7a7WgWbV6GnetVghdqoNJBMDEgvuOokrke7+ygnQ9LF5jyoTFY4TAwZp9GmauUQAmUNV7zPC582fXB9xfyP6mM0YW2aBzJengr6+FtWx+TVodwcFWT1xVZRiPVSYqdAErBm+1tiKe0mHCj2GK//Petxdec2ruZzimcW7j1gyIFWUc2r522HABtPGNrD5nzSad5qhhMfooZhbQpejq3UgOdj81hffOJ3IcNzchj0aF67XIyqQ5sb//z519/w8HvJwenh68P3pztH21vj+HE09BTOtRLOGBrtoemLnEAKadPkv0K55CVaAuCCU1F8BPKXCVQA4vgYzGvXeAK46GiZexDCu3t2F+vDi6PBft/KNhtSWC64p3aoLa9x9ck/PcqkUQy10k/vXFH8auBGvfq+8VAicJl2fW1BPadN4uFDKdSJtLOdRA0q4LzRUZ8kzK80cVPNF/rBzM0jcyMD+b3B3lnNb7DeFfoV2Yv5IPXYveBgdo6bav+E3hYF92Ir/v2wM778DrcvWwvLuTrAMKcfAScJuxnGdV9z9YuJOLpssu8OjhTi8W/3wABPQ==
sidebar_class_name: "get api-method"
info_path: docs/api-experimental/llama-stack-specification-experimental-apis
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get a paginated list of rows from a dataset."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1beta/datasetio/iterrows/{dataset_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a paginated list of rows from a dataset.
Uses offset-based pagination where:
- start_index: The starting index (0-based). If None, starts from beginning.
- limit: Number of items to return. If None or -1, returns all items.
The response includes:
- data: List of items for the current page.
- has_more: Whether there are more items available after this set.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"dataset_id","in":"path","description":"The ID of the dataset to get the rows from.","required":true,"schema":{"type":"string"}},{"name":"start_index","in":"query","description":"Index into dataset for the first row to get. Get all rows if None.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The number of rows to get.","required":false,"schema":{"type":"integer"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A PaginatedResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The list of items for the current page"},"has_more":{"type":"boolean","description":"Whether there are more items available after this set"},"url":{"type":"string","description":"The URL for accessing this list"}},"additionalProperties":false,"required":["data","has_more"],"title":"PaginatedResponse","description":"A generic paginated response that follows a simple format."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>
</StatusCodes>

Some files were not shown because too many files have changed in this diff Show more