phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-03 17:29:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update open api spec

Browse source
This commit is contained in:
Dinesh Yeduguru 2025-01-07 16:08:04 -08:00
parent 94cca7a72a
commit 87068278ac
2 changed files with 103 additions and 203 deletions
Download patch file Download diff file Expand all files Collapse all files

203
docs/resources/llama-stack-spec.html
View file

@ -462,46 +462,6 @@
} }
} }
}, },
"/alpha/tool-runtime/discover": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/ToolDef"
}
}
}
}
},
"tags": [
"ToolRuntime"
],
"parameters": [
{
"name": "X-LlamaStack-ProviderData",
"in": "header",
"description": "JSON-encoded provider data which will be made available to the adapter servicing the API",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiscoverToolsRequest"
}
}
},
"required": true
}
}
},
"/alpha/inference/embeddings": { "/alpha/inference/embeddings": {
"post": { "post": {
"responses": { "responses": {
@ -1215,7 +1175,7 @@
], ],
"parameters": [ "parameters": [
{ {
"name": "tool_group_id", "name": "toolgroup_id",
"in": "query", "in": "query",
"required": true, "required": true,
"schema": { "schema": {
@ -1898,7 +1858,7 @@
} }
}, },
"tags": [ "tags": [
"ToolGroups" "ToolRuntime"
], ],
"summary": "List tools with optional tool group", "summary": "List tools with optional tool group",
"parameters": [ "parameters": [
@ -3705,7 +3665,7 @@
"type": "string" "type": "string"
} }
}, },
"tools": { "toolgroups": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/components/schemas/AgentTool" "$ref": "#/components/schemas/AgentTool"
@ -3832,6 +3792,9 @@
] ]
} }
}, },
"built_in_type": {
"$ref": "#/components/schemas/BuiltinTool"
},
"tool_prompt_format": { "tool_prompt_format": {
"$ref": "#/components/schemas/ToolPromptFormat", "$ref": "#/components/schemas/ToolPromptFormat",
"default": "json" "default": "json"
@ -3855,7 +3818,8 @@
"type": "string" "type": "string"
}, },
"required": { "required": {
"type": "boolean" "type": "boolean",
"default": true
}, },
"default": { "default": {
"oneOf": [ "oneOf": [
@ -4580,68 +4544,6 @@
"session_id" "session_id"
] ]
}, },
"MCPToolGroupDef": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "model_context_protocol",
"default": "model_context_protocol"
},
"endpoint": {
"$ref": "#/components/schemas/URL"
}
},
"additionalProperties": false,
"required": [
"type",
"endpoint"
],
"title": "A tool group that is defined by in a model context protocol server. Refer to https://modelcontextprotocol.io/docs/concepts/tools for more information."
},
"ToolGroupDef": {
"oneOf": [
{
"$ref": "#/components/schemas/MCPToolGroupDef"
},
{
"$ref": "#/components/schemas/UserDefinedToolGroupDef"
}
]
},
"UserDefinedToolGroupDef": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "user_defined",
"default": "user_defined"
},
"tools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolDef"
}
}
},
"additionalProperties": false,
"required": [
"type",
"tools"
]
},
"DiscoverToolsRequest": {
"type": "object",
"properties": {
"tool_group": {
"$ref": "#/components/schemas/ToolGroupDef"
}
},
"additionalProperties": false,
"required": [
"tool_group"
]
},
"EmbeddingsRequest": { "EmbeddingsRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -5872,7 +5774,7 @@
"const": "tool", "const": "tool",
"default": "tool" "default": "tool"
}, },
"tool_group": { "toolgroup_id": {
"type": "string" "type": "string"
}, },
"tool_host": { "tool_host": {
@ -5926,7 +5828,7 @@
"provider_resource_id", "provider_resource_id",
"provider_id", "provider_id",
"type", "type",
"tool_group", "toolgroup_id",
"tool_host", "tool_host",
"description", "description",
"parameters" "parameters"
@ -5956,6 +5858,34 @@
"type": "string", "type": "string",
"const": "tool_group", "const": "tool_group",
"default": "tool_group" "default": "tool_group"
},
"mcp_endpoint": {
"$ref": "#/components/schemas/URL"
},
"args": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
} }
}, },
"additionalProperties": false, "additionalProperties": false,
@ -7371,20 +7301,45 @@
"RegisterToolGroupRequest": { "RegisterToolGroupRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"tool_group_id": { "toolgroup_id": {
"type": "string" "type": "string"
}, },
"tool_group_def": {
"$ref": "#/components/schemas/ToolGroupDef"
},
"provider_id": { "provider_id": {
"type": "string" "type": "string"
},
"mcp_endpoint": {
"$ref": "#/components/schemas/URL"
},
"args": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
} }
}, },
"additionalProperties": false, "additionalProperties": false,
"required": [ "required": [
"tool_group_id", "toolgroup_id",
"tool_group_def" "provider_id"
] ]
}, },
"RunEvalRequest": { "RunEvalRequest": {
@ -8122,10 +8077,6 @@
"name": "DeleteAgentsSessionRequest", "name": "DeleteAgentsSessionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteAgentsSessionRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteAgentsSessionRequest\" />"
}, },
{
"name": "DiscoverToolsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DiscoverToolsRequest\" />"
},
{ {
"name": "EfficiencyConfig", "name": "EfficiencyConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EfficiencyConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EfficiencyConfig\" />"
@ -8250,10 +8201,6 @@
"name": "LoraFinetuningConfig", "name": "LoraFinetuningConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LoraFinetuningConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LoraFinetuningConfig\" />"
}, },
{
"name": "MCPToolGroupDef",
"description": "A tool group that is defined by in a model context protocol server. Refer to https://modelcontextprotocol.io/docs/concepts/tools for more information.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/MCPToolGroupDef\" />"
},
{ {
"name": "Memory" "name": "Memory"
}, },
@ -8568,10 +8515,6 @@
"name": "ToolGroup", "name": "ToolGroup",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolGroup\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolGroup\" />"
}, },
{
"name": "ToolGroupDef",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolGroupDef\" />"
},
{ {
"name": "ToolGroups" "name": "ToolGroups"
}, },
@ -8642,10 +8585,6 @@
"name": "UnstructuredLogEvent", "name": "UnstructuredLogEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnstructuredLogEvent\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnstructuredLogEvent\" />"
}, },
{
"name": "UserDefinedToolGroupDef",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserDefinedToolGroupDef\" />"
},
{ {
"name": "UserMessage", "name": "UserMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserMessage\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserMessage\" />"
@ -8742,7 +8681,6 @@
"Dataset", "Dataset",
"DeleteAgentsRequest", "DeleteAgentsRequest",
"DeleteAgentsSessionRequest", "DeleteAgentsSessionRequest",
"DiscoverToolsRequest",
"EfficiencyConfig", "EfficiencyConfig",
"EmbeddingsRequest", "EmbeddingsRequest",
"EmbeddingsResponse", "EmbeddingsResponse",
@ -8771,7 +8709,6 @@
"LogEventRequest", "LogEventRequest",
"LogSeverity", "LogSeverity",
"LoraFinetuningConfig", "LoraFinetuningConfig",
"MCPToolGroupDef",
"MemoryBankDocument", "MemoryBankDocument",
"MemoryRetrievalStep", "MemoryRetrievalStep",
"Message", "Message",
@ -8843,7 +8780,6 @@
"ToolDefinition", "ToolDefinition",
"ToolExecutionStep", "ToolExecutionStep",
"ToolGroup", "ToolGroup",
"ToolGroupDef",
"ToolHost", "ToolHost",
"ToolInvocationResult", "ToolInvocationResult",
"ToolParamDefinition", "ToolParamDefinition",
@ -8860,7 +8796,6 @@
"UnregisterModelRequest", "UnregisterModelRequest",
"UnregisterToolGroupRequest", "UnregisterToolGroupRequest",
"UnstructuredLogEvent", "UnstructuredLogEvent",
"UserDefinedToolGroupDef",
"UserMessage", "UserMessage",
"VectorMemoryBank", "VectorMemoryBank",
"VectorMemoryBankParams", "VectorMemoryBankParams",

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

@ -46,7 +46,7 @@ components:
tool_prompt_format: tool_prompt_format:
$ref: '#/components/schemas/ToolPromptFormat' $ref: '#/components/schemas/ToolPromptFormat'
default: json default: json
tools: toolgroups:
items: items:
$ref: '#/components/schemas/AgentTool' $ref: '#/components/schemas/AgentTool'
type: array type: array
@ -729,14 +729,6 @@ components:
- agent_id - agent_id
- session_id - session_id
type: object type: object
DiscoverToolsRequest:
additionalProperties: false
properties:
tool_group:
$ref: '#/components/schemas/ToolGroupDef'
required:
- tool_group
type: object
EfficiencyConfig: EfficiencyConfig:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1186,21 +1178,6 @@ components:
- rank - rank
- alpha - alpha
type: object type: object
MCPToolGroupDef:
additionalProperties: false
properties:
endpoint:
$ref: '#/components/schemas/URL'
type:
const: model_context_protocol
default: model_context_protocol
type: string
required:
- type
- endpoint
title: A tool group that is defined by in a model context protocol server. Refer
to https://modelcontextprotocol.io/docs/concepts/tools for more information.
type: object
MemoryBankDocument: MemoryBankDocument:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1904,15 +1881,25 @@ components:
RegisterToolGroupRequest: RegisterToolGroupRequest:
additionalProperties: false additionalProperties: false
properties: properties:
args:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
mcp_endpoint:
$ref: '#/components/schemas/URL'
provider_id: provider_id:
type: string type: string
tool_group_def: toolgroup_id:
$ref: '#/components/schemas/ToolGroupDef'
tool_group_id:
type: string type: string
required: required:
- tool_group_id - toolgroup_id
- tool_group_def - provider_id
type: object type: object
ResponseFormat: ResponseFormat:
oneOf: oneOf:
@ -2607,13 +2594,13 @@ components:
type: string type: string
provider_resource_id: provider_resource_id:
type: string type: string
tool_group:
type: string
tool_host: tool_host:
$ref: '#/components/schemas/ToolHost' $ref: '#/components/schemas/ToolHost'
tool_prompt_format: tool_prompt_format:
$ref: '#/components/schemas/ToolPromptFormat' $ref: '#/components/schemas/ToolPromptFormat'
default: json default: json
toolgroup_id:
type: string
type: type:
const: tool const: tool
default: tool default: tool
@ -2623,7 +2610,7 @@ components:
- provider_resource_id - provider_resource_id
- provider_id - provider_id
- type - type
- tool_group - toolgroup_id
- tool_host - tool_host
- description - description
- parameters - parameters
@ -2695,6 +2682,8 @@ components:
ToolDef: ToolDef:
additionalProperties: false additionalProperties: false
properties: properties:
built_in_type:
$ref: '#/components/schemas/BuiltinTool'
description: description:
type: string type: string
metadata: metadata:
@ -2770,8 +2759,20 @@ components:
ToolGroup: ToolGroup:
additionalProperties: false additionalProperties: false
properties: properties:
args:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
identifier: identifier:
type: string type: string
mcp_endpoint:
$ref: '#/components/schemas/URL'
provider_id: provider_id:
type: string type: string
provider_resource_id: provider_resource_id:
@ -2786,10 +2787,6 @@ components:
- provider_id - provider_id
- type - type
type: object type: object
ToolGroupDef:
oneOf:
- $ref: '#/components/schemas/MCPToolGroupDef'
- $ref: '#/components/schemas/UserDefinedToolGroupDef'
ToolHost: ToolHost:
enum: enum:
- distribution - distribution
@ -2847,6 +2844,7 @@ components:
parameter_type: parameter_type:
type: string type: string
required: required:
default: true
type: boolean type: boolean
required: required:
- name - name
@ -3087,21 +3085,6 @@ components:
- message - message
- severity - severity
type: object type: object
UserDefinedToolGroupDef:
additionalProperties: false
properties:
tools:
items:
$ref: '#/components/schemas/ToolDef'
type: array
type:
const: user_defined
default: user_defined
type: string
required:
- type
- tools
type: object
UserMessage: UserMessage:
additionalProperties: false additionalProperties: false
properties: properties:
@ -4862,9 +4845,6 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgentsSessionRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgentsSessionRequest"
/> />
name: DeleteAgentsSessionRequest name: DeleteAgentsSessionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/DiscoverToolsRequest"
/>
name: DiscoverToolsRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/EfficiencyConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/EfficiencyConfig"
/> />
name: EfficiencyConfig name: EfficiencyConfig
@ -4947,12 +4927,6 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/LoraFinetuningConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/LoraFinetuningConfig"
/> />
name: LoraFinetuningConfig name: LoraFinetuningConfig
- description: 'A tool group that is defined by in a model context protocol server.
Refer to https://modelcontextprotocol.io/docs/concepts/tools for more information.
<SchemaDefinition schemaRef="#/components/schemas/MCPToolGroupDef" />'
name: MCPToolGroupDef
- name: Memory - name: Memory
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBankDocument" - description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBankDocument"
/> />
@ -5158,8 +5132,6 @@ tags:
name: ToolExecutionStep name: ToolExecutionStep
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolGroup" /> - description: <SchemaDefinition schemaRef="#/components/schemas/ToolGroup" />
name: ToolGroup name: ToolGroup
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolGroupDef" />
name: ToolGroupDef
- name: ToolGroups - name: ToolGroups
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolHost" /> - description: <SchemaDefinition schemaRef="#/components/schemas/ToolHost" />
name: ToolHost name: ToolHost
@ -5214,9 +5186,6 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent" - description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent"
/> />
name: UnstructuredLogEvent name: UnstructuredLogEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/UserDefinedToolGroupDef"
/>
name: UserDefinedToolGroupDef
- description: <SchemaDefinition schemaRef="#/components/schemas/UserMessage" /> - description: <SchemaDefinition schemaRef="#/components/schemas/UserMessage" />
name: UserMessage name: UserMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/VectorMemoryBank" - description: <SchemaDefinition schemaRef="#/components/schemas/VectorMemoryBank"
@ -5296,7 +5265,6 @@ x-tagGroups:
- Dataset - Dataset
- DeleteAgentsRequest - DeleteAgentsRequest
- DeleteAgentsSessionRequest - DeleteAgentsSessionRequest
- DiscoverToolsRequest
- EfficiencyConfig - EfficiencyConfig
- EmbeddingsRequest - EmbeddingsRequest
- EmbeddingsResponse - EmbeddingsResponse
@ -5325,7 +5293,6 @@ x-tagGroups:
- LogEventRequest - LogEventRequest
- LogSeverity - LogSeverity
- LoraFinetuningConfig - LoraFinetuningConfig
- MCPToolGroupDef
- MemoryBankDocument - MemoryBankDocument
- MemoryRetrievalStep - MemoryRetrievalStep
- Message - Message
@ -5397,7 +5364,6 @@ x-tagGroups:
- ToolDefinition - ToolDefinition
- ToolExecutionStep - ToolExecutionStep
- ToolGroup - ToolGroup
- ToolGroupDef
- ToolHost - ToolHost
- ToolInvocationResult - ToolInvocationResult
- ToolParamDefinition - ToolParamDefinition
@ -5414,7 +5380,6 @@ x-tagGroups:
- UnregisterModelRequest - UnregisterModelRequest
- UnregisterToolGroupRequest - UnregisterToolGroupRequest
- UnstructuredLogEvent - UnstructuredLogEvent
- UserDefinedToolGroupDef
- UserMessage - UserMessage
- VectorMemoryBank - VectorMemoryBank
- VectorMemoryBankParams - VectorMemoryBankParams