From 47e7c2dc15a4f90d3ff9321a5a7a701e52eda729 Mon Sep 17 00:00:00 2001 From: Ashwin Bharambe Date: Mon, 11 Nov 2024 18:44:38 -0800 Subject: [PATCH] Fix openapi generator and regenerator OpenAPI types --- .../strong_typing/inspection.py | 1 + docs/resources/llama-stack-spec.html | 807 +++++++++++++++--- docs/resources/llama-stack-spec.yaml | 593 ++++++++++--- 3 files changed, 1137 insertions(+), 264 deletions(-) diff --git a/docs/openapi_generator/strong_typing/inspection.py b/docs/openapi_generator/strong_typing/inspection.py index cbb2abeb2..c5e7899fa 100644 --- a/docs/openapi_generator/strong_typing/inspection.py +++ b/docs/openapi_generator/strong_typing/inspection.py @@ -358,6 +358,7 @@ def unwrap_union_types(typ: object) -> Tuple[object, ...]: :returns: The inner types `T1`, `T2`, etc. """ + typ = unwrap_annotated_type(typ) return _unwrap_union_types(typ) diff --git a/docs/resources/llama-stack-spec.html b/docs/resources/llama-stack-spec.html index c8905772f..196a400f8 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-11-11 18:11:42.086884" + "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-11 18:44:30.967321" }, "servers": [ { @@ -691,7 +691,7 @@ "schema": { "oneOf": [ { - "$ref": "#/components/schemas/DatasetDefWithProvider" + "$ref": "#/components/schemas/Dataset" }, { "type": "null" @@ -707,7 +707,7 @@ ], "parameters": [ { - "name": "dataset_identifier", + "name": "dataset_id", "in": "query", "required": true, "schema": { @@ -736,7 +736,7 @@ "schema": { "oneOf": [ { - "$ref": "#/components/schemas/EvalTaskDefWithProvider" + "$ref": "#/components/schemas/EvalTask" }, { "type": "null" @@ -783,16 +783,16 @@ { "oneOf": [ { - "$ref": "#/components/schemas/VectorMemoryBankDef" + "$ref": "#/components/schemas/VectorMemoryBank" }, { - "$ref": "#/components/schemas/KeyValueMemoryBankDef" + "$ref": "#/components/schemas/KeyValueMemoryBank" }, { - "$ref": "#/components/schemas/KeywordMemoryBankDef" + "$ref": "#/components/schemas/KeywordMemoryBank" }, { - "$ref": "#/components/schemas/GraphMemoryBankDef" + "$ref": "#/components/schemas/GraphMemoryBank" } ] }, @@ -810,7 +810,7 @@ ], "parameters": [ { - "name": "identifier", + "name": "memory_bank_id", "in": "query", "required": true, "schema": { @@ -946,7 +946,7 @@ "schema": { "oneOf": [ { - "$ref": "#/components/schemas/ScoringFnDefWithProvider" + "$ref": "#/components/schemas/ScoringFn" }, { "type": "null" @@ -962,7 +962,7 @@ ], "parameters": [ { - "name": "name", + "name": "scoring_fn_id", "in": "query", "required": true, "schema": { @@ -1411,7 +1411,7 @@ "content": { "application/jsonl": { "schema": { - "$ref": "#/components/schemas/DatasetDefWithProvider" + "$ref": "#/components/schemas/Dataset" } } } @@ -1441,7 +1441,7 @@ "content": { "application/jsonl": { "schema": { - "$ref": "#/components/schemas/EvalTaskDefWithProvider" + "$ref": "#/components/schemas/EvalTask" } } } @@ -1473,16 +1473,16 @@ "schema": { "oneOf": [ { - "$ref": "#/components/schemas/VectorMemoryBankDef" + "$ref": "#/components/schemas/VectorMemoryBank" }, { - "$ref": "#/components/schemas/KeyValueMemoryBankDef" + "$ref": "#/components/schemas/KeyValueMemoryBank" }, { - "$ref": "#/components/schemas/KeywordMemoryBankDef" + "$ref": "#/components/schemas/KeywordMemoryBank" }, { - "$ref": "#/components/schemas/GraphMemoryBankDef" + "$ref": "#/components/schemas/GraphMemoryBank" } ] } @@ -1613,7 +1613,7 @@ "content": { "application/jsonl": { "schema": { - "$ref": "#/components/schemas/ScoringFnDefWithProvider" + "$ref": "#/components/schemas/ScoringFn" } } } @@ -1846,11 +1846,7 @@ }, "/memory_banks/register": { "post": { - "responses": { - "200": { - "description": "OK" - } - }, + "responses": {}, "tags": [ "MemoryBanks" ], @@ -4948,17 +4944,24 @@ }, "additionalProperties": false }, - "GraphMemoryBankDef": { + "GraphMemoryBank": { "type": "object", "properties": { "identifier": { "type": "string" }, + "provider_resource_id": { + "type": "string" + }, "provider_id": { - "type": "string", - "default": "" + "type": "string" }, "type": { + "type": "string", + "const": "memory_bank", + "default": "memory_bank" + }, + "memory_bank_type": { "type": "string", "const": "graph", "default": "graph" @@ -4967,21 +4970,30 @@ "additionalProperties": false, "required": [ "identifier", + "provider_resource_id", "provider_id", - "type" + "type", + "memory_bank_type" ] }, - "KeyValueMemoryBankDef": { + "KeyValueMemoryBank": { "type": "object", "properties": { "identifier": { "type": "string" }, + "provider_resource_id": { + "type": "string" + }, "provider_id": { - "type": "string", - "default": "" + "type": "string" }, "type": { + "type": "string", + "const": "memory_bank", + "default": "memory_bank" + }, + "memory_bank_type": { "type": "string", "const": "keyvalue", "default": "keyvalue" @@ -4990,21 +5002,30 @@ "additionalProperties": false, "required": [ "identifier", + "provider_resource_id", "provider_id", - "type" + "type", + "memory_bank_type" ] }, - "KeywordMemoryBankDef": { + "KeywordMemoryBank": { "type": "object", "properties": { "identifier": { "type": "string" }, + "provider_resource_id": { + "type": "string" + }, "provider_id": { - "type": "string", - "default": "" + "type": "string" }, "type": { + "type": "string", + "const": "memory_bank", + "default": "memory_bank" + }, + "memory_bank_type": { "type": "string", "const": "keyword", "default": "keyword" @@ -5013,8 +5034,10 @@ "additionalProperties": false, "required": [ "identifier", + "provider_resource_id", "provider_id", - "type" + "type", + "memory_bank_type" ] }, "Session": { @@ -5039,16 +5062,16 @@ "memory_bank": { "oneOf": [ { - "$ref": "#/components/schemas/VectorMemoryBankDef" + "$ref": "#/components/schemas/VectorMemoryBank" }, { - "$ref": "#/components/schemas/KeyValueMemoryBankDef" + "$ref": "#/components/schemas/KeyValueMemoryBank" }, { - "$ref": "#/components/schemas/KeywordMemoryBankDef" + "$ref": "#/components/schemas/KeywordMemoryBank" }, { - "$ref": "#/components/schemas/GraphMemoryBankDef" + "$ref": "#/components/schemas/GraphMemoryBank" } ] } @@ -5062,17 +5085,24 @@ ], "title": "A single session of an interaction with an Agentic System." }, - "VectorMemoryBankDef": { + "VectorMemoryBank": { "type": "object", "properties": { "identifier": { "type": "string" }, + "provider_resource_id": { + "type": "string" + }, "provider_id": { - "type": "string", - "default": "" + "type": "string" }, "type": { + "type": "string", + "const": "memory_bank", + "default": "memory_bank" + }, + "memory_bank_type": { "type": "string", "const": "vector", "default": "vector" @@ -5090,8 +5120,10 @@ "additionalProperties": false, "required": [ "identifier", + "provider_resource_id", "provider_id", "type", + "memory_bank_type", "embedding_model", "chunk_size_in_tokens" ] @@ -5121,13 +5153,24 @@ "step" ] }, - "DatasetDefWithProvider": { + "Dataset": { "type": "object", "properties": { "identifier": { "type": "string" }, - "dataset_schema": { + "provider_resource_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "dataset", + "default": "dataset" + }, + "schema": { "type": "object", "additionalProperties": { "oneOf": [ @@ -5301,32 +5344,36 @@ } ] } - }, - "type": { - "type": "string", - "const": "dataset", - "default": "dataset" - }, - "provider_id": { - "type": "string" } }, "additionalProperties": false, "required": [ "identifier", - "dataset_schema", - "url", - "metadata", + "provider_resource_id", + "provider_id", "type", - "provider_id" + "schema", + "url", + "metadata" ] }, - "EvalTaskDefWithProvider": { + "EvalTask": { "type": "object", "properties": { "identifier": { "type": "string" }, + "provider_resource_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "eval_task", + "default": "eval_task" + }, "dataset_id": { "type": "string" }, @@ -5360,24 +5407,17 @@ } ] } - }, - "type": { - "type": "string", - "const": "eval_task", - "default": "eval_task" - }, - "provider_id": { - "type": "string" } }, "additionalProperties": false, "required": [ "identifier", + "provider_resource_id", + "provider_id", + "type", "dataset_id", "scoring_functions", - "metadata", - "type", - "provider_id" + "metadata" ] }, "Model": { @@ -5476,12 +5516,23 @@ "total_count" ] }, - "ScoringFnDefWithProvider": { + "ScoringFn": { "type": "object", "properties": { "identifier": { "type": "string" }, + "provider_resource_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "scoring_function", + "default": "scoring_function" + }, "description": { "type": "string" }, @@ -5663,23 +5714,16 @@ "$ref": "#/components/schemas/RegexParserScoringFnParams" } ] - }, - "type": { - "type": "string", - "const": "scoring_fn", - "default": "scoring_fn" - }, - "provider_id": { - "type": "string" } }, "additionalProperties": false, "required": [ "identifier", - "metadata", - "return_type", + "provider_resource_id", + "provider_id", "type", - "provider_id" + "metadata", + "return_type" ] }, "Shield": { @@ -6645,50 +6689,352 @@ "RegisterDatasetRequest": { "type": "object", "properties": { - "dataset_def": { - "$ref": "#/components/schemas/DatasetDefWithProvider" + "dataset_id": { + "type": "string" + }, + "schema": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "string", + "default": "string" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "number", + "default": "number" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "boolean", + "default": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "array", + "default": "array" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "object", + "default": "object" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "json", + "default": "json" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "union", + "default": "union" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "chat_completion_input", + "default": "chat_completion_input" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "completion_input", + "default": "completion_input" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "agent_turn_input", + "default": "agent_turn_input" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + } + ] + } + }, + "url": { + "$ref": "#/components/schemas/URL" + }, + "provider_dataset_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } } }, "additionalProperties": false, "required": [ - "dataset_def" + "dataset_id", + "schema", + "url" ] }, "RegisterEvalTaskRequest": { "type": "object", "properties": { - "eval_task_def": { - "$ref": "#/components/schemas/EvalTaskDefWithProvider" + "eval_task_id": { + "type": "string" + }, + "dataset_id": { + "type": "string" + }, + "scoring_functions": { + "type": "array", + "items": { + "type": "string" + } + }, + "provider_eval_task_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } } }, "additionalProperties": false, "required": [ - "eval_task_def" + "eval_task_id", + "dataset_id", + "scoring_functions" + ] + }, + "GraphMemoryBankParams": { + "type": "object", + "properties": { + "memory_bank_type": { + "type": "string", + "const": "graph", + "default": "graph" + } + }, + "additionalProperties": false, + "required": [ + "memory_bank_type" + ] + }, + "KeyValueMemoryBankParams": { + "type": "object", + "properties": { + "memory_bank_type": { + "type": "string", + "const": "keyvalue", + "default": "keyvalue" + } + }, + "additionalProperties": false, + "required": [ + "memory_bank_type" + ] + }, + "KeywordMemoryBankParams": { + "type": "object", + "properties": { + "memory_bank_type": { + "type": "string", + "const": "keyword", + "default": "keyword" + } + }, + "additionalProperties": false, + "required": [ + "memory_bank_type" + ] + }, + "VectorMemoryBankParams": { + "type": "object", + "properties": { + "memory_bank_type": { + "type": "string", + "const": "vector", + "default": "vector" + }, + "embedding_model": { + "type": "string" + }, + "chunk_size_in_tokens": { + "type": "integer" + }, + "overlap_size_in_tokens": { + "type": "integer" + } + }, + "additionalProperties": false, + "required": [ + "memory_bank_type", + "embedding_model", + "chunk_size_in_tokens" ] }, "RegisterMemoryBankRequest": { "type": "object", "properties": { - "memory_bank": { + "memory_bank_id": { + "type": "string" + }, + "params": { "oneOf": [ { - "$ref": "#/components/schemas/VectorMemoryBankDef" + "$ref": "#/components/schemas/VectorMemoryBankParams" }, { - "$ref": "#/components/schemas/KeyValueMemoryBankDef" + "$ref": "#/components/schemas/KeyValueMemoryBankParams" }, { - "$ref": "#/components/schemas/KeywordMemoryBankDef" + "$ref": "#/components/schemas/KeywordMemoryBankParams" }, { - "$ref": "#/components/schemas/GraphMemoryBankDef" + "$ref": "#/components/schemas/GraphMemoryBankParams" } ] + }, + "provider_id": { + "type": "string" + }, + "provider_memorybank_id": { + "type": "string" } }, "additionalProperties": false, "required": [ - "memory_bank" + "memory_bank_id", + "params" ] }, "RegisterModelRequest": { @@ -6737,13 +7083,178 @@ "RegisterScoringFunctionRequest": { "type": "object", "properties": { - "function_def": { - "$ref": "#/components/schemas/ScoringFnDefWithProvider" + "scoring_fn_id": { + "type": "string" + }, + "description": { + "type": "string" + }, + "return_type": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "string", + "default": "string" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "number", + "default": "number" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "boolean", + "default": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "array", + "default": "array" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "object", + "default": "object" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "json", + "default": "json" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "union", + "default": "union" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "chat_completion_input", + "default": "chat_completion_input" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "completion_input", + "default": "completion_input" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "agent_turn_input", + "default": "agent_turn_input" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + } + ] + }, + "provider_scoring_fn_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "params": { + "oneOf": [ + { + "$ref": "#/components/schemas/LLMAsJudgeScoringFnParams" + }, + { + "$ref": "#/components/schemas/RegexParserScoringFnParams" + } + ] } }, "additionalProperties": false, "required": [ - "function_def" + "scoring_fn_id", + "description", + "return_type" ] }, "RegisterShieldRequest": { @@ -7343,59 +7854,59 @@ } ], "tags": [ - { - "name": "Memory" - }, - { - "name": "DatasetIO" - }, { "name": "Datasets" }, - { - "name": "Agents" - }, - { - "name": "Models" - }, { "name": "Telemetry" }, { - "name": "Inference" - }, - { - "name": "Eval" + "name": "PostTraining" }, { "name": "MemoryBanks" }, { - "name": "Scoring" + "name": "Eval" + }, + { + "name": "Memory" }, { "name": "EvalTasks" }, { - "name": "Inspect" + "name": "Models" }, { - "name": "PostTraining" + "name": "Scoring" }, { - "name": "ScoringFunctions" + "name": "Inference" }, { "name": "Shields" }, { - "name": "BatchInference" + "name": "DatasetIO" + }, + { + "name": "Safety" + }, + { + "name": "Agents" }, { "name": "SyntheticDataGeneration" }, { - "name": "Safety" + "name": "ScoringFunctions" + }, + { + "name": "BatchInference" + }, + { + "name": "Inspect" }, { "name": "BuiltinTool", @@ -7698,36 +8209,36 @@ "description": "" }, { - "name": "GraphMemoryBankDef", - "description": "" + "name": "GraphMemoryBank", + "description": "" }, { - "name": "KeyValueMemoryBankDef", - "description": "" + "name": "KeyValueMemoryBank", + "description": "" }, { - "name": "KeywordMemoryBankDef", - "description": "" + "name": "KeywordMemoryBank", + "description": "" }, { "name": "Session", "description": "A single session of an interaction with an Agentic System.\n\n" }, { - "name": "VectorMemoryBankDef", - "description": "" + "name": "VectorMemoryBank", + "description": "" }, { "name": "AgentStepResponse", "description": "" }, { - "name": "DatasetDefWithProvider", - "description": "" + "name": "Dataset", + "description": "" }, { - "name": "EvalTaskDefWithProvider", - "description": "" + "name": "EvalTask", + "description": "" }, { "name": "Model", @@ -7738,8 +8249,8 @@ "description": "" }, { - "name": "ScoringFnDefWithProvider", - "description": "" + "name": "ScoringFn", + "description": "" }, { "name": "Shield", @@ -7873,6 +8384,22 @@ "name": "RegisterEvalTaskRequest", "description": "" }, + { + "name": "GraphMemoryBankParams", + "description": "" + }, + { + "name": "KeyValueMemoryBankParams", + "description": "" + }, + { + "name": "KeywordMemoryBankParams", + "description": "" + }, + { + "name": "VectorMemoryBankParams", + "description": "" + }, { "name": "RegisterMemoryBankRequest", "description": "" @@ -8013,19 +8540,20 @@ "CreateAgentSessionRequest", "CreateAgentTurnRequest", "DPOAlignmentConfig", - "DatasetDefWithProvider", + "Dataset", "DeleteAgentsRequest", "DeleteAgentsSessionRequest", "DoraFinetuningConfig", "EmbeddingsRequest", "EmbeddingsResponse", - "EvalTaskDefWithProvider", + "EvalTask", "EvaluateResponse", "EvaluateRowsRequest", "FinetuningAlgorithm", "FunctionCallToolDefinition", "GetAgentsSessionRequest", - "GraphMemoryBankDef", + "GraphMemoryBank", + "GraphMemoryBankParams", "HealthInfo", "ImageMedia", "InferenceStep", @@ -8033,8 +8561,10 @@ "Job", "JobCancelRequest", "JobStatus", - "KeyValueMemoryBankDef", - "KeywordMemoryBankDef", + "KeyValueMemoryBank", + "KeyValueMemoryBankParams", + "KeywordMemoryBank", + "KeywordMemoryBankParams", "LLMAsJudgeScoringFnParams", "LogEventRequest", "LogSeverity", @@ -8079,7 +8609,7 @@ "ScoreBatchResponse", "ScoreRequest", "ScoreResponse", - "ScoringFnDefWithProvider", + "ScoringFn", "ScoringResult", "SearchToolDefinition", "Session", @@ -8112,7 +8642,8 @@ "URL", "UnstructuredLogEvent", "UserMessage", - "VectorMemoryBankDef", + "VectorMemoryBank", + "VectorMemoryBankParams", "ViolationLevel", "WolframAlphaToolDefinition" ] diff --git a/docs/resources/llama-stack-spec.yaml b/docs/resources/llama-stack-spec.yaml index 995061166..164d3168c 100644 --- a/docs/resources/llama-stack-spec.yaml +++ b/docs/resources/llama-stack-spec.yaml @@ -720,10 +720,26 @@ components: - epsilon - gamma type: object - DatasetDefWithProvider: + Dataset: additionalProperties: false properties: - dataset_schema: + identifier: + type: string + metadata: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + provider_id: + type: string + provider_resource_id: + type: string + schema: additionalProperties: oneOf: - additionalProperties: false @@ -817,20 +833,6 @@ components: - type type: object type: object - identifier: - type: string - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - provider_id: - type: string type: const: dataset default: dataset @@ -839,11 +841,12 @@ components: $ref: '#/components/schemas/URL' required: - identifier - - dataset_schema + - provider_resource_id + - provider_id + - type + - schema - url - metadata - - type - - provider_id type: object DeleteAgentsRequest: additionalProperties: false @@ -918,7 +921,7 @@ components: required: - embeddings type: object - EvalTaskDefWithProvider: + EvalTask: additionalProperties: false properties: dataset_id: @@ -937,6 +940,8 @@ components: type: object provider_id: type: string + provider_resource_id: + type: string scoring_functions: items: type: string @@ -947,11 +952,12 @@ components: type: string required: - identifier + - provider_resource_id + - provider_id + - type - dataset_id - scoring_functions - metadata - - type - - provider_id type: object EvaluateResponse: additionalProperties: false @@ -1053,22 +1059,39 @@ components: type: string type: array type: object - GraphMemoryBankDef: + GraphMemoryBank: additionalProperties: false properties: identifier: type: string + memory_bank_type: + const: graph + default: graph + type: string provider_id: - default: '' + type: string + provider_resource_id: type: string type: + const: memory_bank + default: memory_bank + type: string + required: + - identifier + - provider_resource_id + - provider_id + - type + - memory_bank_type + type: object + GraphMemoryBankParams: + additionalProperties: false + properties: + memory_bank_type: const: graph default: graph type: string required: - - identifier - - provider_id - - type + - memory_bank_type type: object HealthInfo: additionalProperties: false @@ -1159,39 +1182,73 @@ components: - completed - in_progress type: string - KeyValueMemoryBankDef: + KeyValueMemoryBank: additionalProperties: false properties: identifier: type: string + memory_bank_type: + const: keyvalue + default: keyvalue + type: string provider_id: - default: '' + type: string + provider_resource_id: type: string type: + const: memory_bank + default: memory_bank + type: string + required: + - identifier + - provider_resource_id + - provider_id + - type + - memory_bank_type + type: object + KeyValueMemoryBankParams: + additionalProperties: false + properties: + memory_bank_type: const: keyvalue default: keyvalue type: string required: - - identifier - - provider_id - - type + - memory_bank_type type: object - KeywordMemoryBankDef: + KeywordMemoryBank: additionalProperties: false properties: identifier: type: string + memory_bank_type: + const: keyword + default: keyword + type: string provider_id: - default: '' + type: string + provider_resource_id: type: string type: + const: memory_bank + default: memory_bank + type: string + required: + - identifier + - provider_resource_id + - provider_id + - type + - memory_bank_type + type: object + KeywordMemoryBankParams: + additionalProperties: false + properties: + memory_bank_type: const: keyword default: keyword type: string required: - - identifier - - provider_id - - type + - memory_bank_type type: object LLMAsJudgeScoringFnParams: additionalProperties: false @@ -1851,30 +1908,171 @@ components: RegisterDatasetRequest: additionalProperties: false properties: - dataset_def: - $ref: '#/components/schemas/DatasetDefWithProvider' + dataset_id: + type: string + metadata: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + provider_dataset_id: + type: string + provider_id: + type: string + schema: + additionalProperties: + oneOf: + - additionalProperties: false + properties: + type: + const: string + default: string + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: number + default: number + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: boolean + default: boolean + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: array + default: array + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: object + default: object + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: json + default: json + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: union + default: union + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: chat_completion_input + default: chat_completion_input + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: completion_input + default: completion_input + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: agent_turn_input + default: agent_turn_input + type: string + required: + - type + type: object + type: object + url: + $ref: '#/components/schemas/URL' required: - - dataset_def + - dataset_id + - schema + - url type: object RegisterEvalTaskRequest: additionalProperties: false properties: - eval_task_def: - $ref: '#/components/schemas/EvalTaskDefWithProvider' + dataset_id: + type: string + eval_task_id: + type: string + metadata: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + provider_eval_task_id: + type: string + provider_id: + type: string + scoring_functions: + items: + type: string + type: array required: - - eval_task_def + - eval_task_id + - dataset_id + - scoring_functions type: object RegisterMemoryBankRequest: additionalProperties: false properties: - memory_bank: + memory_bank_id: + type: string + params: oneOf: - - $ref: '#/components/schemas/VectorMemoryBankDef' - - $ref: '#/components/schemas/KeyValueMemoryBankDef' - - $ref: '#/components/schemas/KeywordMemoryBankDef' - - $ref: '#/components/schemas/GraphMemoryBankDef' + - $ref: '#/components/schemas/VectorMemoryBankParams' + - $ref: '#/components/schemas/KeyValueMemoryBankParams' + - $ref: '#/components/schemas/KeywordMemoryBankParams' + - $ref: '#/components/schemas/GraphMemoryBankParams' + provider_id: + type: string + provider_memorybank_id: + type: string required: - - memory_bank + - memory_bank_id + - params type: object RegisterModelRequest: additionalProperties: false @@ -1901,10 +2099,114 @@ components: RegisterScoringFunctionRequest: additionalProperties: false properties: - function_def: - $ref: '#/components/schemas/ScoringFnDefWithProvider' + description: + type: string + params: + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + - $ref: '#/components/schemas/RegexParserScoringFnParams' + provider_id: + type: string + provider_scoring_fn_id: + type: string + return_type: + oneOf: + - additionalProperties: false + properties: + type: + const: string + default: string + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: number + default: number + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: boolean + default: boolean + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: array + default: array + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: object + default: object + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: json + default: json + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: union + default: union + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: chat_completion_input + default: chat_completion_input + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: completion_input + default: completion_input + type: string + required: + - type + type: object + - additionalProperties: false + properties: + type: + const: agent_turn_input + default: agent_turn_input + type: string + required: + - type + type: object + scoring_fn_id: + type: string required: - - function_def + - scoring_fn_id + - description + - return_type type: object RegisterShieldRequest: additionalProperties: false @@ -2162,7 +2464,7 @@ components: required: - results type: object - ScoringFnDefWithProvider: + ScoringFn: additionalProperties: false properties: description: @@ -2185,6 +2487,8 @@ components: - $ref: '#/components/schemas/RegexParserScoringFnParams' provider_id: type: string + provider_resource_id: + type: string return_type: oneOf: - additionalProperties: false @@ -2278,15 +2582,16 @@ components: - type type: object type: - const: scoring_fn - default: scoring_fn + const: scoring_function + default: scoring_function type: string required: - identifier + - provider_resource_id + - provider_id + - type - metadata - return_type - - type - - provider_id type: object ScoringResult: additionalProperties: false @@ -2352,10 +2657,10 @@ components: properties: memory_bank: oneOf: - - $ref: '#/components/schemas/VectorMemoryBankDef' - - $ref: '#/components/schemas/KeyValueMemoryBankDef' - - $ref: '#/components/schemas/KeywordMemoryBankDef' - - $ref: '#/components/schemas/GraphMemoryBankDef' + - $ref: '#/components/schemas/VectorMemoryBank' + - $ref: '#/components/schemas/KeyValueMemoryBank' + - $ref: '#/components/schemas/KeywordMemoryBank' + - $ref: '#/components/schemas/GraphMemoryBank' session_id: type: string session_name: @@ -3010,7 +3315,7 @@ components: - role - content type: object - VectorMemoryBankDef: + VectorMemoryBank: additionalProperties: false properties: chunk_size_in_tokens: @@ -3019,19 +3324,44 @@ components: type: string identifier: type: string - overlap_size_in_tokens: - type: integer - provider_id: - default: '' - type: string - type: + memory_bank_type: const: vector default: vector type: string + overlap_size_in_tokens: + type: integer + provider_id: + type: string + provider_resource_id: + type: string + type: + const: memory_bank + default: memory_bank + type: string required: - identifier + - provider_resource_id - provider_id - type + - memory_bank_type + - embedding_model + - chunk_size_in_tokens + type: object + VectorMemoryBankParams: + additionalProperties: false + properties: + chunk_size_in_tokens: + type: integer + embedding_model: + type: string + memory_bank_type: + const: vector + default: vector + type: string + overlap_size_in_tokens: + type: integer + required: + - memory_bank_type - embedding_model - chunk_size_in_tokens type: object @@ -3068,7 +3398,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-11-11 18:11:42.086884" + \ draft and subject to change.\n Generated at 2024-11-11 18:44:30.967321" title: '[DRAFT] Llama Stack Specification' version: 0.0.1 jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema @@ -3395,7 +3725,7 @@ paths: get: parameters: - in: query - name: dataset_identifier + name: dataset_id required: true schema: type: string @@ -3412,7 +3742,7 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/DatasetDefWithProvider' + - $ref: '#/components/schemas/Dataset' - type: 'null' description: OK tags: @@ -3432,7 +3762,7 @@ paths: content: application/jsonl: schema: - $ref: '#/components/schemas/DatasetDefWithProvider' + $ref: '#/components/schemas/Dataset' description: OK tags: - Datasets @@ -3609,7 +3939,7 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/EvalTaskDefWithProvider' + - $ref: '#/components/schemas/EvalTask' - type: 'null' description: OK tags: @@ -3629,7 +3959,7 @@ paths: content: application/jsonl: schema: - $ref: '#/components/schemas/EvalTaskDefWithProvider' + $ref: '#/components/schemas/EvalTask' description: OK tags: - EvalTasks @@ -3802,7 +4132,7 @@ paths: get: parameters: - in: query - name: identifier + name: memory_bank_id required: true schema: type: string @@ -3820,10 +4150,10 @@ paths: schema: oneOf: - oneOf: - - $ref: '#/components/schemas/VectorMemoryBankDef' - - $ref: '#/components/schemas/KeyValueMemoryBankDef' - - $ref: '#/components/schemas/KeywordMemoryBankDef' - - $ref: '#/components/schemas/GraphMemoryBankDef' + - $ref: '#/components/schemas/VectorMemoryBank' + - $ref: '#/components/schemas/KeyValueMemoryBank' + - $ref: '#/components/schemas/KeywordMemoryBank' + - $ref: '#/components/schemas/GraphMemoryBank' - type: 'null' description: OK tags: @@ -3844,10 +4174,10 @@ paths: application/jsonl: schema: oneOf: - - $ref: '#/components/schemas/VectorMemoryBankDef' - - $ref: '#/components/schemas/KeyValueMemoryBankDef' - - $ref: '#/components/schemas/KeywordMemoryBankDef' - - $ref: '#/components/schemas/GraphMemoryBankDef' + - $ref: '#/components/schemas/VectorMemoryBank' + - $ref: '#/components/schemas/KeyValueMemoryBank' + - $ref: '#/components/schemas/KeywordMemoryBank' + - $ref: '#/components/schemas/GraphMemoryBank' description: OK tags: - MemoryBanks @@ -3867,9 +4197,7 @@ paths: schema: $ref: '#/components/schemas/RegisterMemoryBankRequest' required: true - responses: - '200': - description: OK + responses: {} tags: - MemoryBanks /models/get: @@ -4227,7 +4555,7 @@ paths: get: parameters: - in: query - name: name + name: scoring_fn_id required: true schema: type: string @@ -4244,7 +4572,7 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/ScoringFnDefWithProvider' + - $ref: '#/components/schemas/ScoringFn' - type: 'null' description: OK tags: @@ -4264,7 +4592,7 @@ paths: content: application/jsonl: schema: - $ref: '#/components/schemas/ScoringFnDefWithProvider' + $ref: '#/components/schemas/ScoringFn' description: OK tags: - ScoringFunctions @@ -4434,24 +4762,24 @@ security: servers: - url: http://any-hosted-llama-stack.com tags: -- name: Memory -- name: DatasetIO - name: Datasets -- name: Agents -- name: Models - name: Telemetry -- name: Inference -- name: Eval -- name: MemoryBanks -- name: Scoring -- name: EvalTasks -- name: Inspect - name: PostTraining -- name: ScoringFunctions +- name: MemoryBanks +- name: Eval +- name: Memory +- name: EvalTasks +- name: Models +- name: Scoring +- name: Inference - name: Shields -- name: BatchInference -- name: SyntheticDataGeneration +- name: DatasetIO - name: Safety +- name: Agents +- name: SyntheticDataGeneration +- name: ScoringFunctions +- name: BatchInference +- name: Inspect - description: name: BuiltinTool - description: name: GetAgentsSessionRequest -- description: - name: GraphMemoryBankDef -- description: - name: KeyValueMemoryBankDef -- description: - name: KeywordMemoryBankDef + name: KeywordMemoryBank - description: 'A single session of an interaction with an Agentic System. ' name: Session -- description: - name: VectorMemoryBankDef + name: VectorMemoryBank - description: name: AgentStepResponse -- description: - name: DatasetDefWithProvider -- description: - name: EvalTaskDefWithProvider +- description: + name: Dataset +- description: + name: EvalTask - description: name: Model - description: name: PaginatedRowsResult -- description: - name: ScoringFnDefWithProvider +- description: + name: ScoringFn - description: 'A safety shield resource that can be used to check content @@ -4816,6 +5141,18 @@ tags: - description: name: RegisterEvalTaskRequest +- description: + name: GraphMemoryBankParams +- description: + name: KeyValueMemoryBankParams +- description: + name: KeywordMemoryBankParams +- description: + name: VectorMemoryBankParams - description: name: RegisterMemoryBankRequest @@ -4932,19 +5269,20 @@ x-tagGroups: - CreateAgentSessionRequest - CreateAgentTurnRequest - DPOAlignmentConfig - - DatasetDefWithProvider + - Dataset - DeleteAgentsRequest - DeleteAgentsSessionRequest - DoraFinetuningConfig - EmbeddingsRequest - EmbeddingsResponse - - EvalTaskDefWithProvider + - EvalTask - EvaluateResponse - EvaluateRowsRequest - FinetuningAlgorithm - FunctionCallToolDefinition - GetAgentsSessionRequest - - GraphMemoryBankDef + - GraphMemoryBank + - GraphMemoryBankParams - HealthInfo - ImageMedia - InferenceStep @@ -4952,8 +5290,10 @@ x-tagGroups: - Job - JobCancelRequest - JobStatus - - KeyValueMemoryBankDef - - KeywordMemoryBankDef + - KeyValueMemoryBank + - KeyValueMemoryBankParams + - KeywordMemoryBank + - KeywordMemoryBankParams - LLMAsJudgeScoringFnParams - LogEventRequest - LogSeverity @@ -4998,7 +5338,7 @@ x-tagGroups: - ScoreBatchResponse - ScoreRequest - ScoreResponse - - ScoringFnDefWithProvider + - ScoringFn - ScoringResult - SearchToolDefinition - Session @@ -5031,6 +5371,7 @@ x-tagGroups: - URL - UnstructuredLogEvent - UserMessage - - VectorMemoryBankDef + - VectorMemoryBank + - VectorMemoryBankParams - ViolationLevel - WolframAlphaToolDefinition