From c10bd38d8b85f6bf5ff13c8d0742b057bfa83509 Mon Sep 17 00:00:00 2001 From: Dalton Flanagan <6599399+dltn@users.noreply.github.com> Date: Thu, 10 Oct 2024 11:45:48 -0400 Subject: [PATCH] update spec --- Sources/LlamaStackClient/openapi.yaml | 807 ++++++++++++-------------- llama-stack | 2 +- 2 files changed, 360 insertions(+), 449 deletions(-) diff --git a/Sources/LlamaStackClient/openapi.yaml b/Sources/LlamaStackClient/openapi.yaml index e88e1f3..1724312 100644 --- a/Sources/LlamaStackClient/openapi.yaml +++ b/Sources/LlamaStackClient/openapi.yaml @@ -579,63 +579,6 @@ components: - uuid - dataset type: object - CreateMemoryBankRequest: - additionalProperties: false - properties: - config: - oneOf: - - additionalProperties: false - properties: - chunk_size_in_tokens: - type: integer - embedding_model: - type: string - overlap_size_in_tokens: - type: integer - type: - const: vector - default: vector - type: string - required: - - type - - embedding_model - - chunk_size_in_tokens - type: object - - additionalProperties: false - properties: - type: - const: keyvalue - default: keyvalue - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: keyword - default: keyword - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: graph - default: graph - type: string - required: - - type - type: object - name: - type: string - url: - $ref: '#/components/schemas/URL' - required: - - name - - config - type: object DPOAlignmentConfig: additionalProperties: false properties: @@ -680,19 +623,6 @@ components: required: - dataset_uuid type: object - DeleteDocumentsRequest: - additionalProperties: false - properties: - bank_id: - type: string - document_ids: - items: - type: string - type: array - required: - - bank_id - - document_ids - type: object DialogGenerations: additionalProperties: false properties: @@ -738,14 +668,6 @@ components: - rank - alpha type: object - DropMemoryBankRequest: - additionalProperties: false - properties: - bank_id: - type: string - required: - - bank_id - type: object EmbeddingsRequest: additionalProperties: false properties: @@ -897,15 +819,30 @@ components: type: string type: array type: object - GetDocumentsRequest: + GraphMemoryBankDef: additionalProperties: false properties: - document_ids: - items: - type: string - type: array + identifier: + type: string + provider_id: + default: '' + type: string + type: + const: graph + default: graph + type: string + required: + - identifier + - provider_id + - type + type: object + HealthInfo: + additionalProperties: false + properties: + status: + type: string required: - - document_ids + - status type: object ImageMedia: additionalProperties: false @@ -964,6 +901,40 @@ components: - bank_id - documents type: object + KeyValueMemoryBankDef: + additionalProperties: false + properties: + identifier: + type: string + provider_id: + default: '' + type: string + type: + const: keyvalue + default: keyvalue + type: string + required: + - identifier + - provider_id + - type + type: object + KeywordMemoryBankDef: + additionalProperties: false + properties: + identifier: + type: string + provider_id: + default: '' + type: string + type: + const: keyword + default: keyword + type: string + required: + - identifier + - provider_id + - type + type: object LogEventRequest: additionalProperties: false properties: @@ -1006,66 +977,6 @@ components: - rank - alpha type: object - MemoryBank: - additionalProperties: false - properties: - bank_id: - type: string - config: - oneOf: - - additionalProperties: false - properties: - chunk_size_in_tokens: - type: integer - embedding_model: - type: string - overlap_size_in_tokens: - type: integer - type: - const: vector - default: vector - type: string - required: - - type - - embedding_model - - chunk_size_in_tokens - type: object - - additionalProperties: false - properties: - type: - const: keyvalue - default: keyvalue - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: keyword - default: keyword - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: graph - default: graph - type: string - required: - - type - type: object - name: - type: string - url: - $ref: '#/components/schemas/URL' - required: - - bank_id - - name - - config - type: object MemoryBankDocument: additionalProperties: false properties: @@ -1097,40 +1008,6 @@ components: - content - metadata type: object - MemoryBankSpec: - additionalProperties: false - properties: - bank_type: - $ref: '#/components/schemas/MemoryBankType' - provider_config: - additionalProperties: false - properties: - config: - additionalProperties: - oneOf: - - 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: @@ -1337,35 +1214,29 @@ components: - value - unit type: object - Model: - description: The model family and SKU of the model along with other parameters - corresponding to the model. - ModelServingSpec: + ModelDefWithProvider: additionalProperties: false properties: + identifier: + type: string llama_model: - $ref: '#/components/schemas/Model' - provider_config: - additionalProperties: false - properties: - config: - additionalProperties: - oneOf: - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - provider_id: - type: string - required: - - provider_id - - config + type: string + metadata: + additionalProperties: + oneOf: + - type: boolean + - type: number + - type: string + - type: array + - type: object type: object + provider_id: + type: string required: + - identifier - llama_model - - provider_config + - metadata + - provider_id type: object OptimizerConfig: additionalProperties: false @@ -1535,6 +1406,17 @@ components: - hyperparam_search_config - logger_config type: object + ProviderInfo: + additionalProperties: false + properties: + provider_id: + type: string + provider_type: + type: string + required: + - provider_id + - provider_type + type: object QLoraFinetuningConfig: additionalProperties: false properties: @@ -1622,6 +1504,34 @@ components: enum: - dpo type: string + RegisterMemoryBankRequest: + additionalProperties: false + properties: + memory_bank: + oneOf: + - $ref: '#/components/schemas/VectorMemoryBankDef' + - $ref: '#/components/schemas/KeyValueMemoryBankDef' + - $ref: '#/components/schemas/KeywordMemoryBankDef' + - $ref: '#/components/schemas/GraphMemoryBankDef' + required: + - memory_bank + type: object + RegisterModelRequest: + additionalProperties: false + properties: + model: + $ref: '#/components/schemas/ModelDefWithProvider' + required: + - model + type: object + RegisterShieldRequest: + additionalProperties: false + properties: + shield: + $ref: '#/components/schemas/ShieldDefWithProvider' + required: + - shield + type: object RestAPIExecutionConfig: additionalProperties: false properties: @@ -1692,6 +1602,22 @@ components: title: Response from the reward scoring. Batch of (prompt, response, score) tuples that pass the threshold. type: object + RouteInfo: + additionalProperties: false + properties: + method: + type: string + provider_types: + items: + type: string + type: array + route: + type: string + required: + - route + - method + - provider_types + type: object RunShieldRequest: additionalProperties: false properties: @@ -1843,7 +1769,11 @@ components: additionalProperties: false properties: memory_bank: - $ref: '#/components/schemas/MemoryBank' + oneOf: + - $ref: '#/components/schemas/VectorMemoryBankDef' + - $ref: '#/components/schemas/KeyValueMemoryBankDef' + - $ref: '#/components/schemas/KeywordMemoryBankDef' + - $ref: '#/components/schemas/GraphMemoryBankDef' session_id: type: string session_name: @@ -1886,32 +1816,29 @@ components: - step_id - step_type type: object - ShieldSpec: + ShieldDefWithProvider: additionalProperties: false properties: - provider_config: - additionalProperties: false - properties: - config: - additionalProperties: - oneOf: - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - provider_id: - type: string - required: - - provider_id - - config + identifier: + type: string + params: + additionalProperties: + oneOf: + - type: boolean + - type: number + - type: string + - type: array + - type: object type: object - shield_type: + provider_id: + type: string + type: type: string required: - - shield_type - - provider_config + - identifier + - type + - params + - provider_id type: object SpanEndPayload: additionalProperties: false @@ -2469,19 +2396,6 @@ components: - message - severity type: object - UpdateDocumentsRequest: - additionalProperties: false - properties: - bank_id: - type: string - documents: - items: - $ref: '#/components/schemas/MemoryBankDocument' - type: array - required: - - bank_id - - documents - type: object UserMessage: additionalProperties: false properties: @@ -2511,6 +2425,31 @@ components: - role - content type: object + VectorMemoryBankDef: + additionalProperties: false + properties: + chunk_size_in_tokens: + type: integer + embedding_model: + type: string + identifier: + type: string + overlap_size_in_tokens: + type: integer + provider_id: + default: '' + type: string + type: + const: vector + default: vector + type: string + required: + - identifier + - provider_id + - type + - embedding_model + - chunk_size_in_tokens + type: object ViolationLevel: enum: - info @@ -2544,7 +2483,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-10-10 11:24:03.032659" + \ draft and subject to change.\n Generated at 2024-10-10 11:45:18.128472" title: '[DRAFT] Llama Stack Specification' version: 0.0.1 jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema @@ -2730,7 +2669,7 @@ paths: responses: '200': content: - text/event-stream: + application/json: schema: $ref: '#/components/schemas/AgentTurnResponseStreamChunk' description: OK @@ -3068,6 +3007,25 @@ paths: description: OK tags: - Evaluations + /health: + 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/json: + schema: + $ref: '#/components/schemas/HealthInfo' + description: OK + tags: + - Inspect /inference/chat_completion: post: parameters: @@ -3147,60 +3105,9 @@ paths: description: OK tags: - Inference - /memory/create: - 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/CreateMemoryBankRequest' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MemoryBank' - description: OK - tags: - - Memory - /memory/documents/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/DeleteDocumentsRequest' - required: true - responses: - '200': - description: OK - tags: - - Memory - /memory/documents/get: + /memory/insert: post: 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 @@ -3212,18 +3119,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetDocumentsRequest' + $ref: '#/components/schemas/InsertDocumentsRequest' required: true responses: '200': - content: - application/jsonl: - schema: - $ref: '#/components/schemas/MemoryBankDocument' description: OK tags: - Memory - /memory/drop: + /memory/query: post: parameters: - description: JSON-encoded provider data which will be made available to the @@ -3237,22 +3140,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DropMemoryBankRequest' + $ref: '#/components/schemas/QueryDocumentsRequest' required: true responses: '200': content: application/json: schema: - type: string + $ref: '#/components/schemas/QueryDocumentsResponse' description: OK tags: - Memory - /memory/get: + /memory_banks/get: get: parameters: - in: query - name: bank_id + name: identifier required: true schema: type: string @@ -3269,32 +3172,15 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/MemoryBank' - description: OK - tags: - - Memory - /memory/insert: - 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/InsertDocumentsRequest' - required: true - responses: - '200': + - oneOf: + - $ref: '#/components/schemas/VectorMemoryBankDef' + - $ref: '#/components/schemas/KeyValueMemoryBankDef' + - $ref: '#/components/schemas/KeywordMemoryBankDef' + - $ref: '#/components/schemas/GraphMemoryBankDef' description: OK tags: - - Memory - /memory/list: + - MemoryBanks + /memory_banks/list: get: parameters: - description: JSON-encoded provider data which will be made available to the @@ -3309,36 +3195,15 @@ paths: content: application/jsonl: schema: - $ref: '#/components/schemas/MemoryBank' - description: OK - tags: - - Memory - /memory/query: - 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/QueryDocumentsRequest' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/QueryDocumentsResponse' + oneOf: + - $ref: '#/components/schemas/VectorMemoryBankDef' + - $ref: '#/components/schemas/KeyValueMemoryBankDef' + - $ref: '#/components/schemas/KeywordMemoryBankDef' + - $ref: '#/components/schemas/GraphMemoryBankDef' description: OK tags: - - Memory - /memory/update: + - MemoryBanks + /memory_banks/register: post: parameters: - description: JSON-encoded provider data which will be made available to the @@ -3352,21 +3217,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateDocumentsRequest' + $ref: '#/components/schemas/RegisterMemoryBankRequest' required: true responses: '200': description: OK tags: - - Memory - /memory_banks/get: + - MemoryBanks + /models/get: get: parameters: - in: query - name: bank_type + name: identifier required: true schema: - $ref: '#/components/schemas/MemoryBankType' + type: string - description: JSON-encoded provider data which will be made available to the adapter servicing the API in: header @@ -3380,11 +3245,11 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/MemoryBankSpec' + - $ref: '#/components/schemas/ModelDefWithProvider' description: OK tags: - - MemoryBanks - /memory_banks/list: + - Models + /models/list: get: parameters: - description: JSON-encoded provider data which will be made available to the @@ -3399,37 +3264,12 @@ paths: content: application/jsonl: schema: - $ref: '#/components/schemas/MemoryBankSpec' - description: OK - tags: - - MemoryBanks - /models/get: - get: - parameters: - - in: query - name: core_model_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/ModelServingSpec' + $ref: '#/components/schemas/ModelDefWithProvider' description: OK tags: - Models - /models/list: - get: + /models/register: + post: parameters: - description: JSON-encoded provider data which will be made available to the adapter servicing the API @@ -3438,12 +3278,14 @@ paths: required: false schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegisterModelRequest' + required: true responses: '200': - content: - application/jsonl: - schema: - $ref: '#/components/schemas/ModelServingSpec' description: OK tags: - Models @@ -3609,6 +3451,27 @@ paths: description: OK tags: - PostTraining + /providers/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/json: + schema: + additionalProperties: + $ref: '#/components/schemas/ProviderInfo' + type: object + description: OK + tags: + - Inspect /reward_scoring/score: post: parameters: @@ -3634,6 +3497,29 @@ paths: description: OK tags: - RewardScoring + /routes/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/json: + schema: + additionalProperties: + items: + $ref: '#/components/schemas/RouteInfo' + type: array + type: object + description: OK + tags: + - Inspect /safety/run_shield: post: parameters: @@ -3680,7 +3566,7 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/ShieldSpec' + - $ref: '#/components/schemas/ShieldDefWithProvider' description: OK tags: - Shields @@ -3699,7 +3585,28 @@ paths: content: application/jsonl: schema: - $ref: '#/components/schemas/ShieldSpec' + $ref: '#/components/schemas/ShieldDefWithProvider' + description: OK + tags: + - Shields + /shields/register: + 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/RegisterShieldRequest' + required: true + responses: + '200': description: OK tags: - Shields @@ -3776,20 +3683,21 @@ paths: servers: - url: http://any-hosted-llama-stack.com tags: -- name: Shields - name: BatchInference +- name: Shields +- name: RewardScoring +- name: Inference +- name: Inspect - name: PostTraining -- name: Memory -- name: Evaluations -- name: Datasets -- name: Models +- name: Agents - name: MemoryBanks -- name: Inference -- name: RewardScoring -- name: Safety - name: Telemetry -- name: Agents - name: SyntheticDataGeneration +- name: Evaluations +- name: Models +- name: Memory +- name: Datasets +- name: Safety - description: name: BuiltinTool - description: name: CreateDatasetRequest -- description: - name: CreateMemoryBankRequest -- description: - name: MemoryBank - description: name: DeleteAgentsRequest @@ -4007,12 +3910,6 @@ tags: - description: name: DeleteDatasetRequest -- description: - name: DeleteDocumentsRequest -- description: - name: DropMemoryBankRequest - description: name: EmbeddingsRequest @@ -4033,20 +3930,26 @@ tags: - description: name: GetAgentsSessionRequest +- description: + name: GraphMemoryBankDef +- description: + name: KeyValueMemoryBankDef +- description: + name: KeywordMemoryBankDef - description: 'A single session of an interaction with an Agentic System. ' name: Session +- description: + name: VectorMemoryBankDef - description: name: AgentStepResponse -- description: - name: GetDocumentsRequest -- description: - name: MemoryBankDocument - description: 'Artifacts of a evaluation job. @@ -4059,21 +3962,12 @@ tags: - description: name: EvaluationJobStatusResponse -- description: 'The model family and SKU of the model along with other parameters - corresponding to the model. - - - ' - name: Model -- description: + name: ModelDefWithProvider +- description: - name: ModelServingSpec -- description: - name: MemoryBankType -- description: - name: MemoryBankSpec -- description: - name: ShieldSpec + name: ShieldDefWithProvider - description: name: Trace - description: 'Checkpoint created during training runs @@ -4104,9 +3998,18 @@ tags: - description: name: PostTrainingJob +- description: + name: HealthInfo +- description: + name: MemoryBankDocument - description: name: InsertDocumentsRequest +- description: + name: ProviderInfo +- description: + name: RouteInfo - description: name: LogSeverity - description: @@ -4146,6 +4049,15 @@ tags: - description: name: QueryDocumentsResponse +- description: + name: RegisterMemoryBankRequest +- description: + name: RegisterModelRequest +- description: + name: RegisterShieldRequest - description: name: DialogGenerations @@ -4194,9 +4106,6 @@ tags: ' name: SyntheticDataGenerationResponse -- description: - name: UpdateDocumentsRequest x-tagGroups: - name: Operations tags: @@ -4205,6 +4114,7 @@ x-tagGroups: - Datasets - Evaluations - Inference + - Inspect - Memory - MemoryBanks - Models @@ -4250,15 +4160,12 @@ x-tagGroups: - CreateAgentSessionRequest - CreateAgentTurnRequest - CreateDatasetRequest - - CreateMemoryBankRequest - DPOAlignmentConfig - DeleteAgentsRequest - DeleteAgentsSessionRequest - DeleteDatasetRequest - - DeleteDocumentsRequest - DialogGenerations - DoraFinetuningConfig - - DropMemoryBankRequest - EmbeddingsRequest - EmbeddingsResponse - EvaluateQuestionAnsweringRequest @@ -4271,22 +4178,21 @@ x-tagGroups: - FinetuningAlgorithm - FunctionCallToolDefinition - GetAgentsSessionRequest - - GetDocumentsRequest + - GraphMemoryBankDef + - HealthInfo - ImageMedia - InferenceStep - InsertDocumentsRequest + - KeyValueMemoryBankDef + - KeywordMemoryBankDef - LogEventRequest - LogSeverity - LoraFinetuningConfig - - MemoryBank - MemoryBankDocument - - MemoryBankSpec - - MemoryBankType - MemoryRetrievalStep - MemoryToolDefinition - MetricEvent - - Model - - ModelServingSpec + - ModelDefWithProvider - OptimizerConfig - PhotogenToolDefinition - PostTrainingJob @@ -4295,14 +4201,19 @@ x-tagGroups: - PostTrainingJobStatus - PostTrainingJobStatusResponse - PreferenceOptimizeRequest + - ProviderInfo - QLoraFinetuningConfig - QueryDocumentsRequest - QueryDocumentsResponse - RLHFAlgorithm + - RegisterMemoryBankRequest + - RegisterModelRequest + - RegisterShieldRequest - RestAPIExecutionConfig - RestAPIMethod - RewardScoreRequest - RewardScoringResponse + - RouteInfo - RunShieldRequest - RunShieldResponse - SafetyViolation @@ -4313,7 +4224,7 @@ x-tagGroups: - SearchToolDefinition - Session - ShieldCallStep - - ShieldSpec + - ShieldDefWithProvider - SpanEndPayload - SpanStartPayload - SpanStatus @@ -4341,7 +4252,7 @@ x-tagGroups: - Turn - URL - UnstructuredLogEvent - - UpdateDocumentsRequest - UserMessage + - VectorMemoryBankDef - ViolationLevel - WolframAlphaToolDefinition diff --git a/llama-stack b/llama-stack index e617273..dd9d34c 160000 --- a/llama-stack +++ b/llama-stack @@ -1 +1 @@ -Subproject commit e617273d8c023148565d8a3134e03545dadc4dab +Subproject commit dd9d34cf7d7c632b553d722438928a2ebef3d077