phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-07-29 15:23:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update openAPI

Browse source
This commit is contained in:
Xi Yan 2024-09-23 09:14:57 -07:00
parent ddebf9b6e7
commit 9210ee2c84
3 changed files with 491 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/openapi_generator/generate.py
View file

@ -43,6 +43,9 @@ from llama_stack.apis.post_training import * # noqa: F403
from llama_stack.apis.reward_scoring import * # noqa: F403 from llama_stack.apis.reward_scoring import * # noqa: F403
from llama_stack.apis.synthetic_data_generation import * # noqa: F403 from llama_stack.apis.synthetic_data_generation import * # noqa: F403
from llama_stack.apis.safety import * # noqa: F403 from llama_stack.apis.safety import * # noqa: F403
from llama_stack.apis.models import * # noqa: F403
from llama_stack.apis.memory_banks import * # noqa: F403
from llama_stack.apis.shields import * # noqa: F403
class LlamaStack( class LlamaStack(
@ -57,6 +60,9 @@ class LlamaStack(
PostTraining, PostTraining,
Memory, Memory,
Evaluations, Evaluations,
Models,
MemoryBanks,
Shields,
): ):
pass pass

328
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-09-23 01:08:55.758597" "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"
}, },
"servers": [ "servers": [
{ {
@ -1202,7 +1202,7 @@
} }
}, },
"tags": [ "tags": [
"Memory" "MemoryBanks"
], ],
"parameters": [ "parameters": [
{ {
@ -1225,6 +1225,96 @@
] ]
} }
}, },
"/models/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ModelServingSpec"
},
{
"type": "null"
}
]
}
}
}
}
},
"tags": [
"Models"
],
"parameters": [
{
"name": "core_model_id",
"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"
}
}
]
}
},
"/shields/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ShieldSpec"
},
{
"type": "null"
}
]
}
}
}
}
},
"tags": [
"Shields"
],
"parameters": [
{
"name": "shield_type",
"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"
}
}
]
}
},
"/telemetry/get_trace": { "/telemetry/get_trace": {
"get": { "get": {
"responses": { "responses": {
@ -1455,7 +1545,67 @@
} }
}, },
"tags": [ "tags": [
"Memory" "MemoryBanks"
],
"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"
}
}
]
}
},
"/models/list": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/ModelServingSpec"
}
}
}
}
},
"tags": [
"Models"
],
"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"
}
}
]
}
},
"/shields/list": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/ShieldSpec"
}
}
}
}
},
"tags": [
"Shields"
], ],
"parameters": [ "parameters": [
{ {
@ -4321,6 +4471,111 @@
"job_uuid" "job_uuid"
] ]
}, },
"Model": {
"description": "The model family and SKU of the model along with other parameters corresponding to the model."
},
"ModelServingSpec": {
"type": "object",
"properties": {
"llama_model": {
"$ref": "#/components/schemas/Model"
},
"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": [
"llama_model",
"provider_config"
]
},
"ShieldSpec": {
"type": "object",
"properties": {
"shield_type": {
"type": "string"
},
"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": [
"shield_type",
"provider_config"
]
},
"Trace": { "Trace": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -5579,39 +5834,48 @@
} }
], ],
"tags": [ "tags": [
{
"name": "PostTraining"
},
{
"name": "Safety"
},
{
"name": "SyntheticDataGeneration"
},
{
"name": "Datasets"
},
{
"name": "Telemetry"
},
{ {
"name": "Evaluations" "name": "Evaluations"
}, },
{ {
"name": "RewardScoring" "name": "MemoryBanks"
},
{
"name": "Agents"
}, },
{ {
"name": "Memory" "name": "Memory"
}, },
{ {
"name": "BatchInference" "name": "Datasets"
}, },
{ {
"name": "Inference" "name": "Inference"
}, },
{
"name": "BatchInference"
},
{
"name": "PostTraining"
},
{
"name": "SyntheticDataGeneration"
},
{
"name": "Models"
},
{
"name": "RewardScoring"
},
{
"name": "Telemetry"
},
{
"name": "Agents"
},
{
"name": "Safety"
},
{
"name": "Shields"
},
{ {
"name": "BuiltinTool", "name": "BuiltinTool",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BuiltinTool\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BuiltinTool\" />"
@ -5952,6 +6216,18 @@
"name": "EvaluationJobStatusResponse", "name": "EvaluationJobStatusResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluationJobStatusResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluationJobStatusResponse\" />"
}, },
{
"name": "Model",
"description": "The model family and SKU of the model along with other parameters corresponding to the model.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Model\" />"
},
{
"name": "ModelServingSpec",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ModelServingSpec\" />"
},
{
"name": "ShieldSpec",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldSpec\" />"
},
{ {
"name": "Trace", "name": "Trace",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Trace\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Trace\" />"
@ -6115,9 +6391,12 @@
"Evaluations", "Evaluations",
"Inference", "Inference",
"Memory", "Memory",
"MemoryBanks",
"Models",
"PostTraining", "PostTraining",
"RewardScoring", "RewardScoring",
"Safety", "Safety",
"Shields",
"SyntheticDataGeneration", "SyntheticDataGeneration",
"Telemetry" "Telemetry"
] ]
@ -6191,6 +6470,8 @@
"MemoryRetrievalStep", "MemoryRetrievalStep",
"MemoryToolDefinition", "MemoryToolDefinition",
"MetricEvent", "MetricEvent",
"Model",
"ModelServingSpec",
"OptimizerConfig", "OptimizerConfig",
"PhotogenToolDefinition", "PhotogenToolDefinition",
"PostTrainingJob", "PostTrainingJob",
@ -6217,6 +6498,7 @@
"SearchToolDefinition", "SearchToolDefinition",
"Session", "Session",
"ShieldCallStep", "ShieldCallStep",
"ShieldSpec",
"SpanEndPayload", "SpanEndPayload",
"SpanStartPayload", "SpanStartPayload",
"SpanStatus", "SpanStatus",

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

@ -1230,6 +1230,37 @@ components:
- value - value
- unit - unit
type: object type: object
Model:
description: The model family and SKU of the model along with other parameters
corresponding to the model.
ModelServingSpec:
additionalProperties: false
properties:
llama_model:
$ref: '#/components/schemas/Model'
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:
- llama_model
- provider_config
type: object
OptimizerConfig: OptimizerConfig:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1742,6 +1773,34 @@ components:
- step_id - step_id
- step_type - step_type
type: object type: object
ShieldSpec:
additionalProperties: false
properties:
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
shield_type:
type: string
required:
- shield_type
- provider_config
type: object
SpanEndPayload: SpanEndPayload:
additionalProperties: false additionalProperties: false
properties: properties:
@ -2349,7 +2408,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-09-23 01:08:55.758597" \ draft and subject to change.\n Generated at 2024-09-23 09:14:46.697401"
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
@ -3078,7 +3137,7 @@ paths:
- type: 'null' - type: 'null'
description: OK description: OK
tags: tags:
- Memory - MemoryBanks
/memory/insert: /memory/insert:
post: post:
parameters: parameters:
@ -3118,7 +3177,7 @@ paths:
$ref: '#/components/schemas/MemoryBank' $ref: '#/components/schemas/MemoryBank'
description: OK description: OK
tags: tags:
- Memory - MemoryBanks
/memory/query: /memory/query:
post: post:
parameters: parameters:
@ -3165,6 +3224,51 @@ paths:
description: OK description: OK
tags: tags:
- Memory - Memory
/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'
- type: 'null'
description: OK
tags:
- Models
/models/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/ModelServingSpec'
description: OK
tags:
- Models
/post_training/job/artifacts: /post_training/job/artifacts:
get: get:
parameters: parameters:
@ -3377,6 +3481,51 @@ paths:
description: OK description: OK
tags: tags:
- Safety - Safety
/shields/get:
get:
parameters:
- in: query
name: shield_type
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/ShieldSpec'
- type: 'null'
description: OK
tags:
- Shields
/shields/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/ShieldSpec'
description: OK
tags:
- Shields
/synthetic_data_generation/generate: /synthetic_data_generation/generate:
post: post:
parameters: parameters:
@ -3452,17 +3601,20 @@ security:
servers: servers:
- url: http://any-hosted-llama-stack.com - url: http://any-hosted-llama-stack.com
tags: tags:
- name: PostTraining
- name: Safety
- name: SyntheticDataGeneration
- name: Datasets
- name: Telemetry
- name: Evaluations - name: Evaluations
- name: RewardScoring - name: MemoryBanks
- name: Agents
- name: Memory - name: Memory
- name: BatchInference - name: Datasets
- name: Inference - name: Inference
- name: BatchInference
- name: PostTraining
- name: SyntheticDataGeneration
- name: Models
- name: RewardScoring
- name: Telemetry
- name: Agents
- name: Safety
- name: Shields
- 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"
@ -3730,6 +3882,17 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluationJobStatusResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/EvaluationJobStatusResponse"
/> />
name: EvaluationJobStatusResponse name: EvaluationJobStatusResponse
- description: 'The model family and SKU of the model along with other parameters
corresponding to the model.
<SchemaDefinition schemaRef="#/components/schemas/Model" />'
name: Model
- description: <SchemaDefinition schemaRef="#/components/schemas/ModelServingSpec"
/>
name: ModelServingSpec
- description: <SchemaDefinition schemaRef="#/components/schemas/ShieldSpec" />
name: ShieldSpec
- description: <SchemaDefinition schemaRef="#/components/schemas/Trace" /> - description: <SchemaDefinition schemaRef="#/components/schemas/Trace" />
name: Trace name: Trace
- description: 'Checkpoint created during training runs - description: 'Checkpoint created during training runs
@ -3862,9 +4025,12 @@ x-tagGroups:
- Evaluations - Evaluations
- Inference - Inference
- Memory - Memory
- MemoryBanks
- Models
- PostTraining - PostTraining
- RewardScoring - RewardScoring
- Safety - Safety
- Shields
- SyntheticDataGeneration - SyntheticDataGeneration
- Telemetry - Telemetry
- name: Types - name: Types
@ -3935,6 +4101,8 @@ x-tagGroups:
- MemoryRetrievalStep - MemoryRetrievalStep
- MemoryToolDefinition - MemoryToolDefinition
- MetricEvent - MetricEvent
- Model
- ModelServingSpec
- OptimizerConfig - OptimizerConfig
- PhotogenToolDefinition - PhotogenToolDefinition
- PostTrainingJob - PostTrainingJob
@ -3961,6 +4129,7 @@ x-tagGroups:
- SearchToolDefinition - SearchToolDefinition
- Session - Session
- ShieldCallStep - ShieldCallStep
- ShieldSpec
- SpanEndPayload - SpanEndPayload
- SpanStartPayload - SpanStartPayload
- SpanStatus - SpanStatus