diff --git a/docs/openapi_generator/generate.py b/docs/openapi_generator/generate.py index 6195001a2..a2c6110bf 100644 --- a/docs/openapi_generator/generate.py +++ b/docs/openapi_generator/generate.py @@ -49,6 +49,7 @@ from llama_stack.apis.shields import * # noqa: F403 class LlamaStack( + MemoryBanks, Inference, BatchInference, Agents, @@ -61,7 +62,6 @@ class LlamaStack( Memory, Evaluations, Models, - MemoryBanks, Shields, ): pass diff --git a/docs/resources/llama-stack-spec.html b/docs/resources/llama-stack-spec.html index 9932b67cc..4e24f1d9d 100644 --- a/docs/resources/llama-stack-spec.html +++ b/docs/resources/llama-stack-spec.html @@ -21,7 +21,7 @@ "info": { "title": "[DRAFT] Llama Stack Specification", "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-09-23 09:14:46.697401" + "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-09-23 10:08:50.987103" }, "servers": [ { @@ -1180,7 +1180,7 @@ ] } }, - "/memory/get": { + "/memory_banks/get": { "get": { "responses": { "200": { @@ -1190,7 +1190,7 @@ "schema": { "oneOf": [ { - "$ref": "#/components/schemas/MemoryBank" + "$ref": "#/components/schemas/MemoryBankSpec" }, { "type": "null" @@ -1202,15 +1202,15 @@ } }, "tags": [ - "MemoryBanks" + "Memory" ], "parameters": [ { - "name": "bank_id", + "name": "bank_type", "in": "query", "required": true, "schema": { - "type": "string" + "$ref": "#/components/schemas/MemoryBankType" } }, { @@ -1530,7 +1530,7 @@ } } }, - "/memory/list": { + "/memory_banks/list": { "get": { "responses": { "200": { @@ -1538,14 +1538,14 @@ "content": { "application/jsonl": { "schema": { - "$ref": "#/components/schemas/MemoryBank" + "$ref": "#/components/schemas/MemoryBankSpec" } } } } }, "tags": [ - "MemoryBanks" + "Memory" ], "parameters": [ { @@ -4471,6 +4471,66 @@ "job_uuid" ] }, + "MemoryBankType": { + "type": "string", + "enum": [ + "vector", + "keyvalue", + "keyword", + "graph" + ] + }, + "MemoryBankSpec": { + "type": "object", + "properties": { + "bank_type": { + "$ref": "#/components/schemas/MemoryBankType" + }, + "provider_config": { + "type": "object", + "properties": { + "provider_id": { + "type": "string" + }, + "config": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "provider_id", + "config" + ] + } + }, + "additionalProperties": false, + "required": [ + "bank_type", + "provider_config" + ] + }, "Model": { "description": "The model family and SKU of the model along with other parameters corresponding to the model." }, @@ -5834,35 +5894,11 @@ } ], "tags": [ - { - "name": "Evaluations" - }, - { - "name": "MemoryBanks" - }, - { - "name": "Memory" - }, { "name": "Datasets" }, { - "name": "Inference" - }, - { - "name": "BatchInference" - }, - { - "name": "PostTraining" - }, - { - "name": "SyntheticDataGeneration" - }, - { - "name": "Models" - }, - { - "name": "RewardScoring" + "name": "Safety" }, { "name": "Telemetry" @@ -5871,11 +5907,32 @@ "name": "Agents" }, { - "name": "Safety" + "name": "BatchInference" + }, + { + "name": "Models" + }, + { + "name": "SyntheticDataGeneration" + }, + { + "name": "Evaluations" }, { "name": "Shields" }, + { + "name": "Memory" + }, + { + "name": "PostTraining" + }, + { + "name": "RewardScoring" + }, + { + "name": "Inference" + }, { "name": "BuiltinTool", "description": "" @@ -6216,6 +6273,14 @@ "name": "EvaluationJobStatusResponse", "description": "" }, + { + "name": "MemoryBankType", + "description": "" + }, + { + "name": "MemoryBankSpec", + "description": "" + }, { "name": "Model", "description": "The model family and SKU of the model along with other parameters corresponding to the model.\n\n" @@ -6391,7 +6456,6 @@ "Evaluations", "Inference", "Memory", - "MemoryBanks", "Models", "PostTraining", "RewardScoring", @@ -6467,6 +6531,8 @@ "LoraFinetuningConfig", "MemoryBank", "MemoryBankDocument", + "MemoryBankSpec", + "MemoryBankType", "MemoryRetrievalStep", "MemoryToolDefinition", "MetricEvent", diff --git a/docs/resources/llama-stack-spec.yaml b/docs/resources/llama-stack-spec.yaml index 5a0b5393d..e4334dbdf 100644 --- a/docs/resources/llama-stack-spec.yaml +++ b/docs/resources/llama-stack-spec.yaml @@ -1039,6 +1039,41 @@ components: - content - metadata type: object + MemoryBankSpec: + additionalProperties: false + properties: + bank_type: + $ref: '#/components/schemas/MemoryBankType' + provider_config: + additionalProperties: false + properties: + config: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + provider_id: + type: string + required: + - provider_id + - config + type: object + required: + - bank_type + - provider_config + type: object + MemoryBankType: + enum: + - vector + - keyvalue + - keyword + - graph + type: string MemoryRetrievalStep: additionalProperties: false properties: @@ -2408,7 +2443,7 @@ info: 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-09-23 09:14:46.697401" + \ draft and subject to change.\n Generated at 2024-09-23 10:08:50.987103" title: '[DRAFT] Llama Stack Specification' version: 0.0.1 jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema @@ -3112,32 +3147,6 @@ paths: description: OK tags: - Memory - /memory/get: - get: - parameters: - - in: query - name: bank_id - required: true - schema: - type: string - - 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 - responses: - '200': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/MemoryBank' - - type: 'null' - description: OK - tags: - - MemoryBanks /memory/insert: post: parameters: @@ -3159,25 +3168,6 @@ paths: description: OK tags: - Memory - /memory/list: - get: - 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 - responses: - '200': - content: - application/jsonl: - schema: - $ref: '#/components/schemas/MemoryBank' - description: OK - tags: - - MemoryBanks /memory/query: post: parameters: @@ -3224,6 +3214,51 @@ paths: description: OK tags: - Memory + /memory_banks/get: + get: + parameters: + - in: query + name: bank_type + required: true + schema: + $ref: '#/components/schemas/MemoryBankType' + - 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 + responses: + '200': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/MemoryBankSpec' + - type: 'null' + description: OK + tags: + - Memory + /memory_banks/list: + get: + 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 + responses: + '200': + content: + application/jsonl: + schema: + $ref: '#/components/schemas/MemoryBankSpec' + description: OK + tags: + - Memory /models/get: get: parameters: @@ -3601,20 +3636,19 @@ security: servers: - url: http://any-hosted-llama-stack.com tags: -- name: Evaluations -- name: MemoryBanks -- name: Memory - name: Datasets -- name: Inference -- name: BatchInference -- name: PostTraining -- name: SyntheticDataGeneration -- name: Models -- name: RewardScoring +- name: Safety - name: Telemetry - name: Agents -- name: Safety +- name: BatchInference +- name: Models +- name: SyntheticDataGeneration +- name: Evaluations - name: Shields +- name: Memory +- name: PostTraining +- name: RewardScoring +- name: Inference - description: name: BuiltinTool - description: name: EvaluationJobStatusResponse +- description: + name: MemoryBankType +- description: + name: MemoryBankSpec - description: 'The model family and SKU of the model along with other parameters corresponding to the model. @@ -4025,7 +4063,6 @@ x-tagGroups: - Evaluations - Inference - Memory - - MemoryBanks - Models - PostTraining - RewardScoring @@ -4098,6 +4135,8 @@ x-tagGroups: - LoraFinetuningConfig - MemoryBank - MemoryBankDocument + - MemoryBankSpec + - MemoryBankType - MemoryRetrievalStep - MemoryToolDefinition - MetricEvent