phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-05 18:22:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

generate openapi spec

Browse source
This commit is contained in:
Dinesh Yeduguru 2024-12-30 15:49:24 -08:00
parent ac46bd5eb4
commit a945ab53d0
2 changed files with 104 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -3705,16 +3705,16 @@
"type": "string" "type": "string"
} }
}, },
"available_tools": { "tool_names": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"custom_tools": { "client_tools": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/components/schemas/CustomToolDef" "$ref": "#/components/schemas/UserDefinedToolDef"
} }
}, },
"preprocessing_tools": { "preprocessing_tools": {
@ -3753,13 +3753,59 @@
"enable_session_persistence" "enable_session_persistence"
] ]
}, },
"CustomToolDef": { "ToolParameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parameter_type": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
},
"default": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"additionalProperties": false,
"required": [
"name",
"parameter_type",
"description",
"required"
]
},
"UserDefinedToolDef": {
"type": "object", "type": "object",
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
"const": "custom", "const": "user_defined",
"default": "custom" "default": "user_defined"
}, },
"name": { "name": {
"type": "string" "type": "string"
@ -3812,52 +3858,6 @@
"metadata" "metadata"
] ]
}, },
"ToolParameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parameter_type": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
},
"default": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"additionalProperties": false,
"required": [
"name",
"parameter_type",
"description",
"required"
]
},
"CreateAgentRequest": { "CreateAgentRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -4574,7 +4574,7 @@
"ToolDef": { "ToolDef": {
"oneOf": [ "oneOf": [
{ {
"$ref": "#/components/schemas/CustomToolDef" "$ref": "#/components/schemas/UserDefinedToolDef"
}, },
{ {
"$ref": "#/components/schemas/BuiltInToolDef" "$ref": "#/components/schemas/BuiltInToolDef"
@ -8078,10 +8078,6 @@
"name": "CreateAgentTurnRequest", "name": "CreateAgentTurnRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgentTurnRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgentTurnRequest\" />"
}, },
{
"name": "CustomToolDef",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CustomToolDef\" />"
},
{ {
"name": "DPOAlignmentConfig", "name": "DPOAlignmentConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />"
@ -8628,6 +8624,10 @@
"name": "UnstructuredLogEvent", "name": "UnstructuredLogEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnstructuredLogEvent\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnstructuredLogEvent\" />"
}, },
{
"name": "UserDefinedToolDef",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserDefinedToolDef\" />"
},
{ {
"name": "UserDefinedToolGroupDef", "name": "UserDefinedToolGroupDef",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserDefinedToolGroupDef\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserDefinedToolGroupDef\" />"
@ -8723,7 +8723,6 @@
"CreateAgentRequest", "CreateAgentRequest",
"CreateAgentSessionRequest", "CreateAgentSessionRequest",
"CreateAgentTurnRequest", "CreateAgentTurnRequest",
"CustomToolDef",
"DPOAlignmentConfig", "DPOAlignmentConfig",
"DataConfig", "DataConfig",
"Dataset", "Dataset",
@ -8847,6 +8846,7 @@
"UnregisterModelRequest", "UnregisterModelRequest",
"UnregisterToolGroupRequest", "UnregisterToolGroupRequest",
"UnstructuredLogEvent", "UnstructuredLogEvent",
"UserDefinedToolDef",
"UserDefinedToolGroupDef", "UserDefinedToolGroupDef",
"UserMessage", "UserMessage",
"VectorMemoryBank", "VectorMemoryBank",

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

@ -17,13 +17,9 @@ components:
AgentConfig: AgentConfig:
additionalProperties: false additionalProperties: false
properties: properties:
available_tools: client_tools:
items: items:
type: string $ref: '#/components/schemas/UserDefinedToolDef'
type: array
custom_tools:
items:
$ref: '#/components/schemas/CustomToolDef'
type: array type: array
enable_session_persistence: enable_session_persistence:
type: boolean type: boolean
@ -51,6 +47,10 @@ components:
tool_choice: tool_choice:
$ref: '#/components/schemas/ToolChoice' $ref: '#/components/schemas/ToolChoice'
default: auto default: auto
tool_names:
items:
type: string
type: array
tool_prompt_format: tool_prompt_format:
$ref: '#/components/schemas/ToolPromptFormat' $ref: '#/components/schemas/ToolPromptFormat'
default: json default: json
@ -616,41 +616,6 @@ components:
- session_id - session_id
- messages - messages
type: object type: object
CustomToolDef:
additionalProperties: false
properties:
description:
type: string
metadata:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
name:
type: string
parameters:
items:
$ref: '#/components/schemas/ToolParameter'
type: array
tool_prompt_format:
$ref: '#/components/schemas/ToolPromptFormat'
default: json
type:
const: custom
default: custom
type: string
required:
- type
- name
- description
- parameters
- metadata
type: object
DPOAlignmentConfig: DPOAlignmentConfig:
additionalProperties: false additionalProperties: false
properties: properties:
@ -2712,7 +2677,7 @@ components:
type: string type: string
ToolDef: ToolDef:
oneOf: oneOf:
- $ref: '#/components/schemas/CustomToolDef' - $ref: '#/components/schemas/UserDefinedToolDef'
- $ref: '#/components/schemas/BuiltInToolDef' - $ref: '#/components/schemas/BuiltInToolDef'
ToolDefinition: ToolDefinition:
additionalProperties: false additionalProperties: false
@ -3082,6 +3047,41 @@ components:
- message - message
- severity - severity
type: object type: object
UserDefinedToolDef:
additionalProperties: false
properties:
description:
type: string
metadata:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
name:
type: string
parameters:
items:
$ref: '#/components/schemas/ToolParameter'
type: array
tool_prompt_format:
$ref: '#/components/schemas/ToolPromptFormat'
default: json
type:
const: user_defined
default: user_defined
type: string
required:
- type
- name
- description
- parameters
- metadata
type: object
UserDefinedToolGroupDef: UserDefinedToolGroupDef:
additionalProperties: false additionalProperties: false
properties: properties:
@ -4842,8 +4842,6 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentTurnRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentTurnRequest"
/> />
name: CreateAgentTurnRequest name: CreateAgentTurnRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/CustomToolDef" />
name: CustomToolDef
- description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig"
/> />
name: DPOAlignmentConfig name: DPOAlignmentConfig
@ -5211,6 +5209,9 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent" - description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent"
/> />
name: UnstructuredLogEvent name: UnstructuredLogEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/UserDefinedToolDef"
/>
name: UserDefinedToolDef
- description: <SchemaDefinition schemaRef="#/components/schemas/UserDefinedToolGroupDef" - description: <SchemaDefinition schemaRef="#/components/schemas/UserDefinedToolGroupDef"
/> />
name: UserDefinedToolGroupDef name: UserDefinedToolGroupDef
@ -5288,7 +5289,6 @@ x-tagGroups:
- CreateAgentRequest - CreateAgentRequest
- CreateAgentSessionRequest - CreateAgentSessionRequest
- CreateAgentTurnRequest - CreateAgentTurnRequest
- CustomToolDef
- DPOAlignmentConfig - DPOAlignmentConfig
- DataConfig - DataConfig
- Dataset - Dataset
@ -5412,6 +5412,7 @@ x-tagGroups:
- UnregisterModelRequest - UnregisterModelRequest
- UnregisterToolGroupRequest - UnregisterToolGroupRequest
- UnstructuredLogEvent - UnstructuredLogEvent
- UserDefinedToolDef
- UserDefinedToolGroupDef - UserDefinedToolGroupDef
- UserMessage - UserMessage
- VectorMemoryBank - VectorMemoryBank