From 87068278ac45588f22ac14e35f8aaaf211267e1b Mon Sep 17 00:00:00 2001 From: Dinesh Yeduguru Date: Tue, 7 Jan 2025 16:08:04 -0800 Subject: [PATCH] update open api spec --- docs/resources/llama-stack-spec.html | 203 +++++++++------------------ docs/resources/llama-stack-spec.yaml | 103 +++++--------- 2 files changed, 103 insertions(+), 203 deletions(-) diff --git a/docs/resources/llama-stack-spec.html b/docs/resources/llama-stack-spec.html index fb7525988..2d423b3e6 100644 --- a/docs/resources/llama-stack-spec.html +++ b/docs/resources/llama-stack-spec.html @@ -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": { "post": { "responses": { @@ -1215,7 +1175,7 @@ ], "parameters": [ { - "name": "tool_group_id", + "name": "toolgroup_id", "in": "query", "required": true, "schema": { @@ -1898,7 +1858,7 @@ } }, "tags": [ - "ToolGroups" + "ToolRuntime" ], "summary": "List tools with optional tool group", "parameters": [ @@ -3705,7 +3665,7 @@ "type": "string" } }, - "tools": { + "toolgroups": { "type": "array", "items": { "$ref": "#/components/schemas/AgentTool" @@ -3832,6 +3792,9 @@ ] } }, + "built_in_type": { + "$ref": "#/components/schemas/BuiltinTool" + }, "tool_prompt_format": { "$ref": "#/components/schemas/ToolPromptFormat", "default": "json" @@ -3855,7 +3818,8 @@ "type": "string" }, "required": { - "type": "boolean" + "type": "boolean", + "default": true }, "default": { "oneOf": [ @@ -4580,68 +4544,6 @@ "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": { "type": "object", "properties": { @@ -5872,7 +5774,7 @@ "const": "tool", "default": "tool" }, - "tool_group": { + "toolgroup_id": { "type": "string" }, "tool_host": { @@ -5926,7 +5828,7 @@ "provider_resource_id", "provider_id", "type", - "tool_group", + "toolgroup_id", "tool_host", "description", "parameters" @@ -5956,6 +5858,34 @@ "type": "string", "const": "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, @@ -7371,20 +7301,45 @@ "RegisterToolGroupRequest": { "type": "object", "properties": { - "tool_group_id": { + "toolgroup_id": { "type": "string" }, - "tool_group_def": { - "$ref": "#/components/schemas/ToolGroupDef" - }, "provider_id": { "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, "required": [ - "tool_group_id", - "tool_group_def" + "toolgroup_id", + "provider_id" ] }, "RunEvalRequest": { @@ -8122,10 +8077,6 @@ "name": "DeleteAgentsSessionRequest", "description": "" }, - { - "name": "DiscoverToolsRequest", - "description": "" - }, { "name": "EfficiencyConfig", "description": "" @@ -8250,10 +8201,6 @@ "name": "LoraFinetuningConfig", "description": "" }, - { - "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" - }, { "name": "Memory" }, @@ -8568,10 +8515,6 @@ "name": "ToolGroup", "description": "" }, - { - "name": "ToolGroupDef", - "description": "" - }, { "name": "ToolGroups" }, @@ -8642,10 +8585,6 @@ "name": "UnstructuredLogEvent", "description": "" }, - { - "name": "UserDefinedToolGroupDef", - "description": "" - }, { "name": "UserMessage", "description": "" @@ -8742,7 +8681,6 @@ "Dataset", "DeleteAgentsRequest", "DeleteAgentsSessionRequest", - "DiscoverToolsRequest", "EfficiencyConfig", "EmbeddingsRequest", "EmbeddingsResponse", @@ -8771,7 +8709,6 @@ "LogEventRequest", "LogSeverity", "LoraFinetuningConfig", - "MCPToolGroupDef", "MemoryBankDocument", "MemoryRetrievalStep", "Message", @@ -8843,7 +8780,6 @@ "ToolDefinition", "ToolExecutionStep", "ToolGroup", - "ToolGroupDef", "ToolHost", "ToolInvocationResult", "ToolParamDefinition", @@ -8860,7 +8796,6 @@ "UnregisterModelRequest", "UnregisterToolGroupRequest", "UnstructuredLogEvent", - "UserDefinedToolGroupDef", "UserMessage", "VectorMemoryBank", "VectorMemoryBankParams", diff --git a/docs/resources/llama-stack-spec.yaml b/docs/resources/llama-stack-spec.yaml index 0937d8722..bf3b515f2 100644 --- a/docs/resources/llama-stack-spec.yaml +++ b/docs/resources/llama-stack-spec.yaml @@ -46,7 +46,7 @@ components: tool_prompt_format: $ref: '#/components/schemas/ToolPromptFormat' default: json - tools: + toolgroups: items: $ref: '#/components/schemas/AgentTool' type: array @@ -729,14 +729,6 @@ components: - agent_id - session_id type: object - DiscoverToolsRequest: - additionalProperties: false - properties: - tool_group: - $ref: '#/components/schemas/ToolGroupDef' - required: - - tool_group - type: object EfficiencyConfig: additionalProperties: false properties: @@ -1186,21 +1178,6 @@ components: - rank - alpha 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: additionalProperties: false properties: @@ -1904,15 +1881,25 @@ components: RegisterToolGroupRequest: additionalProperties: false 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: type: string - tool_group_def: - $ref: '#/components/schemas/ToolGroupDef' - tool_group_id: + toolgroup_id: type: string required: - - tool_group_id - - tool_group_def + - toolgroup_id + - provider_id type: object ResponseFormat: oneOf: @@ -2607,13 +2594,13 @@ components: type: string provider_resource_id: type: string - tool_group: - type: string tool_host: $ref: '#/components/schemas/ToolHost' tool_prompt_format: $ref: '#/components/schemas/ToolPromptFormat' default: json + toolgroup_id: + type: string type: const: tool default: tool @@ -2623,7 +2610,7 @@ components: - provider_resource_id - provider_id - type - - tool_group + - toolgroup_id - tool_host - description - parameters @@ -2695,6 +2682,8 @@ components: ToolDef: additionalProperties: false properties: + built_in_type: + $ref: '#/components/schemas/BuiltinTool' description: type: string metadata: @@ -2770,8 +2759,20 @@ components: ToolGroup: additionalProperties: false properties: + args: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object identifier: type: string + mcp_endpoint: + $ref: '#/components/schemas/URL' provider_id: type: string provider_resource_id: @@ -2786,10 +2787,6 @@ components: - provider_id - type type: object - ToolGroupDef: - oneOf: - - $ref: '#/components/schemas/MCPToolGroupDef' - - $ref: '#/components/schemas/UserDefinedToolGroupDef' ToolHost: enum: - distribution @@ -2847,6 +2844,7 @@ components: parameter_type: type: string required: + default: true type: boolean required: - name @@ -3087,21 +3085,6 @@ components: - message - severity 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: additionalProperties: false properties: @@ -4862,9 +4845,6 @@ tags: - description: name: DeleteAgentsSessionRequest -- description: - name: DiscoverToolsRequest - description: name: EfficiencyConfig @@ -4947,12 +4927,6 @@ tags: - description: 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. - - - ' - name: MCPToolGroupDef - name: Memory - description: @@ -5158,8 +5132,6 @@ tags: name: ToolExecutionStep - description: name: ToolGroup -- description: - name: ToolGroupDef - name: ToolGroups - description: name: ToolHost @@ -5214,9 +5186,6 @@ tags: - description: name: UnstructuredLogEvent -- description: - name: UserDefinedToolGroupDef - description: name: UserMessage - description: