add openapi spec

This commit is contained in:
Dinesh Yeduguru 2024-11-14 16:18:12 -08:00
parent 428995286d
commit 690e525a36
2 changed files with 168 additions and 168 deletions

View file

@ -21,7 +21,7 @@
"info": { "info": {
"title": "[DRAFT] Llama Stack Specification", "title": "[DRAFT] Llama Stack Specification",
"version": "0.0.1", "version": "0.0.1",
"description": "This is the specification of the llama stack that provides\n a set of endpoints and their corresponding interfaces that are tailored to\n best leverage Llama Models. The specification is still in draft and subject to change.\n Generated at 2024-11-14 14:47:24.435917" "description": "This is the specification of the llama stack that provides\n a set of endpoints and their corresponding interfaces that are tailored to\n best leverage Llama Models. The specification is still in draft and subject to change.\n Generated at 2024-11-14 16:18:00.903125"
}, },
"servers": [ "servers": [
{ {
@ -429,72 +429,6 @@
} }
} }
}, },
"/memory_banks/delete": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"MemoryBanks"
],
"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/DeleteMemoryBankRequest"
}
}
},
"required": true
}
}
},
"/models/delete": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Models"
],
"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/DeleteModelRequest"
}
}
},
"required": true
}
}
},
"/inference/embeddings": { "/inference/embeddings": {
"post": { "post": {
"responses": { "responses": {
@ -2292,6 +2226,72 @@
} }
} }
}, },
"/memory_banks/unregister": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"MemoryBanks"
],
"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/UnregisterMemoryBankRequest"
}
}
},
"required": true
}
}
},
"/models/unregister": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Models"
],
"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/UnregisterModelRequest"
}
}
},
"required": true
}
}
},
"/memory_banks/update": { "/memory_banks/update": {
"post": { "post": {
"responses": {}, "responses": {},
@ -4684,30 +4684,6 @@
"session_id" "session_id"
] ]
}, },
"DeleteMemoryBankRequest": {
"type": "object",
"properties": {
"memory_bank_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"memory_bank_id"
]
},
"DeleteModelRequest": {
"type": "object",
"properties": {
"model_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"model_id"
]
},
"EmbeddingsRequest": { "EmbeddingsRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -7986,6 +7962,30 @@
], ],
"title": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold." "title": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold."
}, },
"UnregisterMemoryBankRequest": {
"type": "object",
"properties": {
"memory_bank_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"memory_bank_id"
]
},
"UnregisterModelRequest": {
"type": "object",
"properties": {
"model_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"model_id"
]
},
"UpdateMemoryBankRequest": { "UpdateMemoryBankRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -8241,14 +8241,6 @@
"name": "DeleteAgentsSessionRequest", "name": "DeleteAgentsSessionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteAgentsSessionRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteAgentsSessionRequest\" />"
}, },
{
"name": "DeleteMemoryBankRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteMemoryBankRequest\" />"
},
{
"name": "DeleteModelRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteModelRequest\" />"
},
{ {
"name": "DoraFinetuningConfig", "name": "DoraFinetuningConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DoraFinetuningConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DoraFinetuningConfig\" />"
@ -8675,6 +8667,14 @@
"name": "URL", "name": "URL",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/URL\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/URL\" />"
}, },
{
"name": "UnregisterMemoryBankRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnregisterMemoryBankRequest\" />"
},
{
"name": "UnregisterModelRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnregisterModelRequest\" />"
},
{ {
"name": "UnstructuredLogEvent", "name": "UnstructuredLogEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnstructuredLogEvent\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnstructuredLogEvent\" />"
@ -8774,8 +8774,6 @@
"Dataset", "Dataset",
"DeleteAgentsRequest", "DeleteAgentsRequest",
"DeleteAgentsSessionRequest", "DeleteAgentsSessionRequest",
"DeleteMemoryBankRequest",
"DeleteModelRequest",
"DoraFinetuningConfig", "DoraFinetuningConfig",
"EmbeddingsRequest", "EmbeddingsRequest",
"EmbeddingsResponse", "EmbeddingsResponse",
@ -8872,6 +8870,8 @@
"TrainingConfig", "TrainingConfig",
"Turn", "Turn",
"URL", "URL",
"UnregisterMemoryBankRequest",
"UnregisterModelRequest",
"UnstructuredLogEvent", "UnstructuredLogEvent",
"UpdateMemoryBankRequest", "UpdateMemoryBankRequest",
"UpdateModelRequest", "UpdateModelRequest",

View file

@ -867,22 +867,6 @@ components:
- agent_id - agent_id
- session_id - session_id
type: object type: object
DeleteMemoryBankRequest:
additionalProperties: false
properties:
memory_bank_id:
type: string
required:
- memory_bank_id
type: object
DeleteModelRequest:
additionalProperties: false
properties:
model_id:
type: string
required:
- model_id
type: object
DoraFinetuningConfig: DoraFinetuningConfig:
additionalProperties: false additionalProperties: false
properties: properties:
@ -3252,6 +3236,22 @@ components:
format: uri format: uri
pattern: ^(https?://|file://|data:) pattern: ^(https?://|file://|data:)
type: string type: string
UnregisterMemoryBankRequest:
additionalProperties: false
properties:
memory_bank_id:
type: string
required:
- memory_bank_id
type: object
UnregisterModelRequest:
additionalProperties: false
properties:
model_id:
type: string
required:
- model_id
type: object
UnstructuredLogEvent: UnstructuredLogEvent:
additionalProperties: false additionalProperties: false
properties: properties:
@ -3441,7 +3441,7 @@ info:
description: "This is the specification of the llama stack that provides\n \ description: "This is the specification of the llama stack that provides\n \
\ a set of endpoints and their corresponding interfaces that are tailored\ \ a set of endpoints and their corresponding interfaces that are tailored\
\ to\n best leverage Llama Models. The specification is still in\ \ to\n best leverage Llama Models. The specification is still in\
\ draft and subject to change.\n Generated at 2024-11-14 14:47:24.435917" \ draft and subject to change.\n Generated at 2024-11-14 16:18:00.903125"
title: '[DRAFT] Llama Stack Specification' title: '[DRAFT] Llama Stack Specification'
version: 0.0.1 version: 0.0.1
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
@ -4171,27 +4171,6 @@ paths:
description: OK description: OK
tags: tags:
- Memory - Memory
/memory_banks/delete:
post:
parameters:
- description: JSON-encoded provider data which will be made available to the
adapter servicing the API
in: header
name: X-LlamaStack-ProviderData
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMemoryBankRequest'
required: true
responses:
'200':
description: OK
tags:
- MemoryBanks
/memory_banks/get: /memory_banks/get:
get: get:
parameters: parameters:
@ -4264,6 +4243,27 @@ paths:
responses: {} responses: {}
tags: tags:
- MemoryBanks - MemoryBanks
/memory_banks/unregister:
post:
parameters:
- description: JSON-encoded provider data which will be made available to the
adapter servicing the API
in: header
name: X-LlamaStack-ProviderData
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnregisterMemoryBankRequest'
required: true
responses:
'200':
description: OK
tags:
- MemoryBanks
/memory_banks/update: /memory_banks/update:
post: post:
parameters: parameters:
@ -4283,27 +4283,6 @@ paths:
responses: {} responses: {}
tags: tags:
- MemoryBanks - MemoryBanks
/models/delete:
post:
parameters:
- description: JSON-encoded provider data which will be made available to the
adapter servicing the API
in: header
name: X-LlamaStack-ProviderData
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteModelRequest'
required: true
responses:
'200':
description: OK
tags:
- Models
/models/get: /models/get:
get: get:
parameters: parameters:
@ -4374,6 +4353,27 @@ paths:
description: OK description: OK
tags: tags:
- Models - Models
/models/unregister:
post:
parameters:
- description: JSON-encoded provider data which will be made available to the
adapter servicing the API
in: header
name: X-LlamaStack-ProviderData
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnregisterModelRequest'
required: true
responses:
'200':
description: OK
tags:
- Models
/models/update: /models/update:
post: post:
parameters: parameters:
@ -5027,12 +5027,6 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgentsSessionRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgentsSessionRequest"
/> />
name: DeleteAgentsSessionRequest name: DeleteAgentsSessionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteMemoryBankRequest"
/>
name: DeleteMemoryBankRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteModelRequest"
/>
name: DeleteModelRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/DoraFinetuningConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/DoraFinetuningConfig"
/> />
name: DoraFinetuningConfig name: DoraFinetuningConfig
@ -5327,6 +5321,12 @@ tags:
name: Turn name: Turn
- description: <SchemaDefinition schemaRef="#/components/schemas/URL" /> - description: <SchemaDefinition schemaRef="#/components/schemas/URL" />
name: URL name: URL
- description: <SchemaDefinition schemaRef="#/components/schemas/UnregisterMemoryBankRequest"
/>
name: UnregisterMemoryBankRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/UnregisterModelRequest"
/>
name: UnregisterModelRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent" - description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent"
/> />
name: UnstructuredLogEvent name: UnstructuredLogEvent
@ -5411,8 +5411,6 @@ x-tagGroups:
- Dataset - Dataset
- DeleteAgentsRequest - DeleteAgentsRequest
- DeleteAgentsSessionRequest - DeleteAgentsSessionRequest
- DeleteMemoryBankRequest
- DeleteModelRequest
- DoraFinetuningConfig - DoraFinetuningConfig
- EmbeddingsRequest - EmbeddingsRequest
- EmbeddingsResponse - EmbeddingsResponse
@ -5509,6 +5507,8 @@ x-tagGroups:
- TrainingConfig - TrainingConfig
- Turn - Turn
- URL - URL
- UnregisterMemoryBankRequest
- UnregisterModelRequest
- UnstructuredLogEvent - UnstructuredLogEvent
- UpdateMemoryBankRequest - UpdateMemoryBankRequest
- UpdateModelRequest - UpdateModelRequest