phoenix-oss/llama-stack
1
0
Fork 0
forked from phoenix-oss/llama-stack-mirror
Code Pull requests Releases Packages 2 Activity Actions

Fix the OpenAPI HTML

Browse source
This commit is contained in:
Ashwin Bharambe 2025-02-04 10:38:49 -08:00
parent c9ab72fa82
commit b17277b06a
5 changed files with 250 additions and 120 deletions
Download patch file Download diff file Expand all files Collapse all files

144
docs/resources/llama-stack-spec.yaml
View file

@ -21,6 +21,7 @@ paths:
$ref: '#/components/schemas/PaginatedRowsResult'
tags:
- DatasetIO
description: ''
parameters:
- name: dataset_id
in: query
@ -48,6 +49,7 @@ paths:
description: OK
tags:
- DatasetIO
description: ''
parameters: []
requestBody:
content:
@ -66,6 +68,7 @@ paths:
$ref: '#/components/schemas/BatchChatCompletionResponse'
tags:
- BatchInference (Coming Soon)
description: ''
parameters: []
requestBody:
content:
@ -84,6 +87,7 @@ paths:
$ref: '#/components/schemas/BatchCompletionResponse'
tags:
- BatchInference (Coming Soon)
description: ''
parameters: []
requestBody:
content:
@ -98,6 +102,7 @@ paths:
description: OK
tags:
- PostTraining (Coming Soon)
description: ''
parameters: []
requestBody:
content:
@ -121,7 +126,7 @@ paths:
$ref: '#/components/schemas/ChatCompletionResponseStreamChunk'
tags:
- Inference
summary: >-
description: >-
Generate a chat completion for the given messages using the specified model.
parameters: []
requestBody:
@ -146,7 +151,7 @@ paths:
$ref: '#/components/schemas/CompletionResponseStreamChunk'
tags:
- Inference
summary: >-
description: >-
Generate a completion for the given content using the specified model.
parameters: []
requestBody:
@ -166,6 +171,7 @@ paths:
$ref: '#/components/schemas/AgentCreateResponse'
tags:
- Agents
description: ''
parameters: []
requestBody:
content:
@ -184,6 +190,7 @@ paths:
$ref: '#/components/schemas/AgentSessionCreateResponse'
tags:
- Agents
description: ''
parameters:
- name: agent_id
in: path
@ -212,6 +219,7 @@ paths:
$ref: '#/components/schemas/AgentTurnResponseStreamChunk'
tags:
- Agents
description: ''
parameters:
- name: agent_id
in: path
@ -236,6 +244,7 @@ paths:
description: OK
tags:
- Agents
description: ''
parameters:
- name: agent_id
in: path
@ -253,6 +262,7 @@ paths:
$ref: '#/components/schemas/Session'
tags:
- Agents
description: ''
parameters:
- name: session_id
in: path
@ -277,6 +287,7 @@ paths:
description: OK
tags:
- Agents
description: ''
parameters:
- name: session_id
in: path
@ -302,7 +313,7 @@ paths:
$ref: '#/components/schemas/EmbeddingsResponse'
tags:
- Inference
summary: >-
description: >-
Generate embeddings for content pieces using the specified model.
parameters: []
requestBody:
@ -322,6 +333,7 @@ paths:
$ref: '#/components/schemas/EvaluateResponse'
tags:
- Eval
description: ''
parameters:
- name: task_id
in: path
@ -345,6 +357,7 @@ paths:
$ref: '#/components/schemas/AgentStepResponse'
tags:
- Agents
description: ''
parameters:
- name: agent_id
in: path
@ -377,6 +390,7 @@ paths:
$ref: '#/components/schemas/Turn'
tags:
- Agents
description: ''
parameters:
- name: agent_id
in: path
@ -406,6 +420,7 @@ paths:
- type: 'null'
tags:
- Datasets
description: ''
parameters:
- name: dataset_id
in: path
@ -418,6 +433,7 @@ paths:
description: OK
tags:
- Datasets
description: ''
parameters:
- name: dataset_id
in: path
@ -437,6 +453,7 @@ paths:
- type: 'null'
tags:
- EvalTasks
description: ''
parameters:
- name: eval_task_id
in: path
@ -456,6 +473,7 @@ paths:
- type: 'null'
tags:
- Models
description: ''
parameters:
- name: model_id
in: path
@ -468,6 +486,7 @@ paths:
description: OK
tags:
- Models
description: ''
parameters:
- name: model_id
in: path
@ -487,6 +506,7 @@ paths:
- type: 'null'
tags:
- ScoringFunctions
description: ''
parameters:
- name: scoring_fn_id
in: path
@ -506,6 +526,7 @@ paths:
- type: 'null'
tags:
- Shields
description: ''
parameters:
- name: identifier
in: path
@ -523,6 +544,7 @@ paths:
$ref: '#/components/schemas/Span'
tags:
- Telemetry
description: ''
parameters:
- name: trace_id
in: path
@ -545,6 +567,7 @@ paths:
$ref: '#/components/schemas/QuerySpanTreeResponse'
tags:
- Telemetry
description: ''
parameters:
- name: span_id
in: path
@ -574,6 +597,7 @@ paths:
$ref: '#/components/schemas/Tool'
tags:
- ToolGroups
description: ''
parameters:
- name: tool_name
in: path
@ -591,6 +615,7 @@ paths:
$ref: '#/components/schemas/ToolGroup'
tags:
- ToolGroups
description: ''
parameters:
- name: toolgroup_id
in: path
@ -603,7 +628,7 @@ paths:
description: OK
tags:
- ToolGroups
summary: Unregister a tool group
description: Unregister a tool group
parameters:
- name: toolgroup_id
in: path
@ -621,6 +646,7 @@ paths:
$ref: '#/components/schemas/Trace'
tags:
- Telemetry
description: ''
parameters:
- name: trace_id
in: path
@ -640,6 +666,7 @@ paths:
- type: 'null'
tags:
- PostTraining (Coming Soon)
description: ''
parameters:
- name: job_uuid
in: query
@ -659,6 +686,7 @@ paths:
- type: 'null'
tags:
- PostTraining (Coming Soon)
description: ''
parameters:
- name: job_uuid
in: query
@ -676,6 +704,7 @@ paths:
$ref: '#/components/schemas/ListPostTrainingJobsResponse'
tags:
- PostTraining (Coming Soon)
description: ''
parameters: []
/v1/vector-dbs/{vector_db_id}:
get:
@ -690,6 +719,7 @@ paths:
- type: 'null'
tags:
- VectorDBs
description: ''
parameters:
- name: vector_db_id
in: path
@ -702,6 +732,7 @@ paths:
description: OK
tags:
- VectorDBs
description: ''
parameters:
- name: vector_db_id
in: path
@ -719,6 +750,7 @@ paths:
$ref: '#/components/schemas/HealthInfo'
tags:
- Inspect
description: ''
parameters: []
/v1/tool-runtime/rag-tool/insert:
post:
@ -727,7 +759,7 @@ paths:
description: OK
tags:
- ToolRuntime
summary: >-
description: >-
Index documents so they can be used by the RAG system
parameters: []
requestBody:
@ -743,6 +775,7 @@ paths:
description: OK
tags:
- VectorIO
description: ''
parameters: []
requestBody:
content:
@ -761,7 +794,7 @@ paths:
$ref: '#/components/schemas/ToolInvocationResult'
tags:
- ToolRuntime
summary: Run a tool with the given arguments
description: Run a tool with the given arguments
parameters: []
requestBody:
content:
@ -782,6 +815,7 @@ paths:
- type: 'null'
tags:
- Eval
description: ''
parameters:
- name: task_id
in: path
@ -799,6 +833,7 @@ paths:
description: OK
tags:
- Eval
description: ''
parameters:
- name: task_id
in: path
@ -821,6 +856,7 @@ paths:
$ref: '#/components/schemas/EvaluateResponse'
tags:
- Eval
description: ''
parameters:
- name: job_id
in: path
@ -843,6 +879,7 @@ paths:
$ref: '#/components/schemas/ListDatasetsResponse'
tags:
- Datasets
description: ''
parameters: []
post:
responses:
@ -850,6 +887,7 @@ paths:
description: OK
tags:
- Datasets
description: ''
parameters: []
requestBody:
content:
@ -868,6 +906,7 @@ paths:
$ref: '#/components/schemas/ListEvalTasksResponse'
tags:
- EvalTasks
description: ''
parameters: []
post:
responses:
@ -875,6 +914,7 @@ paths:
description: OK
tags:
- EvalTasks
description: ''
parameters: []
requestBody:
content:
@ -893,6 +933,7 @@ paths:
$ref: '#/components/schemas/ListModelsResponse'
tags:
- Models
description: ''
parameters: []
post:
responses:
@ -904,6 +945,7 @@ paths:
$ref: '#/components/schemas/Model'
tags:
- Models
description: ''
parameters: []
requestBody:
content:
@ -922,6 +964,7 @@ paths:
$ref: '#/components/schemas/ListProvidersResponse'
tags:
- Inspect
description: ''
parameters: []
/v1/inspect/routes:
get:
@ -934,6 +977,7 @@ paths:
$ref: '#/components/schemas/ListRoutesResponse'
tags:
- Inspect
description: ''
parameters: []
/v1/tool-runtime/list-tools:
get:
@ -946,6 +990,7 @@ paths:
$ref: '#/components/schemas/ToolDef'
tags:
- ToolRuntime
description: ''
parameters:
- name: tool_group_id
in: query
@ -968,6 +1013,7 @@ paths:
$ref: '#/components/schemas/ListScoringFunctionsResponse'
tags:
- ScoringFunctions
description: ''
parameters: []
post:
responses:
@ -975,6 +1021,7 @@ paths:
description: OK
tags:
- ScoringFunctions
description: ''
parameters: []
requestBody:
content:
@ -993,6 +1040,7 @@ paths:
$ref: '#/components/schemas/ListShieldsResponse'
tags:
- Shields
description: ''
parameters: []
post:
responses:
@ -1004,6 +1052,7 @@ paths:
$ref: '#/components/schemas/Shield'
tags:
- Shields
description: ''
parameters: []
requestBody:
content:
@ -1022,7 +1071,7 @@ paths:
$ref: '#/components/schemas/ListToolGroupsResponse'
tags:
- ToolGroups
summary: List tool groups with optional provider
description: List tool groups with optional provider
parameters: []
post:
responses:
@ -1030,7 +1079,7 @@ paths:
description: OK
tags:
- ToolGroups
summary: Register a tool group
description: Register a tool group
parameters: []
requestBody:
content:
@ -1049,7 +1098,7 @@ paths:
$ref: '#/components/schemas/ListToolsResponse'
tags:
- ToolGroups
summary: List tools with optional tool group
description: List tools with optional tool group
parameters:
- name: toolgroup_id
in: query
@ -1067,6 +1116,7 @@ paths:
$ref: '#/components/schemas/ListVectorDBsResponse'
tags:
- VectorDBs
description: ''
parameters: []
post:
responses:
@ -1078,6 +1128,7 @@ paths:
$ref: '#/components/schemas/VectorDB'
tags:
- VectorDBs
description: ''
parameters: []
requestBody:
content:
@ -1092,6 +1143,7 @@ paths:
description: OK
tags:
- Telemetry
description: ''
parameters: []
requestBody:
content:
@ -1110,6 +1162,7 @@ paths:
$ref: '#/components/schemas/PostTrainingJob'
tags:
- PostTraining (Coming Soon)
description: ''
parameters: []
requestBody:
content:
@ -1128,7 +1181,7 @@ paths:
$ref: '#/components/schemas/RAGQueryResult'
tags:
- ToolRuntime
summary: >-
description: >-
Query the RAG system for context; typically invoked by the agent
parameters: []
requestBody:
@ -1148,6 +1201,7 @@ paths:
$ref: '#/components/schemas/QueryChunksResponse'
tags:
- VectorIO
description: ''
parameters: []
requestBody:
content:
@ -1166,6 +1220,7 @@ paths:
$ref: '#/components/schemas/QuerySpansResponse'
tags:
- Telemetry
description: ''
parameters:
- name: attribute_filters
in: query
@ -1197,6 +1252,7 @@ paths:
$ref: '#/components/schemas/QueryTracesResponse'
tags:
- Telemetry
description: ''
parameters:
- name: attribute_filters
in: query
@ -1233,6 +1289,7 @@ paths:
$ref: '#/components/schemas/Job'
tags:
- Eval
description: ''
parameters:
- name: task_id
in: path
@ -1256,6 +1313,7 @@ paths:
$ref: '#/components/schemas/RunShieldResponse'
tags:
- Safety
description: ''
parameters: []
requestBody:
content:
@ -1270,6 +1328,7 @@ paths:
description: OK
tags:
- Telemetry
description: ''
parameters: []
requestBody:
content:
@ -1288,6 +1347,7 @@ paths:
$ref: '#/components/schemas/ScoreResponse'
tags:
- Scoring
description: ''
parameters: []
requestBody:
content:
@ -1306,6 +1366,7 @@ paths:
$ref: '#/components/schemas/ScoreBatchResponse'
tags:
- Scoring
description: ''
parameters: []
requestBody:
content:
@ -1324,6 +1385,7 @@ paths:
$ref: '#/components/schemas/PostTrainingJob'
tags:
- PostTraining (Coming Soon)
description: ''
parameters: []
requestBody:
content:
@ -1342,6 +1404,7 @@ paths:
$ref: '#/components/schemas/SyntheticDataGenerationResponse'
tags:
- SyntheticDataGeneration (Coming Soon)
description: ''
parameters: []
requestBody:
content:
@ -1360,6 +1423,7 @@ paths:
$ref: '#/components/schemas/VersionInfo'
tags:
- Inspect
description: ''
parameters: []
jsonSchemaDialect: >-
https://json-schema.org/draft/2020-12/schema
@ -1423,7 +1487,7 @@ components:
- content
- stop_reason
- tool_calls
title: >-
description: >-
A message containing the model's (assistant) response in a chat conversation.
GrammarResponseFormat:
type: object
@ -1450,7 +1514,7 @@ components:
required:
- type
- bnf
title: >-
description: >-
Configuration for grammar-guided response generation.
GreedySamplingStrategy:
type: object
@ -1490,7 +1554,7 @@ components:
required:
- type
- image
title: A image content item
description: A image content item
InterleavedContent:
oneOf:
- type: string
@ -1533,7 +1597,7 @@ components:
required:
- type
- json_schema
title: >-
description: >-
Configuration for JSON schema-guided response generation.
Message:
oneOf:
@ -1601,7 +1665,7 @@ components:
required:
- role
- content
title: >-
description: >-
A system message providing instructions or context to the model.
TextContentItem:
type: object
@ -1619,7 +1683,7 @@ components:
required:
- type
- text
title: A text content item
description: A text content item
ToolCall:
type: object
properties:
@ -1738,7 +1802,7 @@ components:
- call_id
- tool_name
- content
title: >-
description: >-
A message representing the result of a tool invocation.
TopKSamplingStrategy:
type: object
@ -1798,7 +1862,7 @@ components:
required:
- role
- content
title: >-
description: >-
A message from the user in a chat conversation.
BatchChatCompletionRequest:
type: object
@ -1822,7 +1886,7 @@ components:
enum:
- auto
- required
title: >-
description: >-
Whether tool use is required or automatic. This is a hint to the model
which may not be followed. It depends on the Instruction Following capabilities
of the model.
@ -1832,7 +1896,7 @@ components:
- json
- function_tag
- python_list
title: >-
description: >-
Prompt format for calling custom / zero shot tools.
response_format:
$ref: '#/components/schemas/ResponseFormat'
@ -1874,7 +1938,7 @@ components:
additionalProperties: false
required:
- completion_message
title: Response from a chat completion request.
description: Response from a chat completion request.
TokenLogProbs:
type: object
properties:
@ -1887,7 +1951,7 @@ components:
additionalProperties: false
required:
- logprobs_by_token
title: Log probabilities for generated tokens.
description: Log probabilities for generated tokens.
BatchCompletionRequest:
type: object
properties:
@ -1947,7 +2011,7 @@ components:
required:
- content
- stop_reason
title: Response from a completion request.
description: Response from a completion request.
CancelTrainingJobRequest:
type: object
properties:
@ -1964,9 +2028,9 @@ components:
enum:
- auto
- required
default: auto
description: >-
(Optional) Whether tool use is required or automatic. Defaults to ToolChoice.auto.
default: auto
tool_prompt_format:
type: string
enum:
@ -1985,17 +2049,17 @@ components:
enum:
- append
- replace
default: append
description: >-
(Optional) Config for how to override the default system prompt. - `SystemMessageBehavior.append`:
Appends the provided system message to the default system prompt. - `SystemMessageBehavior.replace`:
Replaces the default system prompt with the provided system message. The
system message can include the string '{{function_definitions}}' to indicate
where the function definitions should be inserted.
default: append
additionalProperties: false
required:
- system_message_behavior
title: Configuration for tool use.
description: Configuration for tool use.
ChatCompletionRequest:
type: object
properties:
@ -2105,7 +2169,7 @@ components:
required:
- event_type
- delta
title: >-
description: >-
An event during chat completion generation.
ChatCompletionResponseStreamChunk:
type: object
@ -2116,7 +2180,7 @@ components:
additionalProperties: false
required:
- event
title: >-
description: >-
A chunk of a streamed chat completion response.
ContentDelta:
oneOf:
@ -2243,7 +2307,7 @@ components:
additionalProperties: false
required:
- delta
title: >-
description: >-
A chunk of a streamed completion response.
AgentConfig:
type: object
@ -2271,7 +2335,7 @@ components:
enum:
- auto
- required
title: >-
description: >-
Whether tool use is required or automatic. This is a hint to the model
which may not be followed. It depends on the Instruction Following capabilities
of the model.
@ -2282,7 +2346,7 @@ components:
- json
- function_tag
- python_list
title: >-
description: >-
Prompt format for calling custom / zero shot tools.
max_infer_iters:
type: integer
@ -2656,7 +2720,7 @@ components:
- output_message
- output_attachments
- started_at
title: >-
description: >-
A single turn in an interaction with an Agentic System.
ViolationLevel:
type: string
@ -2785,7 +2849,7 @@ components:
additionalProperties: false
required:
- event
title: streamed agent turn completion response.
description: streamed agent turn completion response.
AgentTurnResponseTurnCompletePayload:
type: object
properties:
@ -2848,7 +2912,7 @@ components:
additionalProperties: false
required:
- embeddings
title: >-
description: >-
Response containing generated embeddings.
AgentCandidate:
type: object
@ -3105,7 +3169,7 @@ components:
- session_name
- turns
- started_at
title: >-
description: >-
A single session of an interaction with an Agentic System.
AgentStepResponse:
type: object
@ -3455,7 +3519,7 @@ components:
- provider_resource_id
- provider_id
- type
title: >-
description: >-
A safety shield resource that can be used to check content
Span:
type: object
@ -3653,7 +3717,7 @@ components:
required:
- job_uuid
- checkpoints
title: Artifacts of a finetuning job.
description: Artifacts of a finetuning job.
JobStatus:
type: string
enum:
@ -3696,7 +3760,7 @@ components:
- job_uuid
- status
- checkpoints
title: Status of a finetuning job.
description: Status of a finetuning job.
ListPostTrainingJobsResponse:
type: object
properties:
@ -4911,7 +4975,7 @@ components:
- top_p
- top_k_top_p
- sigmoid
title: The type of filtering function.
description: The type of filtering function.
model:
type: string
additionalProperties: false
@ -4946,7 +5010,7 @@ components:
additionalProperties: false
required:
- synthetic_data
title: >-
description: >-
Response from the synthetic data generation. Batch of (prompt, response, score)
tuples that pass the threshold.
VersionInfo: