From 65556d0a1c9e8291bec6936943cdbabae0532769 Mon Sep 17 00:00:00 2001 From: Raghotham Murthy Date: Thu, 11 Jul 2024 01:46:33 -0700 Subject: [PATCH] added more docs --- source/api_definitions.py | 4 +- source/openapi.html | 380 +++++++++++++++++++------------------- source/openapi.yaml | 16 +- 3 files changed, 200 insertions(+), 200 deletions(-) diff --git a/source/api_definitions.py b/source/api_definitions.py index 626fa0bdd..d3ec3ef45 100644 --- a/source/api_definitions.py +++ b/source/api_definitions.py @@ -265,7 +265,7 @@ class AgenticSystem(Protocol): class MemoryBanks(Protocol): @webmethod(route="/memory_banks/create") - def create_memory_bank( + def post_create_memory_bank( self, bank_uuid: str, bank_name: str, @@ -298,7 +298,7 @@ class MemoryBanks(Protocol): ) -> None: ... @webmethod(route="/memory_bank/get") - def post_get_memory_documents( + def get_memory_documents( self, bank_uuid: str, document_uuids: List[str], diff --git a/source/openapi.html b/source/openapi.html index ceb92c59f..fd985c3dc 100644 --- a/source/openapi.html +++ b/source/openapi.html @@ -119,93 +119,6 @@ } } }, - "/memory_banks/create": { - "post": { - "responses": { - "200": { - "description": "OK" - } - }, - "tags": [ - "MemoryBanks" - ], - "parameters": [ - { - "name": "bank_uuid", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "bank_name", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "content": { - "type": "string", - "contentEncoding": "base64" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "mime_type": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uuid", - "content", - "metadata", - "mime_type" - ] - } - } - } - }, - "required": true - } - } - }, "/agentic_system/delete": { "delete": { "responses": { @@ -299,6 +212,48 @@ "parameters": [] } }, + "/memory_bank/get": { + "post": { + "responses": { + "200": { + "description": "OK", + "content": { + "application/jsonl": { + "schema": { + "$ref": "#/components/schemas/MemoryBankDocument" + } + } + } + } + }, + "tags": [ + "MemoryBanks" + ], + "parameters": [ + { + "name": "bank_uuid", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "required": true + } + } + }, "/post_training/job/artifacts": { "get": { "responses": { @@ -520,6 +475,93 @@ } } }, + "/memory_banks/create": { + "post": { + "responses": { + "200": { + "description": "OK" + } + }, + "tags": [ + "MemoryBanks" + ], + "parameters": [ + { + "name": "bank_uuid", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "bank_name", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "uuid": { + "type": "string" + }, + "content": { + "type": "string", + "contentEncoding": "base64" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + }, + "mime_type": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "uuid", + "content", + "metadata", + "mime_type" + ] + } + } + } + }, + "required": true + } + } + }, "/synthetic_data_generation/generate": { "post": { "responses": { @@ -550,48 +592,6 @@ } } }, - "/memory_bank/get": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/jsonl": { - "schema": { - "$ref": "#/components/schemas/MemoryBankDocument" - } - } - } - } - }, - "tags": [ - "MemoryBanks" - ], - "parameters": [ - { - "name": "bank_uuid", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "required": true - } - } - }, "/memory_bank/insert": { "post": { "responses": { @@ -1841,6 +1841,53 @@ "name" ] }, + "MemoryBankDocument": { + "type": "object", + "properties": { + "uuid": { + "type": "string" + }, + "content": { + "type": "string", + "contentEncoding": "base64" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + }, + "mime_type": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "uuid", + "content", + "metadata", + "mime_type" + ] + }, "PostTrainingJobArtifactsResponse": { "type": "object", "properties": { @@ -2815,53 +2862,6 @@ ], "title": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold." }, - "MemoryBankDocument": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "content": { - "type": "string", - "contentEncoding": "base64" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "mime_type": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uuid", - "content", - "metadata", - "mime_type" - ] - }, "DPOAlignmentConfig": { "type": "object", "properties": { @@ -3317,27 +3317,27 @@ } ], "tags": [ + { + "name": "SyntheticDataGeneration" + }, { "name": "RewardScoring" }, - { - "name": "PostTraining" - }, - { - "name": "AgenticSystem" - }, { "name": "Datasets" }, { - "name": "SyntheticDataGeneration" - }, - { - "name": "Inference" + "name": "PostTraining" }, { "name": "MemoryBanks" }, + { + "name": "AgenticSystem" + }, + { + "name": "Inference" + }, { "name": "ShieldConfig", "description": "" @@ -3390,6 +3390,10 @@ "name": "MemoryBank", "description": "" }, + { + "name": "MemoryBankDocument", + "description": "" + }, { "name": "PostTrainingJobArtifactsResponse", "description": "Artifacts of a finetuning job.\n\n" @@ -3454,10 +3458,6 @@ "name": "SyntheticDataGenerationResponse", "description": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold.\n\n" }, - { - "name": "MemoryBankDocument", - "description": "" - }, { "name": "DPOAlignmentConfig", "description": "" diff --git a/source/openapi.yaml b/source/openapi.yaml index dc25460bf..3c66eba3b 100644 --- a/source/openapi.yaml +++ b/source/openapi.yaml @@ -2015,13 +2015,13 @@ security: servers: - url: http://any-hosted-llama-stack.com tags: -- name: RewardScoring -- name: PostTraining -- name: AgenticSystem -- name: Datasets - name: SyntheticDataGeneration -- name: Inference +- name: RewardScoring +- name: Datasets +- name: PostTraining - name: MemoryBanks +- name: AgenticSystem +- name: Inference - description: name: ShieldConfig - description: name: MemoryBank +- description: + name: MemoryBankDocument - description: 'Artifacts of a finetuning job. @@ -2145,9 +2148,6 @@ tags: ' name: SyntheticDataGenerationResponse -- description: - name: MemoryBankDocument - description: name: DPOAlignmentConfig