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

added more docs

Browse source
This commit is contained in:
Raghotham Murthy 2024-07-11 01:46:33 -07:00
parent b88f8ad616
commit 65556d0a1c
3 changed files with 200 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

4
source/api_definitions.py
View file

@ -265,7 +265,7 @@ class AgenticSystem(Protocol):
class MemoryBanks(Protocol): class MemoryBanks(Protocol):
@webmethod(route="/memory_banks/create") @webmethod(route="/memory_banks/create")
def create_memory_bank( def post_create_memory_bank(
self, self,
bank_uuid: str, bank_uuid: str,
bank_name: str, bank_name: str,
@ -298,7 +298,7 @@ class MemoryBanks(Protocol):
) -> None: ... ) -> None: ...
@webmethod(route="/memory_bank/get") @webmethod(route="/memory_bank/get")
def post_get_memory_documents( def get_memory_documents(
self, self,
bank_uuid: str, bank_uuid: str,
document_uuids: List[str], document_uuids: List[str],

380
source/openapi.html
View file

@ -119,93 +119,6 @@
} }
} }
}, },
"/memory_banks/create": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"MemoryBanks"
],
"parameters": [
{
"name": "bank_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bank_name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"content": {
"type": "string",
"contentEncoding": "base64"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"mime_type": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"uuid",
"content",
"metadata",
"mime_type"
]
}
}
}
},
"required": true
}
}
},
"/agentic_system/delete": { "/agentic_system/delete": {
"delete": { "delete": {
"responses": { "responses": {
@ -299,6 +212,48 @@
"parameters": [] "parameters": []
} }
}, },
"/memory_bank/get": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/MemoryBankDocument"
}
}
}
}
},
"tags": [
"MemoryBanks"
],
"parameters": [
{
"name": "bank_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
}
}
},
"/post_training/job/artifacts": { "/post_training/job/artifacts": {
"get": { "get": {
"responses": { "responses": {
@ -520,6 +475,93 @@
} }
} }
}, },
"/memory_banks/create": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"MemoryBanks"
],
"parameters": [
{
"name": "bank_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bank_name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"content": {
"type": "string",
"contentEncoding": "base64"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"mime_type": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"uuid",
"content",
"metadata",
"mime_type"
]
}
}
}
},
"required": true
}
}
},
"/synthetic_data_generation/generate": { "/synthetic_data_generation/generate": {
"post": { "post": {
"responses": { "responses": {
@ -550,48 +592,6 @@
} }
} }
}, },
"/memory_bank/get": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/MemoryBankDocument"
}
}
}
}
},
"tags": [
"MemoryBanks"
],
"parameters": [
{
"name": "bank_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
}
}
},
"/memory_bank/insert": { "/memory_bank/insert": {
"post": { "post": {
"responses": { "responses": {
@ -1841,6 +1841,53 @@
"name" "name"
] ]
}, },
"MemoryBankDocument": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"content": {
"type": "string",
"contentEncoding": "base64"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"mime_type": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"uuid",
"content",
"metadata",
"mime_type"
]
},
"PostTrainingJobArtifactsResponse": { "PostTrainingJobArtifactsResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -2815,53 +2862,6 @@
], ],
"title": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold." "title": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold."
}, },
"MemoryBankDocument": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"content": {
"type": "string",
"contentEncoding": "base64"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"mime_type": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"uuid",
"content",
"metadata",
"mime_type"
]
},
"DPOAlignmentConfig": { "DPOAlignmentConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -3317,27 +3317,27 @@
} }
], ],
"tags": [ "tags": [
{
"name": "SyntheticDataGeneration"
},
{ {
"name": "RewardScoring" "name": "RewardScoring"
}, },
{
"name": "PostTraining"
},
{
"name": "AgenticSystem"
},
{ {
"name": "Datasets" "name": "Datasets"
}, },
{ {
"name": "SyntheticDataGeneration" "name": "PostTraining"
},
{
"name": "Inference"
}, },
{ {
"name": "MemoryBanks" "name": "MemoryBanks"
}, },
{
"name": "AgenticSystem"
},
{
"name": "Inference"
},
{ {
"name": "ShieldConfig", "name": "ShieldConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldConfig\" />"
@ -3390,6 +3390,10 @@
"name": "MemoryBank", "name": "MemoryBank",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBank\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBank\" />"
}, },
{
"name": "MemoryBankDocument",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBankDocument\" />"
},
{ {
"name": "PostTrainingJobArtifactsResponse", "name": "PostTrainingJobArtifactsResponse",
"description": "Artifacts of a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobArtifactsResponse\" />" "description": "Artifacts of a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobArtifactsResponse\" />"
@ -3454,10 +3458,6 @@
"name": "SyntheticDataGenerationResponse", "name": "SyntheticDataGenerationResponse",
"description": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerationResponse\" />" "description": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerationResponse\" />"
}, },
{
"name": "MemoryBankDocument",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBankDocument\" />"
},
{ {
"name": "DPOAlignmentConfig", "name": "DPOAlignmentConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />"

16
source/openapi.yaml
View file

@ -2015,13 +2015,13 @@ security:
servers: servers:
- url: http://any-hosted-llama-stack.com - url: http://any-hosted-llama-stack.com
tags: tags:
- name: RewardScoring
- name: PostTraining
- name: AgenticSystem
- name: Datasets
- name: SyntheticDataGeneration - name: SyntheticDataGeneration
- name: Inference - name: RewardScoring
- name: Datasets
- name: PostTraining
- name: MemoryBanks - name: MemoryBanks
- name: AgenticSystem
- name: Inference
- description: <SchemaDefinition schemaRef="#/components/schemas/ShieldConfig" /> - description: <SchemaDefinition schemaRef="#/components/schemas/ShieldConfig" />
name: ShieldConfig name: ShieldConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/AgenticSystemCreateRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/AgenticSystemCreateRequest"
@ -2072,6 +2072,9 @@ tags:
name: Dataset name: Dataset
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBank" /> - description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBank" />
name: MemoryBank name: MemoryBank
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBankDocument"
/>
name: MemoryBankDocument
- description: 'Artifacts of a finetuning job. - description: 'Artifacts of a finetuning job.
@ -2145,9 +2148,6 @@ tags:
<SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerationResponse" <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerationResponse"
/>' />'
name: SyntheticDataGenerationResponse name: SyntheticDataGenerationResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBankDocument"
/>
name: MemoryBankDocument
- description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig"
/> />
name: DPOAlignmentConfig name: DPOAlignmentConfig