mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 04:04:14 +00:00
push updated docs from pre-commit
Signed-off-by: Yuval Turgeman <yturgema@redhat.com>
This commit is contained in:
Yuval Turgeman
parent
3baca53eba
commit
41e72d7d6a
5 changed files with 246 additions and 238 deletions
252
docs/_static/llama-stack-spec.html
vendored
252
docs/_static/llama-stack-spec.html
vendored
|
|
@ -8196,6 +8196,12 @@
|
|||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPCall"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPListTools"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseInputFunctionToolCallOutput"
|
||||
},
|
||||
|
|
@ -8841,6 +8847,129 @@
|
|||
"title": "OpenAIResponseOutputMessageFunctionToolCall",
|
||||
"description": "Function tool call output message for OpenAI responses."
|
||||
},
|
||||
"OpenAIResponseOutputMessageMCPCall": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for this MCP call"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "mcp_call",
|
||||
"default": "mcp_call",
|
||||
"description": "Tool call type identifier, always \"mcp_call\""
|
||||
},
|
||||
"arguments": {
|
||||
"type": "string",
|
||||
"description": "JSON string containing the MCP call arguments"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the MCP method being called"
|
||||
},
|
||||
"server_label": {
|
||||
"type": "string",
|
||||
"description": "Label identifying the MCP server handling the call"
|
||||
},
|
||||
"error": {
|
||||
"type": "string",
|
||||
"description": "(Optional) Error message if the MCP call failed"
|
||||
},
|
||||
"output": {
|
||||
"type": "string",
|
||||
"description": "(Optional) Output result from the successful MCP call"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type",
|
||||
"arguments",
|
||||
"name",
|
||||
"server_label"
|
||||
],
|
||||
"title": "OpenAIResponseOutputMessageMCPCall",
|
||||
"description": "Model Context Protocol (MCP) call output message for OpenAI responses."
|
||||
},
|
||||
"OpenAIResponseOutputMessageMCPListTools": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for this MCP list tools operation"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "mcp_list_tools",
|
||||
"default": "mcp_list_tools",
|
||||
"description": "Tool call type identifier, always \"mcp_list_tools\""
|
||||
},
|
||||
"server_label": {
|
||||
"type": "string",
|
||||
"description": "Label identifying the MCP server providing the tools"
|
||||
},
|
||||
"tools": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"input_schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "null"
|
||||
},
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "object"
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "JSON schema defining the tool's input parameters"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the tool"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "(Optional) Description of what the tool does"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"input_schema",
|
||||
"name"
|
||||
],
|
||||
"title": "MCPListToolsTool",
|
||||
"description": "Tool definition returned by MCP list tools operation."
|
||||
},
|
||||
"description": "List of available tools provided by the MCP server"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type",
|
||||
"server_label",
|
||||
"tools"
|
||||
],
|
||||
"title": "OpenAIResponseOutputMessageMCPListTools",
|
||||
"description": "MCP list tools output message containing available tools from an MCP server."
|
||||
},
|
||||
"OpenAIResponseOutputMessageWebSearchToolCall": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -9138,129 +9267,6 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"OpenAIResponseOutputMessageMCPCall": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for this MCP call"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "mcp_call",
|
||||
"default": "mcp_call",
|
||||
"description": "Tool call type identifier, always \"mcp_call\""
|
||||
},
|
||||
"arguments": {
|
||||
"type": "string",
|
||||
"description": "JSON string containing the MCP call arguments"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the MCP method being called"
|
||||
},
|
||||
"server_label": {
|
||||
"type": "string",
|
||||
"description": "Label identifying the MCP server handling the call"
|
||||
},
|
||||
"error": {
|
||||
"type": "string",
|
||||
"description": "(Optional) Error message if the MCP call failed"
|
||||
},
|
||||
"output": {
|
||||
"type": "string",
|
||||
"description": "(Optional) Output result from the successful MCP call"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type",
|
||||
"arguments",
|
||||
"name",
|
||||
"server_label"
|
||||
],
|
||||
"title": "OpenAIResponseOutputMessageMCPCall",
|
||||
"description": "Model Context Protocol (MCP) call output message for OpenAI responses."
|
||||
},
|
||||
"OpenAIResponseOutputMessageMCPListTools": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for this MCP list tools operation"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "mcp_list_tools",
|
||||
"default": "mcp_list_tools",
|
||||
"description": "Tool call type identifier, always \"mcp_list_tools\""
|
||||
},
|
||||
"server_label": {
|
||||
"type": "string",
|
||||
"description": "Label identifying the MCP server providing the tools"
|
||||
},
|
||||
"tools": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"input_schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "null"
|
||||
},
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "object"
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "JSON schema defining the tool's input parameters"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the tool"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "(Optional) Description of what the tool does"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"input_schema",
|
||||
"name"
|
||||
],
|
||||
"title": "MCPListToolsTool",
|
||||
"description": "Tool definition returned by MCP list tools operation."
|
||||
},
|
||||
"description": "List of available tools provided by the MCP server"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type",
|
||||
"server_label",
|
||||
"tools"
|
||||
],
|
||||
"title": "OpenAIResponseOutputMessageMCPListTools",
|
||||
"description": "MCP list tools output message containing available tools from an MCP server."
|
||||
},
|
||||
"OpenAIResponseContentPart": {
|
||||
"oneOf": [
|
||||
{
|
||||
|
|
|
|||
202
docs/_static/llama-stack-spec.yaml
vendored
202
docs/_static/llama-stack-spec.yaml
vendored
|
|
@ -5952,6 +5952,8 @@ components:
|
|||
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
||||
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
||||
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
||||
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
||||
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
||||
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
||||
- $ref: '#/components/schemas/OpenAIResponseMessage'
|
||||
"OpenAIResponseInputFunctionToolCallOutput":
|
||||
|
|
@ -6419,6 +6421,106 @@ components:
|
|||
OpenAIResponseOutputMessageFunctionToolCall
|
||||
description: >-
|
||||
Function tool call output message for OpenAI responses.
|
||||
OpenAIResponseOutputMessageMCPCall:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: Unique identifier for this MCP call
|
||||
type:
|
||||
type: string
|
||||
const: mcp_call
|
||||
default: mcp_call
|
||||
description: >-
|
||||
Tool call type identifier, always "mcp_call"
|
||||
arguments:
|
||||
type: string
|
||||
description: >-
|
||||
JSON string containing the MCP call arguments
|
||||
name:
|
||||
type: string
|
||||
description: Name of the MCP method being called
|
||||
server_label:
|
||||
type: string
|
||||
description: >-
|
||||
Label identifying the MCP server handling the call
|
||||
error:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Error message if the MCP call failed
|
||||
output:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Output result from the successful MCP call
|
||||
additionalProperties: false
|
||||
required:
|
||||
- id
|
||||
- type
|
||||
- arguments
|
||||
- name
|
||||
- server_label
|
||||
title: OpenAIResponseOutputMessageMCPCall
|
||||
description: >-
|
||||
Model Context Protocol (MCP) call output message for OpenAI responses.
|
||||
OpenAIResponseOutputMessageMCPListTools:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for this MCP list tools operation
|
||||
type:
|
||||
type: string
|
||||
const: mcp_list_tools
|
||||
default: mcp_list_tools
|
||||
description: >-
|
||||
Tool call type identifier, always "mcp_list_tools"
|
||||
server_label:
|
||||
type: string
|
||||
description: >-
|
||||
Label identifying the MCP server providing the tools
|
||||
tools:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
input_schema:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: 'null'
|
||||
- type: boolean
|
||||
- type: number
|
||||
- type: string
|
||||
- type: array
|
||||
- type: object
|
||||
description: >-
|
||||
JSON schema defining the tool's input parameters
|
||||
name:
|
||||
type: string
|
||||
description: Name of the tool
|
||||
description:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Description of what the tool does
|
||||
additionalProperties: false
|
||||
required:
|
||||
- input_schema
|
||||
- name
|
||||
title: MCPListToolsTool
|
||||
description: >-
|
||||
Tool definition returned by MCP list tools operation.
|
||||
description: >-
|
||||
List of available tools provided by the MCP server
|
||||
additionalProperties: false
|
||||
required:
|
||||
- id
|
||||
- type
|
||||
- server_label
|
||||
- tools
|
||||
title: OpenAIResponseOutputMessageMCPListTools
|
||||
description: >-
|
||||
MCP list tools output message containing available tools from an MCP server.
|
||||
"OpenAIResponseOutputMessageWebSearchToolCall":
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -6652,106 +6754,6 @@ components:
|
|||
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
||||
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
||||
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
||||
OpenAIResponseOutputMessageMCPCall:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: Unique identifier for this MCP call
|
||||
type:
|
||||
type: string
|
||||
const: mcp_call
|
||||
default: mcp_call
|
||||
description: >-
|
||||
Tool call type identifier, always "mcp_call"
|
||||
arguments:
|
||||
type: string
|
||||
description: >-
|
||||
JSON string containing the MCP call arguments
|
||||
name:
|
||||
type: string
|
||||
description: Name of the MCP method being called
|
||||
server_label:
|
||||
type: string
|
||||
description: >-
|
||||
Label identifying the MCP server handling the call
|
||||
error:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Error message if the MCP call failed
|
||||
output:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Output result from the successful MCP call
|
||||
additionalProperties: false
|
||||
required:
|
||||
- id
|
||||
- type
|
||||
- arguments
|
||||
- name
|
||||
- server_label
|
||||
title: OpenAIResponseOutputMessageMCPCall
|
||||
description: >-
|
||||
Model Context Protocol (MCP) call output message for OpenAI responses.
|
||||
OpenAIResponseOutputMessageMCPListTools:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: >-
|
||||
Unique identifier for this MCP list tools operation
|
||||
type:
|
||||
type: string
|
||||
const: mcp_list_tools
|
||||
default: mcp_list_tools
|
||||
description: >-
|
||||
Tool call type identifier, always "mcp_list_tools"
|
||||
server_label:
|
||||
type: string
|
||||
description: >-
|
||||
Label identifying the MCP server providing the tools
|
||||
tools:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
input_schema:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: 'null'
|
||||
- type: boolean
|
||||
- type: number
|
||||
- type: string
|
||||
- type: array
|
||||
- type: object
|
||||
description: >-
|
||||
JSON schema defining the tool's input parameters
|
||||
name:
|
||||
type: string
|
||||
description: Name of the tool
|
||||
description:
|
||||
type: string
|
||||
description: >-
|
||||
(Optional) Description of what the tool does
|
||||
additionalProperties: false
|
||||
required:
|
||||
- input_schema
|
||||
- name
|
||||
title: MCPListToolsTool
|
||||
description: >-
|
||||
Tool definition returned by MCP list tools operation.
|
||||
description: >-
|
||||
List of available tools provided by the MCP server
|
||||
additionalProperties: false
|
||||
required:
|
||||
- id
|
||||
- type
|
||||
- server_label
|
||||
- tools
|
||||
title: OpenAIResponseOutputMessageMCPListTools
|
||||
description: >-
|
||||
MCP list tools output message containing available tools from an MCP server.
|
||||
OpenAIResponseContentPart:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
|
|
|
|||
|
|
@ -4,12 +4,12 @@
|
|||
|
||||
Agents API for creating and interacting with agentic systems.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
This section contains documentation for all available providers for the **agents** API.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,15 +3,15 @@
|
|||
## Overview
|
||||
|
||||
The Batches API enables efficient processing of multiple requests in a single operation,
|
||||
particularly useful for processing large datasets, batch evaluation workflows, and
|
||||
cost-effective inference at scale.
|
||||
particularly useful for processing large datasets, batch evaluation workflows, and
|
||||
cost-effective inference at scale.
|
||||
|
||||
The API is designed to allow use of openai client libraries for seamless integration.
|
||||
The API is designed to allow use of openai client libraries for seamless integration.
|
||||
|
||||
This API provides the following extensions:
|
||||
- idempotent batch creation
|
||||
This API provides the following extensions:
|
||||
- idempotent batch creation
|
||||
|
||||
Note: This API is currently under active development and may undergo changes.
|
||||
Note: This API is currently under active development and may undergo changes.
|
||||
|
||||
This section contains documentation for all available providers for the **batches** API.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@
|
|||
|
||||
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.
|
||||
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.
|
||||
|
||||
This section contains documentation for all available providers for the **inference** API.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue