phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-07-31 16:01:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

openapi gen

Browse source
This commit is contained in:
Xi Yan 2024-11-07 23:17:10 -08:00
parent 8b018c4b78
commit 72b2c885ee
3 changed files with 356 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/openapi_generator/generate.py
View file

@ -49,6 +49,7 @@ from llama_stack.apis.models import * # noqa: F403
from llama_stack.apis.memory_banks import * # noqa: F403 from llama_stack.apis.memory_banks import * # noqa: F403
from llama_stack.apis.shields import * # noqa: F403 from llama_stack.apis.shields import * # noqa: F403
from llama_stack.apis.inspect import * # noqa: F403 from llama_stack.apis.inspect import * # noqa: F403
from llama_stack.apis.eval_tasks import * # noqa: F403
class LlamaStack( class LlamaStack(
@ -63,6 +64,7 @@ class LlamaStack(
PostTraining, PostTraining,
Memory, Memory,
Eval, Eval,
EvalTasks,
Scoring, Scoring,
ScoringFunctions, ScoringFunctions,
DatasetIO, DatasetIO,

245
docs/resources/llama-stack-spec.html
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-07 22:26:27.169134" "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-07 22:57:18.550543"
}, },
"servers": [ "servers": [
{ {
@ -726,6 +726,51 @@
] ]
} }
}, },
"/eval_tasks/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/EvalTaskDefWithProvider"
},
{
"type": "null"
}
]
}
}
}
}
},
"tags": [
"EvalTasks"
],
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"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"
}
}
]
}
},
"/memory_banks/get": { "/memory_banks/get": {
"get": { "get": {
"responses": { "responses": {
@ -1388,6 +1433,36 @@
] ]
} }
}, },
"/eval_tasks/list": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/EvalTaskDefWithProvider"
}
}
}
}
},
"tags": [
"EvalTasks"
],
"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"
}
}
]
}
},
"/memory_banks/list": { "/memory_banks/list": {
"get": { "get": {
"responses": { "responses": {
@ -1736,6 +1811,39 @@
} }
} }
}, },
"/eval_tasks/register": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"EvalTasks"
],
"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/RegisterEvalTaskRequest"
}
}
},
"required": true
}
}
},
"/memory_banks/register": { "/memory_banks/register": {
"post": { "post": {
"responses": { "responses": {
@ -5199,6 +5307,65 @@
"provider_id" "provider_id"
] ]
}, },
"EvalTaskDefWithProvider": {
"type": "object",
"properties": {
"identifier": {
"type": "string"
},
"dataset_id": {
"type": "string"
},
"scoring_functions": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"type": {
"type": "string",
"const": "eval_task",
"default": "eval_task"
},
"provider_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"identifier",
"dataset_id",
"scoring_functions",
"metadata",
"type",
"provider_id"
]
},
"ModelDefWithProvider": { "ModelDefWithProvider": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -6459,6 +6626,18 @@
"dataset_def" "dataset_def"
] ]
}, },
"RegisterEvalTaskRequest": {
"type": "object",
"properties": {
"eval_task_def": {
"$ref": "#/components/schemas/EvalTaskDefWithProvider"
}
},
"additionalProperties": false,
"required": [
"eval_task_def"
]
},
"RegisterMemoryBankRequest": { "RegisterMemoryBankRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -7071,55 +7250,58 @@
], ],
"tags": [ "tags": [
{ {
"name": "ScoringFunctions" "name": "Inspect"
},
{
"name": "Agents"
},
{
"name": "Shields"
},
{
"name": "Telemetry"
},
{
"name": "Safety"
}, },
{ {
"name": "MemoryBanks" "name": "MemoryBanks"
}, },
{ {
"name": "Models" "name": "Safety"
}, },
{ {
"name": "BatchInference" "name": "BatchInference"
}, },
{ {
"name": "PostTraining" "name": "Telemetry"
},
{
"name": "Inference"
},
{
"name": "Datasets"
}, },
{ {
"name": "DatasetIO" "name": "DatasetIO"
}, },
{ {
"name": "SyntheticDataGeneration" "name": "Models"
}, },
{ {
"name": "Memory" "name": "Shields"
},
{
"name": "Scoring"
},
{
"name": "Datasets"
},
{
"name": "Agents"
},
{
"name": "PostTraining"
}, },
{ {
"name": "Eval" "name": "Eval"
}, },
{ {
"name": "Inspect" "name": "ScoringFunctions"
}, },
{ {
"name": "Scoring" "name": "EvalTasks"
},
{
"name": "Memory"
},
{
"name": "SyntheticDataGeneration"
},
{
"name": "Inference"
}, },
{ {
"name": "BuiltinTool", "name": "BuiltinTool",
@ -7449,6 +7631,10 @@
"name": "DatasetDefWithProvider", "name": "DatasetDefWithProvider",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DatasetDefWithProvider\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DatasetDefWithProvider\" />"
}, },
{
"name": "EvalTaskDefWithProvider",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvalTaskDefWithProvider\" />"
},
{ {
"name": "ModelDefWithProvider", "name": "ModelDefWithProvider",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ModelDefWithProvider\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ModelDefWithProvider\" />"
@ -7585,6 +7771,10 @@
"name": "RegisterDatasetRequest", "name": "RegisterDatasetRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterDatasetRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterDatasetRequest\" />"
}, },
{
"name": "RegisterEvalTaskRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterEvalTaskRequest\" />"
},
{ {
"name": "RegisterMemoryBankRequest", "name": "RegisterMemoryBankRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterMemoryBankRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterMemoryBankRequest\" />"
@ -7671,6 +7861,7 @@
"DatasetIO", "DatasetIO",
"Datasets", "Datasets",
"Eval", "Eval",
"EvalTasks",
"Inference", "Inference",
"Inspect", "Inspect",
"Memory", "Memory",
@ -7730,6 +7921,7 @@
"DoraFinetuningConfig", "DoraFinetuningConfig",
"EmbeddingsRequest", "EmbeddingsRequest",
"EmbeddingsResponse", "EmbeddingsResponse",
"EvalTaskDefWithProvider",
"EvaluateResponse", "EvaluateResponse",
"EvaluateRowsRequest", "EvaluateRowsRequest",
"FinetuningAlgorithm", "FinetuningAlgorithm",
@ -7771,6 +7963,7 @@
"RLHFAlgorithm", "RLHFAlgorithm",
"RegexParserScoringFnParams", "RegexParserScoringFnParams",
"RegisterDatasetRequest", "RegisterDatasetRequest",
"RegisterEvalTaskRequest",
"RegisterMemoryBankRequest", "RegisterMemoryBankRequest",
"RegisterModelRequest", "RegisterModelRequest",
"RegisterScoringFunctionRequest", "RegisterScoringFunctionRequest",

151
docs/resources/llama-stack-spec.yaml
View file

@ -918,6 +918,41 @@ components:
required: required:
- embeddings - embeddings
type: object type: object
EvalTaskDefWithProvider:
additionalProperties: false
properties:
dataset_id:
type: string
identifier:
type: string
metadata:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
provider_id:
type: string
scoring_functions:
items:
type: string
type: array
type:
const: eval_task
default: eval_task
type: string
required:
- identifier
- dataset_id
- scoring_functions
- metadata
- type
- provider_id
type: object
EvaluateResponse: EvaluateResponse:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1821,6 +1856,14 @@ components:
required: required:
- dataset_def - dataset_def
type: object type: object
RegisterEvalTaskRequest:
additionalProperties: false
properties:
eval_task_def:
$ref: '#/components/schemas/EvalTaskDefWithProvider'
required:
- eval_task_def
type: object
RegisterMemoryBankRequest: RegisterMemoryBankRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -2983,7 +3026,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-07 22:26:27.169134" \ draft and subject to change.\n Generated at 2024-11-07 22:57:18.550543"
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
@ -3503,6 +3546,72 @@ paths:
description: OK description: OK
tags: tags:
- Eval - Eval
/eval_tasks/get:
get:
parameters:
- in: query
name: name
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/EvalTaskDefWithProvider'
- type: 'null'
description: OK
tags:
- EvalTasks
/eval_tasks/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/EvalTaskDefWithProvider'
description: OK
tags:
- EvalTasks
/eval_tasks/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/RegisterEvalTaskRequest'
required: true
responses:
'200':
description: OK
tags:
- EvalTasks
/health: /health:
get: get:
parameters: parameters:
@ -4275,23 +4384,24 @@ security:
servers: servers:
- url: http://any-hosted-llama-stack.com - url: http://any-hosted-llama-stack.com
tags: tags:
- name: ScoringFunctions
- name: Agents
- name: Shields
- name: Telemetry
- name: Safety
- name: MemoryBanks
- name: Models
- name: BatchInference
- name: PostTraining
- name: Inference
- name: Datasets
- name: DatasetIO
- name: SyntheticDataGeneration
- name: Memory
- name: Eval
- name: Inspect - name: Inspect
- name: MemoryBanks
- name: Safety
- name: BatchInference
- name: Telemetry
- name: DatasetIO
- name: Models
- name: Shields
- name: Scoring - name: Scoring
- name: Datasets
- name: Agents
- name: PostTraining
- name: Eval
- name: ScoringFunctions
- name: EvalTasks
- name: Memory
- name: SyntheticDataGeneration
- name: Inference
- description: <SchemaDefinition schemaRef="#/components/schemas/BuiltinTool" /> - description: <SchemaDefinition schemaRef="#/components/schemas/BuiltinTool" />
name: BuiltinTool name: BuiltinTool
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionMessage" - description: <SchemaDefinition schemaRef="#/components/schemas/CompletionMessage"
@ -4546,6 +4656,9 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/DatasetDefWithProvider" - description: <SchemaDefinition schemaRef="#/components/schemas/DatasetDefWithProvider"
/> />
name: DatasetDefWithProvider name: DatasetDefWithProvider
- description: <SchemaDefinition schemaRef="#/components/schemas/EvalTaskDefWithProvider"
/>
name: EvalTaskDefWithProvider
- description: <SchemaDefinition schemaRef="#/components/schemas/ModelDefWithProvider" - description: <SchemaDefinition schemaRef="#/components/schemas/ModelDefWithProvider"
/> />
name: ModelDefWithProvider name: ModelDefWithProvider
@ -4647,6 +4760,9 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterDatasetRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/RegisterDatasetRequest"
/> />
name: RegisterDatasetRequest name: RegisterDatasetRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterEvalTaskRequest"
/>
name: RegisterEvalTaskRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterMemoryBankRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/RegisterMemoryBankRequest"
/> />
name: RegisterMemoryBankRequest name: RegisterMemoryBankRequest
@ -4712,6 +4828,7 @@ x-tagGroups:
- DatasetIO - DatasetIO
- Datasets - Datasets
- Eval - Eval
- EvalTasks
- Inference - Inference
- Inspect - Inspect
- Memory - Memory
@ -4768,6 +4885,7 @@ x-tagGroups:
- DoraFinetuningConfig - DoraFinetuningConfig
- EmbeddingsRequest - EmbeddingsRequest
- EmbeddingsResponse - EmbeddingsResponse
- EvalTaskDefWithProvider
- EvaluateResponse - EvaluateResponse
- EvaluateRowsRequest - EvaluateRowsRequest
- FinetuningAlgorithm - FinetuningAlgorithm
@ -4809,6 +4927,7 @@ x-tagGroups:
- RLHFAlgorithm - RLHFAlgorithm
- RegexParserScoringFnParams - RegexParserScoringFnParams
- RegisterDatasetRequest - RegisterDatasetRequest
- RegisterEvalTaskRequest
- RegisterMemoryBankRequest - RegisterMemoryBankRequest
- RegisterModelRequest - RegisterModelRequest
- RegisterScoringFunctionRequest - RegisterScoringFunctionRequest