Fix OpenAPI generation to have text/event-stream for streamable methods

This commit is contained in:
Ashwin Bharambe 2024-11-14 12:51:38 -08:00
parent acbecbf8b3
commit bba6edd06b
4 changed files with 703 additions and 705 deletions

View file

@ -34,20 +34,6 @@ schema_utils.json_schema_type = json_schema_type
from llama_stack.distribution.stack import LlamaStack from llama_stack.distribution.stack import LlamaStack
# TODO: this should be fixed in the generator itself so it reads appropriate annotations
STREAMING_ENDPOINTS = [
"/agents/turn/create",
"/inference/chat_completion",
]
def patch_sse_stream_responses(spec: Specification):
for path, path_item in spec.document.paths.items():
if path in STREAMING_ENDPOINTS:
content = path_item.post.responses["200"].content.pop("application/json")
path_item.post.responses["200"].content["text/event-stream"] = content
def main(output_dir: str): def main(output_dir: str):
output_dir = Path(output_dir) output_dir = Path(output_dir)
if not output_dir.exists(): if not output_dir.exists():
@ -74,8 +60,6 @@ def main(output_dir: str):
), ),
) )
patch_sse_stream_responses(spec)
with open(output_dir / "llama-stack-spec.yaml", "w", encoding="utf-8") as fp: with open(output_dir / "llama-stack-spec.yaml", "w", encoding="utf-8") as fp:
yaml.dump(spec.get_json(), fp, allow_unicode=True) yaml.dump(spec.get_json(), fp, allow_unicode=True)

View file

