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:26:34 -07:00
parent 067ec4ce50
commit bf18ba3940
3 changed files with 59 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

14
source/api_definitions.py
View file

@ -143,7 +143,7 @@ class BatchChatCompletionRequest:
class Inference(Protocol):
"""Set of methods that can be called on the inference service."""
def post_completion(
self,
request: CompletionRequest,
@ -301,7 +301,7 @@ class MemoryBanks(Protocol):
) -> List[MemoryBankDocument]: ...
@webmethod(route="/memory_bank/delete")
def post_delete_memory_documents(
def remove_memory_documents(
self,
bank_uuid: str,
document_uuids: List[str],
@ -542,11 +542,13 @@ if __name__ == "__main__":
spec = Specification(
LlamaStackEndpoints,
Options(
server=Server(url="http://llama.meta.com"),
server=Server(url="http://any-hosted-llama-stack.com"),
info=Info(
title="Llama Stack specification",
version="0.1",
description="This is the llama stack",
title="[DRAFT] Llama Stack Specification",
version="0.0.1",
description="""This is the specification of the llama stack that provides
a set of endpoints and their corresponding interfaces that are tailored to
best leverage Llama Models. The specification is still in draft and subject to change.""",
),
),
)

90
source/openapi.html
View file

@ -19,13 +19,13 @@
spec = {
"openapi": "3.1.0",
"info": {
"title": "Llama Stack specification",
"version": "0.1",
"description": "This is the llama stack"
"title": "[DRAFT] Llama Stack Specification RFC",
"version": "0.0.0",
"description": "This is the specification of the llama stack that allows"
},
"servers": [
{
"url": "http://llama.meta.com"
"url": "http://any-hosted-llama-stack.com"
}
],
"paths": {
@ -520,41 +520,6 @@
}
}
},
"/memory_bank/delete": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"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
}
}
},
"/synthetic_data_generation/generate": {
"post": {
"responses": {
@ -882,6 +847,41 @@
}
]
}
},
"/memory_bank/delete": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"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
}
}
}
},
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
@ -3323,12 +3323,6 @@
{
"name": "RewardScoring"
},
{
"name": "AgenticSystem"
},
{
"name": "MemoryBanks"
},
{
"name": "Inference"
},
@ -3338,6 +3332,12 @@
{
"name": "SyntheticDataGeneration"
},
{
"name": "MemoryBanks"
},
{
"name": "AgenticSystem"
},
{
"name": "ShieldConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldConfig\" />"

12
source/openapi.yaml
View file

@ -1502,9 +1502,9 @@ components:
pattern: ^(https?://|file://|data:)
type: string
info:
description: This is the llama stack
title: Llama Stack specification
version: '0.1'
description: This is the specification of the llama stack that allows
title: '[DRAFT] Llama Stack Specification RFC'
version: 0.0.0
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
openapi: 3.1.0
paths:
@ -2010,15 +2010,15 @@ paths:
security:
- Default: []
servers:
- url: http://llama.meta.com
- url: http://any-hosted-llama-stack.com
tags:
- name: PostTraining
- name: RewardScoring
- name: AgenticSystem
- name: MemoryBanks
- name: Inference
- name: Datasets
- name: SyntheticDataGeneration
- name: MemoryBanks
- name: AgenticSystem
- description: <SchemaDefinition schemaRef="#/components/schemas/ShieldConfig" />
name: ShieldConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/AgenticSystemCreateRequest"