@ -4,6 +4,7 @@
# This source code is licensed under the terms described in the LICENSE file in # This source code is licensed under the terms described in the LICENSE file in
# the root directory of this source tree. # the root directory of this source tree.
import collections
import hashlib import hashlib
import ipaddress import ipaddress
import typing import typing
@ -176,9 +177,20 @@ class ContentBuilder:
) -> Dict[str, MediaType]: ) -> Dict[str, MediaType]:
"Creates the content subtree for a request or response." "Creates the content subtree for a request or response."
def has_iterator_type(t):
if typing.get_origin(t) is typing.Union:
return any(has_iterator_type(a) for a in typing.get_args(t))
else:
# TODO: needs a proper fix where we let all types correctly flow upwards
# and then test against AsyncIterator
return "StreamChunk" in str(t)
if is_generic_list(payload_type): if is_generic_list(payload_type):
media_type = "application/jsonl" media_type = "application/jsonl"
item_type = unwrap_generic_list(payload_type) item_type = unwrap_generic_list(payload_type)
elif has_iterator_type(payload_type):
item_type = payload_type
media_type = "text/event-stream"
else: else:
media_type = "application/json" media_type = "application/json"
item_type = payload_type item_type = payload_type
@ -671,6 +683,8 @@ class Generator:
for extra_tag_group in extra_tag_groups.values(): for extra_tag_group in extra_tag_groups.values():
tags.extend(extra_tag_group) tags.extend(extra_tag_group)
tags = sorted(tags, key=lambda t: t.name)
tag_groups = [] tag_groups = []
if operation_tags: if operation_tags:
tag_groups.append( tag_groups.append(

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-13 21:05:58.323310" "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-14 12:51:12.176325"
}, },
"servers": [ "servers": [
{ {
@ -195,7 +195,7 @@
"200": { "200": {
"description": "Completion response. **OR** streamed completion response.", "description": "Completion response. **OR** streamed completion response.",
"content": { "content": {
"application/json": { "text/event-stream": {
"schema": { "schema": {
"oneOf": [ "oneOf": [
{ {
@ -7965,242 +7965,24 @@
], ],
"tags": [ "tags": [
{ {
"name": "Agents" "name": "AgentCandidate",
}, "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentCandidate\" />"
{
"name": "DatasetIO"
},
{
"name": "Models"
},
{
"name": "Inference"
},
{
"name": "BatchInference"
},
{
"name": "Memory"
},
{
"name": "Safety"
},
{
"name": "Inspect"
},
{
"name": "EvalTasks"
},
{
"name": "Scoring"
},
{
"name": "Datasets"
},
{
"name": "PostTraining"
},
{
"name": "Eval"
},
{
"name": "Shields"
},
{
"name": "Telemetry"
},
{
"name": "ScoringFunctions"
},
{
"name": "MemoryBanks"
},
{
"name": "SyntheticDataGeneration"
},
{
"name": "BuiltinTool",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BuiltinTool\" />"
},
{
"name": "CompletionMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionMessage\" />"
},
{
"name": "ImageMedia",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ImageMedia\" />"
},
{
"name": "SamplingParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SamplingParams\" />"
},
{
"name": "SamplingStrategy",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SamplingStrategy\" />"
},
{
"name": "StopReason",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/StopReason\" />"
},
{
"name": "SystemMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SystemMessage\" />"
},
{
"name": "ToolCall",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolCall\" />"
},
{
"name": "ToolChoice",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolChoice\" />"
},
{
"name": "ToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolDefinition\" />"
},
{
"name": "ToolParamDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolParamDefinition\" />"
},
{
"name": "ToolPromptFormat",
"description": "This Enum refers to the prompt format for calling custom / zero shot tools\n\n`json` --\n Refers to the json format for calling tools.\n The json format takes the form like\n {\n \"type\": \"function\",\n \"function\" : {\n \"name\": \"function_name\",\n \"description\": \"function_description\",\n \"parameters\": {...}\n }\n }\n\n`function_tag` --\n This is an example of how you could define\n your own user defined format for making tool calls.\n The function_tag format looks like this,\n <function=function_name>(parameters)</function>\n\nThe detailed prompts for each of these formats are added to llama cli\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ToolPromptFormat\" />"
},
{
"name": "ToolResponseMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolResponseMessage\" />"
},
{
"name": "URL",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/URL\" />"
},
{
"name": "UserMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserMessage\" />"
},
{
"name": "BatchChatCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionRequest\" />"
},
{
"name": "BatchChatCompletionResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionResponse\" />"
},
{
"name": "BatchCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionRequest\" />"
},
{
"name": "BatchCompletionResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionResponse\" />"
},
{
"name": "CancelTrainingJobRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CancelTrainingJobRequest\" />"
},
{
"name": "ChatCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionRequest\" />"
},
{
"name": "ChatCompletionResponse",
"description": "Chat completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponse\" />"
},
{
"name": "ChatCompletionResponseEvent",
"description": "Chat completion response event.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseEvent\" />"
},
{
"name": "ChatCompletionResponseEventType",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseEventType\" />"
},
{
"name": "ChatCompletionResponseStreamChunk",
"description": "SSE-stream of these events.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseStreamChunk\" />"
},
{
"name": "TokenLogProbs",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TokenLogProbs\" />"
},
{
"name": "ToolCallDelta",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolCallDelta\" />"
},
{
"name": "ToolCallParseStatus",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolCallParseStatus\" />"
},
{
"name": "CompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionRequest\" />"
},
{
"name": "CompletionResponse",
"description": "Completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponse\" />"
},
{
"name": "CompletionResponseStreamChunk",
"description": "streamed completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponseStreamChunk\" />"
}, },
{ {
"name": "AgentConfig", "name": "AgentConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentConfig\" />"
}, },
{
"name": "CodeInterpreterToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CodeInterpreterToolDefinition\" />"
},
{
"name": "FunctionCallToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/FunctionCallToolDefinition\" />"
},
{
"name": "MemoryToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryToolDefinition\" />"
},
{
"name": "PhotogenToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PhotogenToolDefinition\" />"
},
{
"name": "RestAPIExecutionConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RestAPIExecutionConfig\" />"
},
{
"name": "RestAPIMethod",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RestAPIMethod\" />"
},
{
"name": "SearchToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SearchToolDefinition\" />"
},
{
"name": "WolframAlphaToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/WolframAlphaToolDefinition\" />"
},
{
"name": "CreateAgentRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgentRequest\" />"
},
{ {
"name": "AgentCreateResponse", "name": "AgentCreateResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentCreateResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentCreateResponse\" />"
}, },
{
"name": "CreateAgentSessionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgentSessionRequest\" />"
},
{ {
"name": "AgentSessionCreateResponse", "name": "AgentSessionCreateResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentSessionCreateResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentSessionCreateResponse\" />"
}, },
{ {
"name": "Attachment", "name": "AgentStepResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Attachment\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentStepResponse\" />"
},
{
"name": "CreateAgentTurnRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgentTurnRequest\" />"
}, },
{ {
"name": "AgentTurnResponseEvent", "name": "AgentTurnResponseEvent",
@ -8231,36 +8013,116 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentTurnResponseTurnStartPayload\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentTurnResponseTurnStartPayload\" />"
}, },
{ {
"name": "InferenceStep", "name": "Agents"
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/InferenceStep\" />"
}, },
{ {
"name": "MemoryRetrievalStep", "name": "AppEvalTaskConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryRetrievalStep\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AppEvalTaskConfig\" />"
}, },
{ {
"name": "SafetyViolation", "name": "Attachment",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SafetyViolation\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Attachment\" />"
}, },
{ {
"name": "ShieldCallStep", "name": "BatchChatCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldCallStep\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionRequest\" />"
}, },
{ {
"name": "ToolExecutionStep", "name": "BatchChatCompletionResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolExecutionStep\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionResponse\" />"
}, },
{ {
"name": "ToolResponse", "name": "BatchCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionRequest\" />"
}, },
{ {
"name": "Turn", "name": "BatchCompletionResponse",
"description": "A single turn in an interaction with an Agentic System.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Turn\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionResponse\" />"
}, },
{ {
"name": "ViolationLevel", "name": "BatchInference"
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ViolationLevel\" />" },
{
"name": "BenchmarkEvalTaskConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BenchmarkEvalTaskConfig\" />"
},
{
"name": "BuiltinTool",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BuiltinTool\" />"
},
{
"name": "CancelTrainingJobRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CancelTrainingJobRequest\" />"
},
{
"name": "ChatCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionRequest\" />"
},
{
"name": "ChatCompletionResponse",
"description": "Chat completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponse\" />"
},
{
"name": "ChatCompletionResponseEvent",
"description": "Chat completion response event.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseEvent\" />"
},
{
"name": "ChatCompletionResponseEventType",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseEventType\" />"
},
{
"name": "ChatCompletionResponseStreamChunk",
"description": "SSE-stream of these events.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseStreamChunk\" />"
},
{
"name": "Checkpoint",
"description": "Checkpoint created during training runs\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Checkpoint\" />"
},
{
"name": "CodeInterpreterToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CodeInterpreterToolDefinition\" />"
},
{
"name": "CompletionMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionMessage\" />"
},
{
"name": "CompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionRequest\" />"
},
{
"name": "CompletionResponse",
"description": "Completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponse\" />"
},
{
"name": "CompletionResponseStreamChunk",
"description": "streamed completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponseStreamChunk\" />"
},
{
"name": "CreateAgentRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgentRequest\" />"
},
{
"name": "CreateAgentSessionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgentSessionRequest\" />"
},
{
"name": "CreateAgentTurnRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgentTurnRequest\" />"
},
{
"name": "DPOAlignmentConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />"
},
{
"name": "Dataset",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Dataset\" />"
},
{
"name": "DatasetIO"
},
{
"name": "Datasets"
}, },
{ {
"name": "DeleteAgentsRequest", "name": "DeleteAgentsRequest",
@ -8274,6 +8136,10 @@
"name": "DeleteModelRequest", "name": "DeleteModelRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteModelRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteModelRequest\" />"
}, },
{
"name": "DoraFinetuningConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DoraFinetuningConfig\" />"
},
{ {
"name": "EmbeddingsRequest", "name": "EmbeddingsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EmbeddingsRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EmbeddingsRequest\" />"
@ -8283,40 +8149,30 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EmbeddingsResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EmbeddingsResponse\" />"
}, },
{ {
"name": "AgentCandidate", "name": "Eval"
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentCandidate\" />"
}, },
{ {
"name": "AppEvalTaskConfig", "name": "EvalTask",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AppEvalTaskConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvalTask\" />"
}, },
{ {
"name": "BenchmarkEvalTaskConfig", "name": "EvalTasks"
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BenchmarkEvalTaskConfig\" />"
},
{
"name": "LLMAsJudgeScoringFnParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LLMAsJudgeScoringFnParams\" />"
},
{
"name": "ModelCandidate",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ModelCandidate\" />"
},
{
"name": "RegexParserScoringFnParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegexParserScoringFnParams\" />"
},
{
"name": "EvaluateRowsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateRowsRequest\" />"
}, },
{ {
"name": "EvaluateResponse", "name": "EvaluateResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateResponse\" />"
}, },
{ {
"name": "ScoringResult", "name": "EvaluateRowsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoringResult\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateRowsRequest\" />"
},
{
"name": "FinetuningAlgorithm",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/FinetuningAlgorithm\" />"
},
{
"name": "FunctionCallToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/FunctionCallToolDefinition\" />"
}, },
{ {
"name": "GetAgentsSessionRequest", "name": "GetAgentsSessionRequest",
@ -8326,57 +8182,127 @@
"name": "GraphMemoryBank", "name": "GraphMemoryBank",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/GraphMemoryBank\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GraphMemoryBank\" />"
}, },
{
"name": "GraphMemoryBankParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/GraphMemoryBankParams\" />"
},
{
"name": "HealthInfo",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/HealthInfo\" />"
},
{
"name": "ImageMedia",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ImageMedia\" />"
},
{
"name": "Inference"
},
{
"name": "InferenceStep",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/InferenceStep\" />"
},
{
"name": "InsertDocumentsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/InsertDocumentsRequest\" />"
},
{
"name": "Inspect"
},
{
"name": "Job",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Job\" />"
},
{
"name": "JobCancelRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/JobCancelRequest\" />"
},
{
"name": "JobStatus",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/JobStatus\" />"
},
{ {
"name": "KeyValueMemoryBank", "name": "KeyValueMemoryBank",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/KeyValueMemoryBank\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/KeyValueMemoryBank\" />"
}, },
{
"name": "KeyValueMemoryBankParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/KeyValueMemoryBankParams\" />"
},
{ {
"name": "KeywordMemoryBank", "name": "KeywordMemoryBank",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/KeywordMemoryBank\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/KeywordMemoryBank\" />"
}, },
{ {
"name": "Session", "name": "KeywordMemoryBankParams",
"description": "A single session of an interaction with an Agentic System.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Session\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/KeywordMemoryBankParams\" />"
}, },
{ {
"name": "VectorMemoryBank", "name": "LLMAsJudgeScoringFnParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/VectorMemoryBank\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LLMAsJudgeScoringFnParams\" />"
}, },
{ {
"name": "AgentStepResponse", "name": "LogEventRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentStepResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogEventRequest\" />"
}, },
{ {
"name": "Dataset", "name": "LogSeverity",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Dataset\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogSeverity\" />"
}, },
{ {
"name": "EvalTask", "name": "LoraFinetuningConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvalTask\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LoraFinetuningConfig\" />"
},
{
"name": "Memory"
},
{
"name": "MemoryBankDocument",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBankDocument\" />"
},
{
"name": "MemoryBanks"
},
{
"name": "MemoryRetrievalStep",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryRetrievalStep\" />"
},
{
"name": "MemoryToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryToolDefinition\" />"
},
{
"name": "MetricEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MetricEvent\" />"
}, },
{ {
"name": "Model", "name": "Model",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Model\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Model\" />"
}, },
{
"name": "ModelCandidate",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ModelCandidate\" />"
},
{
"name": "Models"
},
{
"name": "OptimizerConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/OptimizerConfig\" />"
},
{ {
"name": "PaginatedRowsResult", "name": "PaginatedRowsResult",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PaginatedRowsResult\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PaginatedRowsResult\" />"
}, },
{ {
"name": "ScoringFn", "name": "PhotogenToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoringFn\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PhotogenToolDefinition\" />"
}, },
{ {
"name": "Shield", "name": "PostTraining"
"description": "A safety shield resource that can be used to check content\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Shield\" />"
}, },
{ {
"name": "Trace", "name": "PostTrainingJob",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Trace\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJob\" />"
},
{
"name": "Checkpoint",
"description": "Checkpoint created during training runs\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Checkpoint\" />"
}, },
{ {
"name": "PostTrainingJobArtifactsResponse", "name": "PostTrainingJobArtifactsResponse",
@ -8395,88 +8321,16 @@
"description": "Status of a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobStatusResponse\" />" "description": "Status of a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobStatusResponse\" />"
}, },
{ {
"name": "PostTrainingJob", "name": "PreferenceOptimizeRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJob\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PreferenceOptimizeRequest\" />"
},
{
"name": "HealthInfo",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/HealthInfo\" />"
},
{
"name": "MemoryBankDocument",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBankDocument\" />"
},
{
"name": "InsertDocumentsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/InsertDocumentsRequest\" />"
},
{
"name": "JobCancelRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/JobCancelRequest\" />"
},
{
"name": "JobStatus",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/JobStatus\" />"
}, },
{ {
"name": "ProviderInfo", "name": "ProviderInfo",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ProviderInfo\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ProviderInfo\" />"
}, },
{ {
"name": "RouteInfo", "name": "QLoraFinetuningConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RouteInfo\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/QLoraFinetuningConfig\" />"
},
{
"name": "LogSeverity",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogSeverity\" />"
},
{
"name": "MetricEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MetricEvent\" />"
},
{
"name": "SpanEndPayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SpanEndPayload\" />"
},
{
"name": "SpanStartPayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SpanStartPayload\" />"
},
{
"name": "SpanStatus",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SpanStatus\" />"
},
{
"name": "StructuredLogEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/StructuredLogEvent\" />"
},
{
"name": "UnstructuredLogEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnstructuredLogEvent\" />"
},
{
"name": "LogEventRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogEventRequest\" />"
},
{
"name": "DPOAlignmentConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />"
},
{
"name": "OptimizerConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/OptimizerConfig\" />"
},
{
"name": "RLHFAlgorithm",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RLHFAlgorithm\" />"
},
{
"name": "TrainingConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainingConfig\" />"
},
{
"name": "PreferenceOptimizeRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PreferenceOptimizeRequest\" />"
}, },
{ {
"name": "QueryDocumentsRequest", "name": "QueryDocumentsRequest",
@ -8486,6 +8340,14 @@
"name": "QueryDocumentsResponse", "name": "QueryDocumentsResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/QueryDocumentsResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/QueryDocumentsResponse\" />"
}, },
{
"name": "RLHFAlgorithm",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RLHFAlgorithm\" />"
},
{
"name": "RegexParserScoringFnParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegexParserScoringFnParams\" />"
},
{ {
"name": "RegisterDatasetRequest", "name": "RegisterDatasetRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterDatasetRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterDatasetRequest\" />"
@ -8494,22 +8356,6 @@
"name": "RegisterEvalTaskRequest", "name": "RegisterEvalTaskRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterEvalTaskRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterEvalTaskRequest\" />"
}, },
{
"name": "GraphMemoryBankParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/GraphMemoryBankParams\" />"
},
{
"name": "KeyValueMemoryBankParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/KeyValueMemoryBankParams\" />"
},
{
"name": "KeywordMemoryBankParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/KeywordMemoryBankParams\" />"
},
{
"name": "VectorMemoryBankParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/VectorMemoryBankParams\" />"
},
{ {
"name": "RegisterMemoryBankRequest", "name": "RegisterMemoryBankRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterMemoryBankRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterMemoryBankRequest\" />"
@ -8527,12 +8373,20 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterShieldRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RegisterShieldRequest\" />"
}, },
{ {
"name": "RunEvalRequest", "name": "RestAPIExecutionConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RunEvalRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RestAPIExecutionConfig\" />"
}, },
{ {
"name": "Job", "name": "RestAPIMethod",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Job\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RestAPIMethod\" />"
},
{
"name": "RouteInfo",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RouteInfo\" />"
},
{
"name": "RunEvalRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RunEvalRequest\" />"
}, },
{ {
"name": "RunShieldRequest", "name": "RunShieldRequest",
@ -8543,12 +8397,19 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RunShieldResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RunShieldResponse\" />"
}, },
{ {
"name": "ScoreRequest", "name": "Safety"
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoreRequest\" />"
}, },
{ {
"name": "ScoreResponse", "name": "SafetyViolation",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoreResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SafetyViolation\" />"
},
{
"name": "SamplingParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SamplingParams\" />"
},
{
"name": "SamplingStrategy",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SamplingStrategy\" />"
}, },
{ {
"name": "ScoreBatchRequest", "name": "ScoreBatchRequest",
@ -8559,20 +8420,65 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoreBatchResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoreBatchResponse\" />"
}, },
{ {
"name": "DoraFinetuningConfig", "name": "ScoreRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DoraFinetuningConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoreRequest\" />"
}, },
{ {
"name": "FinetuningAlgorithm", "name": "ScoreResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/FinetuningAlgorithm\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoreResponse\" />"
}, },
{ {
"name": "LoraFinetuningConfig", "name": "Scoring"
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LoraFinetuningConfig\" />"
}, },
{ {
"name": "QLoraFinetuningConfig", "name": "ScoringFn",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/QLoraFinetuningConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoringFn\" />"
},
{
"name": "ScoringFunctions"
},
{
"name": "ScoringResult",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoringResult\" />"
},
{
"name": "SearchToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SearchToolDefinition\" />"
},
{
"name": "Session",
"description": "A single session of an interaction with an Agentic System.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Session\" />"
},
{
"name": "Shield",
"description": "A safety shield resource that can be used to check content\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Shield\" />"
},
{
"name": "ShieldCallStep",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldCallStep\" />"
},
{
"name": "Shields"
},
{
"name": "SpanEndPayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SpanEndPayload\" />"
},
{
"name": "SpanStartPayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SpanStartPayload\" />"
},
{
"name": "SpanStatus",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SpanStatus\" />"
},
{
"name": "StopReason",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/StopReason\" />"
},
{
"name": "StructuredLogEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/StructuredLogEvent\" />"
}, },
{ {
"name": "SupervisedFineTuneRequest", "name": "SupervisedFineTuneRequest",
@ -8582,13 +8488,107 @@
"name": "SyntheticDataGenerateRequest", "name": "SyntheticDataGenerateRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerateRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerateRequest\" />"
}, },
{
"name": "SyntheticDataGeneration"
},
{ {
"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": "SystemMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SystemMessage\" />"
},
{
"name": "Telemetry"
},
{
"name": "TokenLogProbs",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TokenLogProbs\" />"
},
{
"name": "ToolCall",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolCall\" />"
},
{
"name": "ToolCallDelta",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolCallDelta\" />"
},
{
"name": "ToolCallParseStatus",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolCallParseStatus\" />"
},
{
"name": "ToolChoice",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolChoice\" />"
},
{
"name": "ToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolDefinition\" />"
},
{
"name": "ToolExecutionStep",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolExecutionStep\" />"
},
{
"name": "ToolParamDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolParamDefinition\" />"
},
{
"name": "ToolPromptFormat",
"description": "This Enum refers to the prompt format for calling custom / zero shot tools\n\n`json` --\n Refers to the json format for calling tools.\n The json format takes the form like\n {\n \"type\": \"function\",\n \"function\" : {\n \"name\": \"function_name\",\n \"description\": \"function_description\",\n \"parameters\": {...}\n }\n }\n\n`function_tag` --\n This is an example of how you could define\n your own user defined format for making tool calls.\n The function_tag format looks like this,\n <function=function_name>(parameters)</function>\n\nThe detailed prompts for each of these formats are added to llama cli\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ToolPromptFormat\" />"
},
{
"name": "ToolResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolResponse\" />"
},
{
"name": "ToolResponseMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolResponseMessage\" />"
},
{
"name": "Trace",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Trace\" />"
},
{
"name": "TrainingConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainingConfig\" />"
},
{
"name": "Turn",
"description": "A single turn in an interaction with an Agentic System.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Turn\" />"
},
{
"name": "URL",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/URL\" />"
},
{
"name": "UnstructuredLogEvent",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UnstructuredLogEvent\" />"
},
{ {
"name": "UpdateModelRequest", "name": "UpdateModelRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateModelRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateModelRequest\" />"
},
{
"name": "UserMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserMessage\" />"
},
{
"name": "VectorMemoryBank",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/VectorMemoryBank\" />"
},
{
"name": "VectorMemoryBankParams",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/VectorMemoryBankParams\" />"
},
{
"name": "ViolationLevel",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ViolationLevel\" />"
},
{
"name": "WolframAlphaToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/WolframAlphaToolDefinition\" />"
} }
], ],
"x-tagGroups": [ "x-tagGroups": [

View file

@ -3414,7 +3414,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-13 21:05:58.323310" \ draft and subject to change.\n Generated at 2024-11-14 12:51:12.176325"
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
@ -4065,7 +4065,7 @@ paths:
responses: responses:
'200': '200':
content: content:
application/json: text/event-stream:
schema: schema:
oneOf: oneOf:
- $ref: '#/components/schemas/CompletionResponse' - $ref: '#/components/schemas/CompletionResponse'
@ -4824,168 +4824,19 @@ security:
servers: servers:
- url: http://any-hosted-llama-stack.com - url: http://any-hosted-llama-stack.com
tags: tags:
- name: Agents - description: <SchemaDefinition schemaRef="#/components/schemas/AgentCandidate" />
- name: DatasetIO name: AgentCandidate
- name: Models
- name: Inference
- name: BatchInference
- name: Memory
- name: Safety
- name: Inspect
- name: EvalTasks
- name: Scoring
- name: Datasets
- name: PostTraining
- name: Eval
- name: Shields
- name: Telemetry
- name: ScoringFunctions
- name: MemoryBanks
- name: SyntheticDataGeneration
- description: <SchemaDefinition schemaRef="#/components/schemas/BuiltinTool" />
name: BuiltinTool
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionMessage"
/>
name: CompletionMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/ImageMedia" />
name: ImageMedia
- description: <SchemaDefinition schemaRef="#/components/schemas/SamplingParams" />
name: SamplingParams
- description: <SchemaDefinition schemaRef="#/components/schemas/SamplingStrategy"
/>
name: SamplingStrategy
- description: <SchemaDefinition schemaRef="#/components/schemas/StopReason" />
name: StopReason
- description: <SchemaDefinition schemaRef="#/components/schemas/SystemMessage" />
name: SystemMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCall" />
name: ToolCall
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolChoice" />
name: ToolChoice
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolDefinition" />
name: ToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolParamDefinition"
/>
name: ToolParamDefinition
- description: "This Enum refers to the prompt format for calling custom / zero shot\
\ tools\n\n`json` --\n Refers to the json format for calling tools.\n The\
\ json format takes the form like\n {\n \"type\": \"function\",\n \
\ \"function\" : {\n \"name\": \"function_name\",\n \
\ \"description\": \"function_description\",\n \"parameters\": {...}\n\
\ }\n }\n\n`function_tag` --\n This is an example of how you could\
\ define\n your own user defined format for making tool calls.\n The function_tag\
\ format looks like this,\n <function=function_name>(parameters)</function>\n\
\nThe detailed prompts for each of these formats are added to llama cli\n\n<SchemaDefinition\
\ schemaRef=\"#/components/schemas/ToolPromptFormat\" />"
name: ToolPromptFormat
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolResponseMessage"
/>
name: ToolResponseMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/URL" />
name: URL
- description: <SchemaDefinition schemaRef="#/components/schemas/UserMessage" />
name: UserMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionRequest"
/>
name: BatchChatCompletionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionResponse"
/>
name: BatchChatCompletionResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionRequest"
/>
name: BatchCompletionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionResponse"
/>
name: BatchCompletionResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/CancelTrainingJobRequest"
/>
name: CancelTrainingJobRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionRequest"
/>
name: ChatCompletionRequest
- description: 'Chat completion response.
<SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponse" />'
name: ChatCompletionResponse
- description: 'Chat completion response event.
<SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseEvent"
/>'
name: ChatCompletionResponseEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseEventType"
/>
name: ChatCompletionResponseEventType
- description: 'SSE-stream of these events.
<SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseStreamChunk"
/>'
name: ChatCompletionResponseStreamChunk
- description: <SchemaDefinition schemaRef="#/components/schemas/TokenLogProbs" />
name: TokenLogProbs
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCallDelta" />
name: ToolCallDelta
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCallParseStatus"
/>
name: ToolCallParseStatus
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionRequest"
/>
name: CompletionRequest
- description: 'Completion response.
<SchemaDefinition schemaRef="#/components/schemas/CompletionResponse" />'
name: CompletionResponse
- description: 'streamed completion response.
<SchemaDefinition schemaRef="#/components/schemas/CompletionResponseStreamChunk"
/>'
name: CompletionResponseStreamChunk
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentConfig" /> - description: <SchemaDefinition schemaRef="#/components/schemas/AgentConfig" />
name: AgentConfig name: AgentConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/CodeInterpreterToolDefinition"
/>
name: CodeInterpreterToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/FunctionCallToolDefinition"
/>
name: FunctionCallToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryToolDefinition"
/>
name: MemoryToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/PhotogenToolDefinition"
/>
name: PhotogenToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/RestAPIExecutionConfig"
/>
name: RestAPIExecutionConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/RestAPIMethod" />
name: RestAPIMethod
- description: <SchemaDefinition schemaRef="#/components/schemas/SearchToolDefinition"
/>
name: SearchToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/WolframAlphaToolDefinition"
/>
name: WolframAlphaToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentRequest"
/>
name: CreateAgentRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentCreateResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/AgentCreateResponse"
/> />
name: AgentCreateResponse name: AgentCreateResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentSessionRequest"
/>
name: CreateAgentSessionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentSessionCreateResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/AgentSessionCreateResponse"
/> />
name: AgentSessionCreateResponse name: AgentSessionCreateResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/Attachment" /> - description: <SchemaDefinition schemaRef="#/components/schemas/AgentStepResponse"
name: Attachment
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentTurnRequest"
/> />
name: CreateAgentTurnRequest name: AgentStepResponse
- description: 'Streamed agent execution response. - description: 'Streamed agent execution response.
@ -5012,28 +4863,97 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseTurnStartPayload" - description: <SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseTurnStartPayload"
/> />
name: AgentTurnResponseTurnStartPayload name: AgentTurnResponseTurnStartPayload
- description: <SchemaDefinition schemaRef="#/components/schemas/InferenceStep" /> - name: Agents
name: InferenceStep - description: <SchemaDefinition schemaRef="#/components/schemas/AppEvalTaskConfig"
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryRetrievalStep"
/> />
name: MemoryRetrievalStep name: AppEvalTaskConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/SafetyViolation" - description: <SchemaDefinition schemaRef="#/components/schemas/Attachment" />
name: Attachment
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionRequest"
/> />
name: SafetyViolation name: BatchChatCompletionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/ShieldCallStep" /> - description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionResponse"
name: ShieldCallStep
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolExecutionStep"
/> />
name: ToolExecutionStep name: BatchChatCompletionResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolResponse" /> - description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionRequest"
name: ToolResponse />
- description: 'A single turn in an interaction with an Agentic System. name: BatchCompletionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionResponse"
/>
name: BatchCompletionResponse
- name: BatchInference
- description: <SchemaDefinition schemaRef="#/components/schemas/BenchmarkEvalTaskConfig"
/>
name: BenchmarkEvalTaskConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/BuiltinTool" />
name: BuiltinTool
- description: <SchemaDefinition schemaRef="#/components/schemas/CancelTrainingJobRequest"
/>
name: CancelTrainingJobRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionRequest"
/>
name: ChatCompletionRequest
- description: 'Chat completion response.
<SchemaDefinition schemaRef="#/components/schemas/Turn" />' <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponse" />'
name: Turn name: ChatCompletionResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/ViolationLevel" /> - description: 'Chat completion response event.
name: ViolationLevel
<SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseEvent"
/>'
name: ChatCompletionResponseEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseEventType"
/>
name: ChatCompletionResponseEventType
- description: 'SSE-stream of these events.
<SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseStreamChunk"
/>'
name: ChatCompletionResponseStreamChunk
- description: 'Checkpoint created during training runs
<SchemaDefinition schemaRef="#/components/schemas/Checkpoint" />'
name: Checkpoint
- description: <SchemaDefinition schemaRef="#/components/schemas/CodeInterpreterToolDefinition"
/>
name: CodeInterpreterToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionMessage"
/>
name: CompletionMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionRequest"
/>
name: CompletionRequest
- description: 'Completion response.
<SchemaDefinition schemaRef="#/components/schemas/CompletionResponse" />'
name: CompletionResponse
- description: 'streamed completion response.
<SchemaDefinition schemaRef="#/components/schemas/CompletionResponseStreamChunk"
/>'
name: CompletionResponseStreamChunk
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentRequest"
/>
name: CreateAgentRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentSessionRequest"
/>
name: CreateAgentSessionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentTurnRequest"
/>
name: CreateAgentTurnRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig"
/>
name: DPOAlignmentConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/Dataset" />
name: Dataset
- name: DatasetIO
- name: Datasets
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgentsRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgentsRequest"
/> />
name: DeleteAgentsRequest name: DeleteAgentsRequest
@ -5043,82 +4963,112 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteModelRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/DeleteModelRequest"
/> />
name: DeleteModelRequest name: DeleteModelRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/DoraFinetuningConfig"
/>
name: DoraFinetuningConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/EmbeddingsRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/EmbeddingsRequest"
/> />
name: EmbeddingsRequest name: EmbeddingsRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/EmbeddingsResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/EmbeddingsResponse"
/> />
name: EmbeddingsResponse name: EmbeddingsResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentCandidate" /> - name: Eval
name: AgentCandidate - description: <SchemaDefinition schemaRef="#/components/schemas/EvalTask" />
- description: <SchemaDefinition schemaRef="#/components/schemas/AppEvalTaskConfig" name: EvalTask
/> - name: EvalTasks
name: AppEvalTaskConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/BenchmarkEvalTaskConfig"
/>
name: BenchmarkEvalTaskConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/LLMAsJudgeScoringFnParams"
/>
name: LLMAsJudgeScoringFnParams
- description: <SchemaDefinition schemaRef="#/components/schemas/ModelCandidate" />
name: ModelCandidate
- description: <SchemaDefinition schemaRef="#/components/schemas/RegexParserScoringFnParams"
/>
name: RegexParserScoringFnParams
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateRowsRequest"
/>
name: EvaluateRowsRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateResponse"
/> />
name: EvaluateResponse name: EvaluateResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoringResult" /> - description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateRowsRequest"
name: ScoringResult />
name: EvaluateRowsRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/FinetuningAlgorithm"
/>
name: FinetuningAlgorithm
- description: <SchemaDefinition schemaRef="#/components/schemas/FunctionCallToolDefinition"
/>
name: FunctionCallToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/GetAgentsSessionRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/GetAgentsSessionRequest"
/> />
name: GetAgentsSessionRequest name: GetAgentsSessionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/GraphMemoryBank" - description: <SchemaDefinition schemaRef="#/components/schemas/GraphMemoryBank"
/> />
name: GraphMemoryBank name: GraphMemoryBank
- description: <SchemaDefinition schemaRef="#/components/schemas/GraphMemoryBankParams"
/>
name: GraphMemoryBankParams
- description: <SchemaDefinition schemaRef="#/components/schemas/HealthInfo" />
name: HealthInfo
- description: <SchemaDefinition schemaRef="#/components/schemas/ImageMedia" />
name: ImageMedia
- name: Inference
- description: <SchemaDefinition schemaRef="#/components/schemas/InferenceStep" />
name: InferenceStep
- description: <SchemaDefinition schemaRef="#/components/schemas/InsertDocumentsRequest"
/>
name: InsertDocumentsRequest
- name: Inspect
- description: <SchemaDefinition schemaRef="#/components/schemas/Job" />
name: Job
- description: <SchemaDefinition schemaRef="#/components/schemas/JobCancelRequest"
/>
name: JobCancelRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/JobStatus" />
name: JobStatus
- description: <SchemaDefinition schemaRef="#/components/schemas/KeyValueMemoryBank" - description: <SchemaDefinition schemaRef="#/components/schemas/KeyValueMemoryBank"
/> />
name: KeyValueMemoryBank name: KeyValueMemoryBank
- description: <SchemaDefinition schemaRef="#/components/schemas/KeyValueMemoryBankParams"
/>
name: KeyValueMemoryBankParams
- description: <SchemaDefinition schemaRef="#/components/schemas/KeywordMemoryBank" - description: <SchemaDefinition schemaRef="#/components/schemas/KeywordMemoryBank"
/> />
name: KeywordMemoryBank name: KeywordMemoryBank
- description: 'A single session of an interaction with an Agentic System. - description: <SchemaDefinition schemaRef="#/components/schemas/KeywordMemoryBankParams"
<SchemaDefinition schemaRef="#/components/schemas/Session" />'
name: Session
- description: <SchemaDefinition schemaRef="#/components/schemas/VectorMemoryBank"
/> />
name: VectorMemoryBank name: KeywordMemoryBankParams
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentStepResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/LLMAsJudgeScoringFnParams"
/> />
name: AgentStepResponse name: LLMAsJudgeScoringFnParams
- description: <SchemaDefinition schemaRef="#/components/schemas/Dataset" /> - description: <SchemaDefinition schemaRef="#/components/schemas/LogEventRequest"
name: Dataset />
- description: <SchemaDefinition schemaRef="#/components/schemas/EvalTask" /> name: LogEventRequest
name: EvalTask - description: <SchemaDefinition schemaRef="#/components/schemas/LogSeverity" />
name: LogSeverity
- description: <SchemaDefinition schemaRef="#/components/schemas/LoraFinetuningConfig"
/>
name: LoraFinetuningConfig
- name: Memory
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBankDocument"
/>
name: MemoryBankDocument
- name: MemoryBanks
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryRetrievalStep"
/>
name: MemoryRetrievalStep
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryToolDefinition"
/>
name: MemoryToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/MetricEvent" />
name: MetricEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/Model" /> - description: <SchemaDefinition schemaRef="#/components/schemas/Model" />
name: Model name: Model
- description: <SchemaDefinition schemaRef="#/components/schemas/ModelCandidate" />
name: ModelCandidate
- name: Models
- description: <SchemaDefinition schemaRef="#/components/schemas/OptimizerConfig"
/>
name: OptimizerConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/PaginatedRowsResult" - description: <SchemaDefinition schemaRef="#/components/schemas/PaginatedRowsResult"
/> />
name: PaginatedRowsResult name: PaginatedRowsResult
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoringFn" /> - description: <SchemaDefinition schemaRef="#/components/schemas/PhotogenToolDefinition"
name: ScoringFn />
- description: 'A safety shield resource that can be used to check content name: PhotogenToolDefinition
- name: PostTraining
- description: <SchemaDefinition schemaRef="#/components/schemas/PostTrainingJob"
<SchemaDefinition schemaRef="#/components/schemas/Shield" />' />
name: Shield name: PostTrainingJob
- description: <SchemaDefinition schemaRef="#/components/schemas/Trace" />
name: Trace
- description: 'Checkpoint created during training runs
<SchemaDefinition schemaRef="#/components/schemas/Checkpoint" />'
name: Checkpoint
- description: 'Artifacts of a finetuning job. - description: 'Artifacts of a finetuning job.
@ -5139,83 +5089,31 @@ tags:
<SchemaDefinition schemaRef="#/components/schemas/PostTrainingJobStatusResponse" <SchemaDefinition schemaRef="#/components/schemas/PostTrainingJobStatusResponse"
/>' />'
name: PostTrainingJobStatusResponse name: PostTrainingJobStatusResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/PostTrainingJob"
/>
name: PostTrainingJob
- description: <SchemaDefinition schemaRef="#/components/schemas/HealthInfo" />
name: HealthInfo
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBankDocument"
/>
name: MemoryBankDocument
- description: <SchemaDefinition schemaRef="#/components/schemas/InsertDocumentsRequest"
/>
name: InsertDocumentsRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/JobCancelRequest"
/>
name: JobCancelRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/JobStatus" />
name: JobStatus
- description: <SchemaDefinition schemaRef="#/components/schemas/ProviderInfo" />
name: ProviderInfo
- description: <SchemaDefinition schemaRef="#/components/schemas/RouteInfo" />
name: RouteInfo
- description: <SchemaDefinition schemaRef="#/components/schemas/LogSeverity" />
name: LogSeverity
- description: <SchemaDefinition schemaRef="#/components/schemas/MetricEvent" />
name: MetricEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/SpanEndPayload" />
name: SpanEndPayload
- description: <SchemaDefinition schemaRef="#/components/schemas/SpanStartPayload"
/>
name: SpanStartPayload
- description: <SchemaDefinition schemaRef="#/components/schemas/SpanStatus" />
name: SpanStatus
- description: <SchemaDefinition schemaRef="#/components/schemas/StructuredLogEvent"
/>
name: StructuredLogEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent"
/>
name: UnstructuredLogEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/LogEventRequest"
/>
name: LogEventRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig"
/>
name: DPOAlignmentConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/OptimizerConfig"
/>
name: OptimizerConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/RLHFAlgorithm" />
name: RLHFAlgorithm
- description: <SchemaDefinition schemaRef="#/components/schemas/TrainingConfig" />
name: TrainingConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/PreferenceOptimizeRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/PreferenceOptimizeRequest"
/> />
name: PreferenceOptimizeRequest name: PreferenceOptimizeRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/ProviderInfo" />
name: ProviderInfo
- description: <SchemaDefinition schemaRef="#/components/schemas/QLoraFinetuningConfig"
/>
name: QLoraFinetuningConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/QueryDocumentsRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/QueryDocumentsRequest"
/> />
name: QueryDocumentsRequest name: QueryDocumentsRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/QueryDocumentsResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/QueryDocumentsResponse"
/> />
name: QueryDocumentsResponse name: QueryDocumentsResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/RLHFAlgorithm" />
name: RLHFAlgorithm
- description: <SchemaDefinition schemaRef="#/components/schemas/RegexParserScoringFnParams"
/>
name: RegexParserScoringFnParams
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterDatasetRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/RegisterDatasetRequest"
/> />
name: RegisterDatasetRequest name: RegisterDatasetRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterEvalTaskRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/RegisterEvalTaskRequest"
/> />
name: RegisterEvalTaskRequest name: RegisterEvalTaskRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/GraphMemoryBankParams"
/>
name: GraphMemoryBankParams
- description: <SchemaDefinition schemaRef="#/components/schemas/KeyValueMemoryBankParams"
/>
name: KeyValueMemoryBankParams
- description: <SchemaDefinition schemaRef="#/components/schemas/KeywordMemoryBankParams"
/>
name: KeywordMemoryBankParams
- description: <SchemaDefinition schemaRef="#/components/schemas/VectorMemoryBankParams"
/>
name: VectorMemoryBankParams
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterMemoryBankRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/RegisterMemoryBankRequest"
/> />
name: RegisterMemoryBankRequest name: RegisterMemoryBankRequest
@ -5228,44 +5126,81 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterShieldRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/RegisterShieldRequest"
/> />
name: RegisterShieldRequest name: RegisterShieldRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/RestAPIExecutionConfig"
/>
name: RestAPIExecutionConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/RestAPIMethod" />
name: RestAPIMethod
- description: <SchemaDefinition schemaRef="#/components/schemas/RouteInfo" />
name: RouteInfo
- description: <SchemaDefinition schemaRef="#/components/schemas/RunEvalRequest" /> - description: <SchemaDefinition schemaRef="#/components/schemas/RunEvalRequest" />
name: RunEvalRequest name: RunEvalRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/Job" />
name: Job
- description: <SchemaDefinition schemaRef="#/components/schemas/RunShieldRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/RunShieldRequest"
/> />
name: RunShieldRequest name: RunShieldRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/RunShieldResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/RunShieldResponse"
/> />
name: RunShieldResponse name: RunShieldResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreRequest" /> - name: Safety
name: ScoreRequest - description: <SchemaDefinition schemaRef="#/components/schemas/SafetyViolation"
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreResponse" /> />
name: ScoreResponse name: SafetyViolation
- description: <SchemaDefinition schemaRef="#/components/schemas/SamplingParams" />
name: SamplingParams
- description: <SchemaDefinition schemaRef="#/components/schemas/SamplingStrategy"
/>
name: SamplingStrategy
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreBatchRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/ScoreBatchRequest"
/> />
name: ScoreBatchRequest name: ScoreBatchRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreBatchResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/ScoreBatchResponse"
/> />
name: ScoreBatchResponse name: ScoreBatchResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/DoraFinetuningConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/ScoreRequest" />
name: ScoreRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreResponse" />
name: ScoreResponse
- name: Scoring
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoringFn" />
name: ScoringFn
- name: ScoringFunctions
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoringResult" />
name: ScoringResult
- description: <SchemaDefinition schemaRef="#/components/schemas/SearchToolDefinition"
/> />
name: DoraFinetuningConfig name: SearchToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/FinetuningAlgorithm" - description: 'A single session of an interaction with an Agentic System.
<SchemaDefinition schemaRef="#/components/schemas/Session" />'
name: Session
- description: 'A safety shield resource that can be used to check content
<SchemaDefinition schemaRef="#/components/schemas/Shield" />'
name: Shield
- description: <SchemaDefinition schemaRef="#/components/schemas/ShieldCallStep" />
name: ShieldCallStep
- name: Shields
- description: <SchemaDefinition schemaRef="#/components/schemas/SpanEndPayload" />
name: SpanEndPayload
- description: <SchemaDefinition schemaRef="#/components/schemas/SpanStartPayload"
/> />
name: FinetuningAlgorithm name: SpanStartPayload
- description: <SchemaDefinition schemaRef="#/components/schemas/LoraFinetuningConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/SpanStatus" />
name: SpanStatus
- description: <SchemaDefinition schemaRef="#/components/schemas/StopReason" />
name: StopReason
- description: <SchemaDefinition schemaRef="#/components/schemas/StructuredLogEvent"
/> />
name: LoraFinetuningConfig name: StructuredLogEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/QLoraFinetuningConfig"
/>
name: QLoraFinetuningConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/SupervisedFineTuneRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/SupervisedFineTuneRequest"
/> />
name: SupervisedFineTuneRequest name: SupervisedFineTuneRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerateRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerateRequest"
/> />
name: SyntheticDataGenerateRequest name: SyntheticDataGenerateRequest
- name: SyntheticDataGeneration
- description: 'Response from the synthetic data generation. Batch of (prompt, response, - description: 'Response from the synthetic data generation. Batch of (prompt, response,
score) tuples that pass the threshold. score) tuples that pass the threshold.
@ -5273,9 +5208,74 @@ tags:
<SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerationResponse" <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerationResponse"
/>' />'
name: SyntheticDataGenerationResponse name: SyntheticDataGenerationResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/SystemMessage" />
name: SystemMessage
- name: Telemetry
- description: <SchemaDefinition schemaRef="#/components/schemas/TokenLogProbs" />
name: TokenLogProbs
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCall" />
name: ToolCall
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCallDelta" />
name: ToolCallDelta
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCallParseStatus"
/>
name: ToolCallParseStatus
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolChoice" />
name: ToolChoice
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolDefinition" />
name: ToolDefinition
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolExecutionStep"
/>
name: ToolExecutionStep
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolParamDefinition"
/>
name: ToolParamDefinition
- description: "This Enum refers to the prompt format for calling custom / zero shot\
\ tools\n\n`json` --\n Refers to the json format for calling tools.\n The\
\ json format takes the form like\n {\n \"type\": \"function\",\n \
\ \"function\" : {\n \"name\": \"function_name\",\n \
\ \"description\": \"function_description\",\n \"parameters\": {...}\n\
\ }\n }\n\n`function_tag` --\n This is an example of how you could\
\ define\n your own user defined format for making tool calls.\n The function_tag\
\ format looks like this,\n <function=function_name>(parameters)</function>\n\
\nThe detailed prompts for each of these formats are added to llama cli\n\n<SchemaDefinition\
\ schemaRef=\"#/components/schemas/ToolPromptFormat\" />"
name: ToolPromptFormat
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolResponse" />
name: ToolResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolResponseMessage"
/>
name: ToolResponseMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/Trace" />
name: Trace
- description: <SchemaDefinition schemaRef="#/components/schemas/TrainingConfig" />
name: TrainingConfig
- description: 'A single turn in an interaction with an Agentic System.
<SchemaDefinition schemaRef="#/components/schemas/Turn" />'
name: Turn
- description: <SchemaDefinition schemaRef="#/components/schemas/URL" />
name: URL
- description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent"
/>
name: UnstructuredLogEvent
- description: <SchemaDefinition schemaRef="#/components/schemas/UpdateModelRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/UpdateModelRequest"
/> />
name: UpdateModelRequest name: UpdateModelRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/UserMessage" />
name: UserMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/VectorMemoryBank"
/>
name: VectorMemoryBank
- description: <SchemaDefinition schemaRef="#/components/schemas/VectorMemoryBankParams"
/>
name: VectorMemoryBankParams
- description: <SchemaDefinition schemaRef="#/components/schemas/ViolationLevel" />
name: ViolationLevel
- description: <SchemaDefinition schemaRef="#/components/schemas/WolframAlphaToolDefinition"
/>
name: WolframAlphaToolDefinition
x-tagGroups: x-tagGroups:
- name: Operations - name: Operations
tags: tags: