phoenix-oss/llama-stack
1
0
Fork 0
forked from phoenix-oss/llama-stack-mirror
Code Pull requests Releases Packages 2 Activity Actions
llama-stack/rfcs/RFC-0001-llama-stack-assets/llama-stack-spec.html
Ashwin Bharambe 0167953d2d Update OpenAPI generator for POST requests
2024-09-04 09:27:00 -07:00

6156 lines
219 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>OpenAPI specification</title>
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
<style>
body {
margin: 0;
padding: 0;
}
</style>
<script defer="defer" src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
<script defer="defer">
document.addEventListener("DOMContentLoaded", function () {
spec = {
"openapi": "3.1.0",
"info": {
"title": "[DRAFT] Llama Stack Specification",
"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-04 09:26:21.634687"
},
"servers": [
{
"url": "http://any-hosted-llama-stack.com"
}
],
"paths": {
"/batch_inference/chat_completion": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchChatCompletionResponse"
}
}
}
}
},
"tags": [
"BatchInference"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchChatCompletionRequest"
}
}
},
"required": true
}
}
},
"/batch_inference/completion": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchCompletionResponse"
}
}
}
}
},
"tags": [
"BatchInference"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchCompletionRequest"
}
}
},
"required": true
}
}
},
"/evaluate/job/cancel": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Evaluations"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": true
}
}
},
"/post_training/job/cancel": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"PostTraining"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": true
}
}
},
"/inference/chat_completion": {
"post": {
"responses": {
"200": {
"description": "SSE-stream of these events.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCompletionResponseStreamChunk"
}
}
}
}
},
"tags": [
"Inference"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCompletionRequest"
}
}
},
"required": true
}
}
},
"/inference/completion": {
"post": {
"responses": {
"200": {
"description": "streamed completion response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompletionResponseStreamChunk"
}
}
}
}
},
"tags": [
"Inference"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompletionRequest"
}
}
},
"required": true
}
}
},
"/agentic_system/create": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgenticSystemCreateResponse"
}
}
}
}
},
"tags": [
"AgenticSystem"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfig"
}
}
},
"required": true
}
}
},
"/agentic_system/session/create": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgenticSystemSessionCreateResponse"
}
}
}
}
},
"tags": [
"AgenticSystem"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAgenticSystemSessionRequest"
}
}
},
"required": true
}
}
},
"/agentic_system/turn/create": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/AgenticSystemTurnResponseStreamChunk"
}
}
}
}
},
"tags": [
"AgenticSystem"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgenticSystemTurnCreateRequest"
}
}
},
"required": true
}
}
},
"/datasets/create": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Datasets"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDatasetRequest"
}
}
},
"required": true
}
}
},
"/experiments/create": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateExperimentRequest"
}
}
},
"required": true
}
}
},
"/memory_banks/create": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemoryBank"
}
}
}
}
},
"tags": [
"Memory"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMemoryBankRequest"
}
}
},
"required": true
}
}
},
"/experiments/create_run": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Run"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRunRequest"
}
}
},
"required": true
}
}
},
"/agentic_system/delete": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"AgenticSystem"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": true
}
}
},
"/agentic_system/session/delete": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"AgenticSystem"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAgenticSystemSessionRequest"
}
}
},
"required": true
}
}
},
"/datasets/delete": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Datasets"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": true
}
}
},
"/memory_bank/documents/delete": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Memory"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteDocumentsRequest"
}
}
},
"required": true
}
}
},
"/memory_banks/drop": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
},
"tags": [
"Memory"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": true
}
}
},
"/inference/embeddings": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmbeddingsResponse"
}
}
}
}
},
"tags": [
"Inference"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmbeddingsRequest"
}
}
},
"required": true
}
}
},
"/evaluate/question_answering/": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluationJob"
}
}
}
}
},
"tags": [
"Evaluations"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateQuestionAnsweringRequest"
}
}
},
"required": true
}
}
},
"/evaluate/summarization/": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluationJob"
}
}
}
}
},
"tags": [
"Evaluations"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateSummarizationRequest"
}
}
},
"required": true
}
}
},
"/evaluate/text_generation/": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluationJob"
}
}
}
}
},
"tags": [
"Evaluations"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateTextGenerationRequest"
}
}
},
"required": true
}
}
},
"/agentic_system/session/get": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session"
}
}
}
}
},
"tags": [
"AgenticSystem"
],
"parameters": [
{
"name": "agent_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
}
},
"required": true
}
}
},
"/agentic_system/step/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgenticSystemStepResponse"
}
}
}
}
},
"tags": [
"AgenticSystem"
],
"parameters": [
{
"name": "agent_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "turn_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "step_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/agentic_system/turn/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Turn"
}
}
}
}
},
"tags": [
"AgenticSystem"
],
"parameters": [
{
"name": "agent_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "turn_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/artifacts/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artifact"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [
{
"name": "artifact_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/datasets/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrainEvalDataset"
}
}
}
}
},
"tags": [
"Datasets"
],
"parameters": [
{
"name": "dataset_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/memory_bank/documents/get": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/MemoryBankDocument"
}
}
}
}
},
"tags": [
"Memory"
],
"parameters": [
{
"name": "bank_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
}
}
},
"/evaluate/job/artifacts": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluationJobArtifactsResponse"
}
}
}
}
},
"tags": [
"Evaluations"
],
"parameters": [
{
"name": "job_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/evaluate/job/logs": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluationJobLogStream"
}
}
}
}
},
"tags": [
"Evaluations"
],
"parameters": [
{
"name": "job_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/evaluate/job/status": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluationJobStatusResponse"
}
}
}
}
},
"tags": [
"Evaluations"
],
"parameters": [
{
"name": "job_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/evaluate/jobs": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/EvaluationJob"
}
}
}
}
},
"tags": [
"Evaluations"
],
"parameters": []
}
},
"/experiments/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [
{
"name": "experiment_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/logging/get_logs": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/Log"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogSearchRequest"
}
}
},
"required": true
}
}
},
"/memory_banks/get": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MemoryBank"
},
{
"type": "null"
}
]
}
}
}
}
},
"tags": [
"Memory"
],
"parameters": [
{
"name": "bank_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/runs/metrics": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/Metric"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [
{
"name": "run_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/post_training/job/artifacts": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostTrainingJobArtifactsResponse"
}
}
}
}
},
"tags": [
"PostTraining"
],
"parameters": [
{
"name": "job_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/post_training/job/logs": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostTrainingJobLogStream"
}
}
}
}
},
"tags": [
"PostTraining"
],
"parameters": [
{
"name": "job_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/post_training/job/status": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostTrainingJobStatusResponse"
}
}
}
}
},
"tags": [
"PostTraining"
],
"parameters": [
{
"name": "job_uuid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/post_training/jobs": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/PostTrainingJob"
}
}
}
}
},
"tags": [
"PostTraining"
],
"parameters": []
}
},
"/memory_bank/insert": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Memory"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsertDocumentsRequest"
}
}
},
"required": true
}
}
},
"/experiments/artifacts/get": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/Artifact"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": true
}
}
},
"/experiments/list": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": []
}
},
"/memory_banks/list": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/jsonl": {
"schema": {
"$ref": "#/components/schemas/MemoryBank"
}
}
}
}
},
"tags": [
"Memory"
],
"parameters": []
}
},
"/logging/log_messages": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogMessagesRequest"
}
}
},
"required": true
}
}
},
"/runs/log_metrics": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogMetricsRequest"
}
}
},
"required": true
}
}
},
"/post_training/preference_optimize": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostTrainingJob"
}
}
}
}
},
"tags": [
"PostTraining"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostTrainingRLHFRequest"
}
}
},
"required": true
}
}
},
"/memory_bank/query": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryDocumentsResponse"
}
}
}
}
},
"tags": [
"Memory"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryDocumentsRequest"
}
}
},
"required": true
}
}
},
"/reward_scoring/score": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RewardScoringResponse"
}
}
}
}
},
"tags": [
"RewardScoring"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RewardScoringRequest"
}
}
},
"required": true
}
}
},
"/post_training/supervised_fine_tune": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostTrainingJob"
}
}
}
}
},
"tags": [
"PostTraining"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostTrainingSFTRequest"
}
}
},
"required": true
}
}
},
"/synthetic_data_generation/generate": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyntheticDataGenerationResponse"
}
}
}
}
},
"tags": [
"SyntheticDataGeneration"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyntheticDataGenerationRequest"
}
}
},
"required": true
}
}
},
"/memory_bank/update": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Memory"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentsRequest"
}
}
},
"required": true
}
}
},
"/experiments/update": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateExperimentRequest"
}
}
},
"required": true
}
}
},
"/runs/update": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Run"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRunRequest"
}
}
},
"required": true
}
}
},
"/experiments/artifacts/upload": {
"post": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artifact"
}
}
}
}
},
"tags": [
"Observability"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadArtifactRequest"
}
}
},
"required": true
}
}
}
},
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"components": {
"schemas": {
"BatchChatCompletionRequest": {
"type": "object",
"properties": {
"model": {
"type": "string"
},
"messages_batch": {
"type": "array",
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/SystemMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
},
{
"$ref": "#/components/schemas/CompletionMessage"
}
]
}
}
},
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"tools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolDefinition"
}
},
"tool_choice": {
"$ref": "#/components/schemas/ToolChoice"
},
"tool_prompt_format": {
"$ref": "#/components/schemas/ToolPromptFormat"
},
"logprobs": {
"type": "object",
"properties": {
"top_k": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"model",
"messages_batch"
]
},
"BuiltinTool": {
"type": "string",
"enum": [
"brave_search",
"wolfram_alpha",
"photogen",
"code_interpreter"
]
},
"CompletionMessage": {
"type": "object",
"properties": {
"role": {
"type": "string",
"const": "assistant"
},
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"stop_reason": {
"$ref": "#/components/schemas/StopReason"
},
"tool_calls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolCall"
}
}
},
"additionalProperties": false,
"required": [
"role",
"content",
"stop_reason",
"tool_calls"
]
},
"SamplingParams": {
"type": "object",
"properties": {
"strategy": {
"$ref": "#/components/schemas/SamplingStrategy"
},
"temperature": {
"type": "number"
},
"top_p": {
"type": "number"
},
"top_k": {
"type": "integer"
},
"max_tokens": {
"type": "integer"
},
"repetition_penalty": {
"type": "number"
}
},
"additionalProperties": false,
"required": [
"strategy"
]
},
"SamplingStrategy": {
"type": "string",
"enum": [
"greedy",
"top_p",
"top_k"
]
},
"StopReason": {
"type": "string",
"enum": [
"end_of_turn",
"end_of_message",
"out_of_tokens"
]
},
"SystemMessage": {
"type": "object",
"properties": {
"role": {
"type": "string",
"const": "system"
},
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false,
"required": [
"role",
"content"
]
},
"ToolCall": {
"type": "object",
"properties": {
"call_id": {
"type": "string"
},
"tool_name": {
"oneOf": [
{
"$ref": "#/components/schemas/BuiltinTool"
},
{
"type": "string"
}
]
},
"arguments": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
{
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
]
}
}
},
"additionalProperties": false,
"required": [
"call_id",
"tool_name",
"arguments"
]
},
"ToolChoice": {
"type": "string",
"enum": [
"auto",
"required"
]
},
"ToolDefinition": {
"type": "object",
"properties": {
"tool_name": {
"oneOf": [
{
"$ref": "#/components/schemas/BuiltinTool"
},
{
"type": "string"
}
]
},
"description": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ToolParamDefinition"
}
}
},
"additionalProperties": false,
"required": [
"tool_name"
]
},
"ToolParamDefinition": {
"type": "object",
"properties": {
"param_type": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"param_type"
]
},
"ToolPromptFormat": {
"type": "string",
"enum": [
"json",
"function_tag"
],
"title": "This Enum refers to the prompt format for calling custom / zero shot tools",
"description": "`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"
},
"ToolResponseMessage": {
"type": "object",
"properties": {
"role": {
"type": "string",
"const": "ipython"
},
"call_id": {
"type": "string"
},
"tool_name": {
"oneOf": [
{
"$ref": "#/components/schemas/BuiltinTool"
},
{
"type": "string"
}
]
},
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false,
"required": [
"role",
"call_id",
"tool_name",
"content"
]
},
"UserMessage": {
"type": "object",
"properties": {
"role": {
"type": "string",
"const": "user"
},
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"context": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false,
"required": [
"role",
"content"
]
},
"BatchChatCompletionResponse": {
"type": "object",
"properties": {
"completion_message_batch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompletionMessage"
}
}
},
"additionalProperties": false,
"required": [
"completion_message_batch"
]
},
"BatchCompletionRequest": {
"type": "object",
"properties": {
"model": {
"type": "string"
},
"content_batch": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"logprobs": {
"type": "object",
"properties": {
"top_k": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"model",
"content_batch"
]
},
"BatchCompletionResponse": {
"type": "object",
"properties": {
"completion_message_batch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompletionMessage"
}
}
},
"additionalProperties": false,
"required": [
"completion_message_batch"
]
},
"ChatCompletionRequest": {
"type": "object",
"properties": {
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/SystemMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
},
{
"$ref": "#/components/schemas/CompletionMessage"
}
]
}
},
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"tools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolDefinition"
}
},
"tool_choice": {
"$ref": "#/components/schemas/ToolChoice"
},
"tool_prompt_format": {
"$ref": "#/components/schemas/ToolPromptFormat"
},
"stream": {
"type": "boolean"
},
"logprobs": {
"type": "object",
"properties": {
"top_k": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"model",
"messages"
]
},
"ChatCompletionResponseEvent": {
"type": "object",
"properties": {
"event_type": {
"$ref": "#/components/schemas/ChatCompletionResponseEventType"
},
"delta": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/ToolCallDelta"
}
]
},
"logprobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenLogProbs"
}
},
"stop_reason": {
"$ref": "#/components/schemas/StopReason"
}
},
"additionalProperties": false,
"required": [
"event_type",
"delta"
],
"title": "Chat completion response event."
},
"ChatCompletionResponseEventType": {
"type": "string",
"enum": [
"start",
"complete",
"progress"
]
},
"ChatCompletionResponseStreamChunk": {
"type": "object",
"properties": {
"event": {
"$ref": "#/components/schemas/ChatCompletionResponseEvent"
}
},
"additionalProperties": false,
"required": [
"event"
],
"title": "SSE-stream of these events."
},
"TokenLogProbs": {
"type": "object",
"properties": {
"logprobs_by_token": {
"type": "object",
"additionalProperties": {
"type": "number"
}
}
},
"additionalProperties": false,
"required": [
"logprobs_by_token"
]
},
"ToolCallDelta": {
"type": "object",
"properties": {
"content": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/ToolCall"
}
]
},
"parse_status": {
"$ref": "#/components/schemas/ToolCallParseStatus"
}
},
"additionalProperties": false,
"required": [
"content",
"parse_status"
]
},
"ToolCallParseStatus": {
"type": "string",
"enum": [
"started",
"in_progress",
"failure",
"success"
]
},
"CompletionRequest": {
"type": "object",
"properties": {
"model": {
"type": "string"
},
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"stream": {
"type": "boolean"
},
"logprobs": {
"type": "object",
"properties": {
"top_k": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"model",
"content"
]
},
"CompletionResponseStreamChunk": {
"type": "object",
"properties": {
"delta": {
"type": "string"
},
"stop_reason": {
"$ref": "#/components/schemas/StopReason"
},
"logprobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenLogProbs"
}
}
},
"additionalProperties": false,
"required": [
"delta"
],
"title": "streamed completion response."
},
"AgentConfig": {
"type": "object",
"properties": {
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"input_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"output_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"tools": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BraveSearchToolDefinition"
},
{
"$ref": "#/components/schemas/WolframAlphaToolDefinition"
},
{
"$ref": "#/components/schemas/PhotogenToolDefinition"
},
{
"$ref": "#/components/schemas/CodeInterpreterToolDefinition"
},
{
"$ref": "#/components/schemas/FunctionCallToolDefinition"
},
{
"$ref": "#/components/schemas/MemoryToolDefinition"
}
]
}
},
"tool_choice": {
"$ref": "#/components/schemas/ToolChoice"
},
"tool_prompt_format": {
"$ref": "#/components/schemas/ToolPromptFormat"
},
"model": {
"type": "string"
},
"instructions": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"model",
"instructions"
]
},
"BraveSearchToolDefinition": {
"type": "object",
"properties": {
"input_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"output_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"type": {
"type": "string",
"const": "brave_search"
},
"remote_execution": {
"$ref": "#/components/schemas/RestAPIExecutionConfig"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
"BuiltinShield": {
"type": "string",
"enum": [
"llama_guard",
"code_scanner_guard",
"third_party_shield",
"injection_shield",
"jailbreak_shield"
]
},
"CodeInterpreterToolDefinition": {
"type": "object",
"properties": {
"input_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"output_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"type": {
"type": "string",
"const": "code_interpreter"
},
"enable_inline_code_execution": {
"type": "boolean"
},
"remote_execution": {
"$ref": "#/components/schemas/RestAPIExecutionConfig"
}
},
"additionalProperties": false,
"required": [
"type",
"enable_inline_code_execution"
]
},
"FunctionCallToolDefinition": {
"type": "object",
"properties": {
"input_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"output_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"type": {
"type": "string",
"const": "function_call"
},
"function_name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ToolParamDefinition"
}
},
"remote_execution": {
"$ref": "#/components/schemas/RestAPIExecutionConfig"
}
},
"additionalProperties": false,
"required": [
"type",
"function_name",
"description",
"parameters"
]
},
"MemoryToolDefinition": {
"type": "object",
"properties": {
"input_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"output_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"type": {
"type": "string",
"const": "memory"
},
"memory_bank_configs": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"type": {
"type": "string",
"const": "vector"
}
},
"additionalProperties": false,
"required": [
"bank_id",
"type"
]
},
{
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"type": {
"type": "string",
"const": "keyvalue"
},
"keys": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"bank_id",
"type",
"keys"
]
},
{
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"type": {
"type": "string",
"const": "keyword"
}
},
"additionalProperties": false,
"required": [
"bank_id",
"type"
]
},
{
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"type": {
"type": "string",
"const": "graph"
},
"entities": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"bank_id",
"type",
"entities"
]
}
]
}
},
"max_tokens_in_context": {
"type": "integer"
},
"max_chunks": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"type",
"memory_bank_configs",
"max_tokens_in_context",
"max_chunks"
]
},
"OnViolationAction": {
"type": "integer",
"enum": [
0,
1,
2
]
},
"PhotogenToolDefinition": {
"type": "object",
"properties": {
"input_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"output_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"type": {
"type": "string",
"const": "photogen"
},
"remote_execution": {
"$ref": "#/components/schemas/RestAPIExecutionConfig"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
"RestAPIExecutionConfig": {
"type": "object",
"properties": {
"url": {
"$ref": "#/components/schemas/URL"
},
"method": {
"$ref": "#/components/schemas/RestAPIMethod"
},
"params": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"url",
"method"
]
},
"RestAPIMethod": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE"
]
},
"ShieldDefinition": {
"type": "object",
"properties": {
"shield_type": {
"oneOf": [
{
"$ref": "#/components/schemas/BuiltinShield"
},
{
"type": "string"
}
]
},
"description": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ToolParamDefinition"
}
},
"on_violation_action": {
"$ref": "#/components/schemas/OnViolationAction"
},
"execution_config": {
"$ref": "#/components/schemas/RestAPIExecutionConfig"
}
},
"additionalProperties": false,
"required": [
"shield_type",
"on_violation_action"
]
},
"URL": {
"type": "string",
"format": "uri",
"pattern": "^(https?://|file://|data:)"
},
"WolframAlphaToolDefinition": {
"type": "object",
"properties": {
"input_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"output_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"type": {
"type": "string",
"const": "wolfram_alpha"
},
"remote_execution": {
"$ref": "#/components/schemas/RestAPIExecutionConfig"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
"AgenticSystemCreateResponse": {
"type": "object",
"properties": {
"agent_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"agent_id"
]
},
"CreateAgenticSystemSessionRequest": {
"type": "object",
"properties": {
"agent_id": {
"type": "string"
},
"session_name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"agent_id",
"session_name"
]
},
"AgenticSystemSessionCreateResponse": {
"type": "object",
"properties": {
"session_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"session_id"
]
},
"AgenticSystemTurnCreateRequest": {
"type": "object",
"properties": {
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"input_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"output_shields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShieldDefinition"
}
},
"tools": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BraveSearchToolDefinition"
},
{
"$ref": "#/components/schemas/WolframAlphaToolDefinition"
},
{
"$ref": "#/components/schemas/PhotogenToolDefinition"
},
{
"$ref": "#/components/schemas/CodeInterpreterToolDefinition"
},
{
"$ref": "#/components/schemas/FunctionCallToolDefinition"
},
{
"$ref": "#/components/schemas/MemoryToolDefinition"
}
]
}
},
"tool_choice": {
"$ref": "#/components/schemas/ToolChoice"
},
"tool_prompt_format": {
"$ref": "#/components/schemas/ToolPromptFormat"
},
"instructions": {
"type": "string"
},
"agent_id": {
"type": "string"
},
"session_id": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
}
]
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
}
},
"stream": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"agent_id",
"session_id",
"messages"
]
},
"Attachment": {
"type": "object",
"properties": {
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"$ref": "#/components/schemas/URL"
}
]
},
"mime_type": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"content",
"mime_type"
]
},
"AgenticSystemTurnResponseEvent": {
"type": "object",
"properties": {
"payload": {
"oneOf": [
{
"$ref": "#/components/schemas/AgenticSystemTurnResponseStepStartPayload"
},
{
"$ref": "#/components/schemas/AgenticSystemTurnResponseStepProgressPayload"
},
{
"$ref": "#/components/schemas/AgenticSystemTurnResponseStepCompletePayload"
},
{
"$ref": "#/components/schemas/AgenticSystemTurnResponseTurnStartPayload"
},
{
"$ref": "#/components/schemas/AgenticSystemTurnResponseTurnCompletePayload"
}
]
}
},
"additionalProperties": false,
"required": [
"payload"
],
"title": "Streamed agent execution response."
},
"AgenticSystemTurnResponseStepCompletePayload": {
"type": "object",
"properties": {
"event_type": {
"type": "string",
"const": "step_complete"
},
"step_type": {
"type": "string",
"enum": [
"inference",
"tool_execution",
"shield_call",
"memory_retrieval"
]
},
"step_details": {
"oneOf": [
{
"$ref": "#/components/schemas/InferenceStep"
},
{
"$ref": "#/components/schemas/ToolExecutionStep"
},
{
"$ref": "#/components/schemas/ShieldCallStep"
},
{
"$ref": "#/components/schemas/MemoryRetrievalStep"
}
]
}
},
"additionalProperties": false,
"required": [
"event_type",
"step_type",
"step_details"
]
},
"AgenticSystemTurnResponseStepProgressPayload": {
"type": "object",
"properties": {
"event_type": {
"type": "string",
"const": "step_progress"
},
"step_type": {
"type": "string",
"enum": [
"inference",
"tool_execution",
"shield_call",
"memory_retrieval"
]
},
"step_id": {
"type": "string"
},
"model_response_text_delta": {
"type": "string"
},
"tool_call_delta": {
"$ref": "#/components/schemas/ToolCallDelta"
},
"tool_response_text_delta": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"event_type",
"step_type",
"step_id"
]
},
"AgenticSystemTurnResponseStepStartPayload": {
"type": "object",
"properties": {
"event_type": {
"type": "string",
"const": "step_start"
},
"step_type": {
"type": "string",
"enum": [
"inference",
"tool_execution",
"shield_call",
"memory_retrieval"
]
},
"step_id": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"event_type",
"step_type",
"step_id"
]
},
"AgenticSystemTurnResponseStreamChunk": {
"type": "object",
"properties": {
"event": {
"$ref": "#/components/schemas/AgenticSystemTurnResponseEvent"
}
},
"additionalProperties": false,
"required": [
"event"
]
},
"AgenticSystemTurnResponseTurnCompletePayload": {
"type": "object",
"properties": {
"event_type": {
"type": "string",
"const": "turn_complete"
},
"turn": {
"$ref": "#/components/schemas/Turn"
}
},
"additionalProperties": false,
"required": [
"event_type",
"turn"
]
},
"AgenticSystemTurnResponseTurnStartPayload": {
"type": "object",
"properties": {
"event_type": {
"type": "string",
"const": "turn_start"
},
"turn_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"event_type",
"turn_id"
]
},
"InferenceStep": {
"type": "object",
"properties": {
"turn_id": {
"type": "string"
},
"step_id": {
"type": "string"
},
"started_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": "string",
"format": "date-time"
},
"step_type": {
"type": "string",
"const": "inference"
},
"model_response": {
"$ref": "#/components/schemas/CompletionMessage"
}
},
"additionalProperties": false,
"required": [
"turn_id",
"step_id",
"step_type",
"model_response"
]
},
"MemoryRetrievalStep": {
"type": "object",
"properties": {
"turn_id": {
"type": "string"
},
"step_id": {
"type": "string"
},
"started_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": "string",
"format": "date-time"
},
"step_type": {
"type": "string",
"const": "memory_retrieval"
},
"memory_bank_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"inserted_context": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false,
"required": [
"turn_id",
"step_id",
"step_type",
"memory_bank_ids",
"inserted_context"
]
},
"ShieldCallStep": {
"type": "object",
"properties": {
"turn_id": {
"type": "string"
},
"step_id": {
"type": "string"
},
"started_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": "string",
"format": "date-time"
},
"step_type": {
"type": "string",
"const": "shield_call"
},
"response": {
"$ref": "#/components/schemas/ShieldResponse"
}
},
"additionalProperties": false,
"required": [
"turn_id",
"step_id",
"step_type",
"response"
]
},
"ShieldResponse": {
"type": "object",
"properties": {
"shield_type": {
"oneOf": [
{
"$ref": "#/components/schemas/BuiltinShield"
},
{
"type": "string"
}
]
},
"is_violation": {
"type": "boolean"
},
"violation_type": {
"type": "string"
},
"violation_return_message": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"shield_type",
"is_violation"
]
},
"ToolExecutionStep": {
"type": "object",
"properties": {
"turn_id": {
"type": "string"
},
"step_id": {
"type": "string"
},
"started_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": "string",
"format": "date-time"
},
"step_type": {
"type": "string",
"const": "tool_execution"
},
"tool_calls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolCall"
}
},
"tool_responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolResponse"
}
}
},
"additionalProperties": false,
"required": [
"turn_id",
"step_id",
"step_type",
"tool_calls",
"tool_responses"
]
},
"ToolResponse": {
"type": "object",
"properties": {
"call_id": {
"type": "string"
},
"tool_name": {
"oneOf": [
{
"$ref": "#/components/schemas/BuiltinTool"
},
{
"type": "string"
}
]
},
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false,
"required": [
"call_id",
"tool_name",
"content"
]
},
"Turn": {
"type": "object",
"properties": {
"turn_id": {
"type": "string"
},
"session_id": {
"type": "string"
},
"input_messages": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
}
]
}
},
"steps": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/InferenceStep"
},
{
"$ref": "#/components/schemas/ToolExecutionStep"
},
{
"$ref": "#/components/schemas/ShieldCallStep"
},
{
"$ref": "#/components/schemas/MemoryRetrievalStep"
}
]
}
},
"output_message": {
"$ref": "#/components/schemas/CompletionMessage"
},
"output_attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
}
},
"started_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"turn_id",
"session_id",
"input_messages",
"steps",
"output_message",
"output_attachments",
"started_at"
],
"title": "A single turn in an interaction with an Agentic System."
},
"CreateDatasetRequest": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"dataset": {
"$ref": "#/components/schemas/TrainEvalDataset"
}
},
"additionalProperties": false,
"required": [
"uuid",
"dataset"
],
"title": "Request to create a dataset."
},
"TrainEvalDataset": {
"type": "object",
"properties": {
"columns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/TrainEvalDatasetColumnType"
}
},
"content_url": {
"$ref": "#/components/schemas/URL"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"columns",
"content_url"
],
"title": "Dataset to be used for training or evaluating language models."
},
"TrainEvalDatasetColumnType": {
"type": "string",
"enum": [
"dialog",
"text",
"media",
"number",
"json"
]
},
"CreateExperimentRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"Experiment": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/ExperimentStatus"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"id",
"name",
"status",
"created_at",
"updated_at",
"metadata"
]
},
"ExperimentStatus": {
"type": "string",
"enum": [
"not_started",
"running",
"completed",
"failed"
]
},
"CreateMemoryBankRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"config": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "vector"
},
"embedding_model": {
"type": "string"
},
"chunk_size_in_tokens": {
"type": "integer"
},
"overlap_size_in_tokens": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"type",
"embedding_model",
"chunk_size_in_tokens"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "keyvalue"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "keyword"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "graph"
}
},
"additionalProperties": false,
"required": [
"type"
]
}
]
},
"url": {
"$ref": "#/components/schemas/URL"
}
},
"additionalProperties": false,
"required": [
"name",
"config"
]
},
"MemoryBank": {
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"name": {
"type": "string"
},
"config": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "vector"
},
"embedding_model": {
"type": "string"
},
"chunk_size_in_tokens": {
"type": "integer"
},
"overlap_size_in_tokens": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"type",
"embedding_model",
"chunk_size_in_tokens"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "keyvalue"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "keyword"
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "graph"
}
},
"additionalProperties": false,
"required": [
"type"
]
}
]
},
"url": {
"$ref": "#/components/schemas/URL"
}
},
"additionalProperties": false,
"required": [
"bank_id",
"name",
"config"
]
},
"CreateRunRequest": {
"type": "object",
"properties": {
"experiment_id": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"experiment_id"
]
},
"Run": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"experiment_id": {
"type": "string"
},
"status": {
"type": "string"
},
"started_at": {
"type": "string",
"format": "date-time"
},
"ended_at": {
"type": "string",
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"id",
"experiment_id",
"status",
"started_at",
"metadata"
]
},
"DeleteAgenticSystemSessionRequest": {
"type": "object",
"properties": {
"agent_id": {
"type": "string"
},
"session_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"agent_id",
"session_id"
]
},
"DeleteDocumentsRequest": {
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"document_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"bank_id",
"document_ids"
]
},
"EmbeddingsRequest": {
"type": "object",
"properties": {
"model": {
"type": "string"
},
"contents": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
"additionalProperties": false,
"required": [
"model",
"contents"
]
},
"EmbeddingsResponse": {
"type": "object",
"properties": {
"embeddings": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
},
"additionalProperties": false,
"required": [
"embeddings"
]
},
"Checkpoint": {
"description": "Checkpoint created during training runs"
},
"EvaluateQuestionAnsweringRequest": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
},
"dataset": {
"$ref": "#/components/schemas/TrainEvalDataset"
},
"checkpoint": {
"$ref": "#/components/schemas/Checkpoint"
},
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"metrics": {
"type": "array",
"items": {
"type": "string",
"enum": [
"em",
"f1"
]
}
}
},
"additionalProperties": false,
"required": [
"job_uuid",
"dataset",
"checkpoint",
"sampling_params",
"metrics"
],
"title": "Request to evaluate question answering."
},
"EvaluationJob": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"job_uuid"
]
},
"EvaluateSummarizationRequest": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
},
"dataset": {
"$ref": "#/components/schemas/TrainEvalDataset"
},
"checkpoint": {
"$ref": "#/components/schemas/Checkpoint"
},
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"metrics": {
"type": "array",
"items": {
"type": "string",
"enum": [
"rouge",
"bleu"
]
}
}
},
"additionalProperties": false,
"required": [
"job_uuid",
"dataset",
"checkpoint",
"sampling_params",
"metrics"
],
"title": "Request to evaluate summarization."
},
"EvaluateTextGenerationRequest": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
},
"dataset": {
"$ref": "#/components/schemas/TrainEvalDataset"
},
"checkpoint": {
"$ref": "#/components/schemas/Checkpoint"
},
"sampling_params": {
"$ref": "#/components/schemas/SamplingParams"
},
"metrics": {
"type": "array",
"items": {
"type": "string",
"enum": [
"perplexity",
"rouge",
"bleu"
]
}
}
},
"additionalProperties": false,
"required": [
"job_uuid",
"dataset",
"checkpoint",
"sampling_params",
"metrics"
],
"title": "Request to evaluate text generation."
},
"Session": {
"type": "object",
"properties": {
"session_id": {
"type": "string"
},
"session_name": {
"type": "string"
},
"turns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Turn"
}
},
"started_at": {
"type": "string",
"format": "date-time"
},
"memory_bank": {
"$ref": "#/components/schemas/MemoryBank"
}
},
"additionalProperties": false,
"required": [
"session_id",
"session_name",
"turns",
"started_at"
],
"title": "A single session of an interaction with an Agentic System."
},
"AgenticSystemStepResponse": {
"type": "object",
"properties": {
"step": {
"oneOf": [
{
"$ref": "#/components/schemas/InferenceStep"
},
{
"$ref": "#/components/schemas/ToolExecutionStep"
},
{
"$ref": "#/components/schemas/ShieldCallStep"
},
{
"$ref": "#/components/schemas/MemoryRetrievalStep"
}
]
}
},
"additionalProperties": false,
"required": [
"step"
]
},
"Artifact": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ArtifactType"
},
"size": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"id",
"name",
"type",
"size",
"created_at",
"metadata"
]
},
"ArtifactType": {
"type": "string",
"enum": [
"model",
"dataset",
"checkpoint",
"plot",
"metric",
"config",
"code",
"other"
]
},
"MemoryBankDocument": {
"type": "object",
"properties": {
"document_id": {
"type": "string"
},
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"$ref": "#/components/schemas/URL"
}
]
},
"mime_type": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"document_id",
"content",
"mime_type",
"metadata"
]
},
"EvaluationJobArtifactsResponse": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"job_uuid"
],
"title": "Artifacts of a evaluation job."
},
"EvaluationJobLogStream": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"job_uuid"
]
},
"EvaluationJobStatusResponse": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"job_uuid"
]
},
"LogSearchRequest": {
"type": "object",
"properties": {
"query": {
"type": "string"
},
"filters": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"query"
]
},
"Log": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"level": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"additional_info": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"message",
"level",
"timestamp",
"additional_info"
]
},
"Metric": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"run_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"value",
"timestamp",
"run_id"
]
},
"PostTrainingJobArtifactsResponse": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
},
"checkpoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Checkpoint"
}
}
},
"additionalProperties": false,
"required": [
"job_uuid",
"checkpoints"
],
"title": "Artifacts of a finetuning job."
},
"PostTrainingJobLogStream": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
},
"log_lines": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"job_uuid",
"log_lines"
],
"title": "Stream of logs from a finetuning job."
},
"PostTrainingJobStatus": {
"type": "string",
"enum": [
"running",
"completed",
"failed",
"scheduled"
]
},
"PostTrainingJobStatusResponse": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/PostTrainingJobStatus"
},
"scheduled_at": {
"type": "string",
"format": "date-time"
},
"started_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": "string",
"format": "date-time"
},
"resources_allocated": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"checkpoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Checkpoint"
}
}
},
"additionalProperties": false,
"required": [
"job_uuid",
"status",
"checkpoints"
],
"title": "Status of a finetuning job."
},
"PostTrainingJob": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"job_uuid"
]
},
"InsertDocumentsRequest": {
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemoryBankDocument"
}
},
"ttl_seconds": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"bank_id",
"documents"
]
},
"LogMessagesRequest": {
"type": "object",
"properties": {
"logs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Log"
}
},
"run_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"logs"
]
},
"LogMetricsRequest": {
"type": "object",
"properties": {
"run_id": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Metric"
}
}
},
"additionalProperties": false,
"required": [
"run_id",
"metrics"
]
},
"DPOAlignmentConfig": {
"type": "object",
"properties": {
"reward_scale": {
"type": "number"
},
"reward_clip": {
"type": "number"
},
"epsilon": {
"type": "number"
},
"gamma": {
"type": "number"
}
},
"additionalProperties": false,
"required": [
"reward_scale",
"reward_clip",
"epsilon",
"gamma"
]
},
"OptimizerConfig": {
"type": "object",
"properties": {
"optimizer_type": {
"type": "string",
"enum": [
"adam",
"adamw",
"sgd"
]
},
"lr": {
"type": "number"
},
"lr_min": {
"type": "number"
},
"weight_decay": {
"type": "number"
}
},
"additionalProperties": false,
"required": [
"optimizer_type",
"lr",
"lr_min",
"weight_decay"
]
},
"PostTrainingRLHFRequest": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
},
"finetuned_model": {
"$ref": "#/components/schemas/URL"
},
"dataset": {
"$ref": "#/components/schemas/TrainEvalDataset"
},
"validation_dataset": {
"$ref": "#/components/schemas/TrainEvalDataset"
},
"algorithm": {
"$ref": "#/components/schemas/RLHFAlgorithm"
},
"algorithm_config": {
"$ref": "#/components/schemas/DPOAlignmentConfig"
},
"optimizer_config": {
"$ref": "#/components/schemas/OptimizerConfig"
},
"training_config": {
"$ref": "#/components/schemas/TrainingConfig"
},
"hyperparam_search_config": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"logger_config": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"job_uuid",
"finetuned_model",
"dataset",
"validation_dataset",
"algorithm",
"algorithm_config",
"optimizer_config",
"training_config",
"hyperparam_search_config",
"logger_config"
],
"title": "Request to finetune a model."
},
"RLHFAlgorithm": {
"type": "string",
"enum": [
"dpo"
]
},
"TrainingConfig": {
"type": "object",
"properties": {
"n_epochs": {
"type": "integer"
},
"batch_size": {
"type": "integer"
},
"shuffle": {
"type": "boolean"
},
"n_iters": {
"type": "integer"
},
"enable_activation_checkpointing": {
"type": "boolean"
},
"memory_efficient_fsdp_wrap": {
"type": "boolean"
},
"fsdp_cpu_offload": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"n_epochs",
"batch_size",
"shuffle",
"n_iters",
"enable_activation_checkpointing",
"memory_efficient_fsdp_wrap",
"fsdp_cpu_offload"
]
},
"QueryDocumentsRequest": {
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"query": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"params": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"bank_id",
"query"
]
},
"QueryDocumentsResponse": {
"type": "object",
"properties": {
"chunks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"token_count": {
"type": "integer"
},
"document_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"content",
"token_count",
"document_id"
]
}
},
"scores": {
"type": "array",
"items": {
"type": "number"
}
}
},
"additionalProperties": false,
"required": [
"chunks",
"scores"
]
},
"DialogGenerations": {
"type": "object",
"properties": {
"dialog": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/SystemMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
},
{
"$ref": "#/components/schemas/CompletionMessage"
}
]
}
},
"sampled_generations": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/SystemMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
},
{
"$ref": "#/components/schemas/CompletionMessage"
}
]
}
}
},
"additionalProperties": false,
"required": [
"dialog",
"sampled_generations"
]
},
"RewardScoringRequest": {
"type": "object",
"properties": {
"dialog_generations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DialogGenerations"
}
},
"model": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"dialog_generations",
"model"
],
"title": "Request to score a reward function. A list of prompts and a list of responses per prompt."
},
"RewardScoringResponse": {
"type": "object",
"properties": {
"scored_generations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoredDialogGenerations"
}
}
},
"additionalProperties": false,
"required": [
"scored_generations"
],
"title": "Response from the reward scoring. Batch of (prompt, response, score) tuples that pass the threshold."
},
"ScoredDialogGenerations": {
"type": "object",
"properties": {
"dialog": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/SystemMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
},
{
"$ref": "#/components/schemas/CompletionMessage"
}
]
}
},
"scored_generations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoredMessage"
}
}
},
"additionalProperties": false,
"required": [
"dialog",
"scored_generations"
]
},
"ScoredMessage": {
"type": "object",
"properties": {
"message": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/SystemMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
},
{
"$ref": "#/components/schemas/CompletionMessage"
}
]
},
"score": {
"type": "number"
}
},
"additionalProperties": false,
"required": [
"message",
"score"
]
},
"DoraFinetuningConfig": {
"type": "object",
"properties": {
"lora_attn_modules": {
"type": "array",
"items": {
"type": "string"
}
},
"apply_lora_to_mlp": {
"type": "boolean"
},
"apply_lora_to_output": {
"type": "boolean"
},
"rank": {
"type": "integer"
},
"alpha": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"lora_attn_modules",
"apply_lora_to_mlp",
"apply_lora_to_output",
"rank",
"alpha"
]
},
"FinetuningAlgorithm": {
"type": "string",
"enum": [
"full",
"lora",
"qlora",
"dora"
]
},
"LoraFinetuningConfig": {
"type": "object",
"properties": {
"lora_attn_modules": {
"type": "array",
"items": {
"type": "string"
}
},
"apply_lora_to_mlp": {
"type": "boolean"
},
"apply_lora_to_output": {
"type": "boolean"
},
"rank": {
"type": "integer"
},
"alpha": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"lora_attn_modules",
"apply_lora_to_mlp",
"apply_lora_to_output",
"rank",
"alpha"
]
},
"PostTrainingSFTRequest": {
"type": "object",
"properties": {
"job_uuid": {
"type": "string"
},
"model": {
"type": "string"
},
"dataset": {
"$ref": "#/components/schemas/TrainEvalDataset"
},
"validation_dataset": {
"$ref": "#/components/schemas/TrainEvalDataset"
},
"algorithm": {
"$ref": "#/components/schemas/FinetuningAlgorithm"
},
"algorithm_config": {
"oneOf": [
{
"$ref": "#/components/schemas/LoraFinetuningConfig"
},
{
"$ref": "#/components/schemas/QLoraFinetuningConfig"
},
{
"$ref": "#/components/schemas/DoraFinetuningConfig"
}
]
},
"optimizer_config": {
"$ref": "#/components/schemas/OptimizerConfig"
},
"training_config": {
"$ref": "#/components/schemas/TrainingConfig"
},
"hyperparam_search_config": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
},
"logger_config": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"job_uuid",
"model",
"dataset",
"validation_dataset",
"algorithm",
"algorithm_config",
"optimizer_config",
"training_config",
"hyperparam_search_config",
"logger_config"
],
"title": "Request to finetune a model."
},
"QLoraFinetuningConfig": {
"type": "object",
"properties": {
"lora_attn_modules": {
"type": "array",
"items": {
"type": "string"
}
},
"apply_lora_to_mlp": {
"type": "boolean"
},
"apply_lora_to_output": {
"type": "boolean"
},
"rank": {
"type": "integer"
},
"alpha": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"lora_attn_modules",
"apply_lora_to_mlp",
"apply_lora_to_output",
"rank",
"alpha"
]
},
"SyntheticDataGenerationRequest": {
"type": "object",
"properties": {
"dialogs": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserMessage"
},
{
"$ref": "#/components/schemas/SystemMessage"
},
{
"$ref": "#/components/schemas/ToolResponseMessage"
},
{
"$ref": "#/components/schemas/CompletionMessage"
}
]
}
},
"filtering_function": {
"type": "string",
"enum": [
"none",
"random",
"top_k",
"top_p",
"top_k_top_p",
"sigmoid"
],
"title": "The type of filtering function."
},
"model": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"dialogs",
"filtering_function"
],
"title": "Request to generate synthetic data. A small batch of prompts and a filtering function"
},
"SyntheticDataGenerationResponse": {
"type": "object",
"properties": {
"synthetic_data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoredDialogGenerations"
}
},
"statistics": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"synthetic_data"
],
"title": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold."
},
"UpdateDocumentsRequest": {
"type": "object",
"properties": {
"bank_id": {
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemoryBankDocument"
}
}
},
"additionalProperties": false,
"required": [
"bank_id",
"documents"
]
},
"UpdateExperimentRequest": {
"type": "object",
"properties": {
"experiment_id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/ExperimentStatus"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"experiment_id"
]
},
"UpdateRunRequest": {
"type": "object",
"properties": {
"run_id": {
"type": "string"
},
"status": {
"type": "string"
},
"ended_at": {
"type": "string",
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"run_id"
]
},
"UploadArtifactRequest": {
"type": "object",
"properties": {
"experiment_id": {
"type": "string"
},
"name": {
"type": "string"
},
"artifact_type": {
"type": "string"
},
"content": {
"type": "string",
"contentEncoding": "base64"
},
"metadata": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array"
},
{
"type": "object"
}
]
}
}
},
"additionalProperties": false,
"required": [
"experiment_id",
"name",
"artifact_type",
"content"
]
}
},
"responses": {}
},
"security": [
{
"Default": []
}
],
"tags": [
{
"name": "Observability"
},
{
"name": "Evaluations"
},
{
"name": "Memory"
},
{
"name": "BatchInference"
},
{
"name": "RewardScoring"
},
{
"name": "SyntheticDataGeneration"
},
{
"name": "PostTraining"
},
{
"name": "AgenticSystem"
},
{
"name": "Datasets"
},
{
"name": "Inference"
},
{
"name": "BatchChatCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionRequest\" />"
},
{
"name": "BuiltinTool",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BuiltinTool\" />"
},
{
"name": "CompletionMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionMessage\" />"
},
{
"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": "UserMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserMessage\" />"
},
{
"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": "ChatCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionRequest\" />"
},
{
"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": "CompletionResponseStreamChunk",
"description": "streamed completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponseStreamChunk\" />"
},
{
"name": "AgentConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentConfig\" />"
},
{
"name": "BraveSearchToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BraveSearchToolDefinition\" />"
},
{
"name": "BuiltinShield",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BuiltinShield\" />"
},
{
"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": "OnViolationAction",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/OnViolationAction\" />"
},
{
"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": "ShieldDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldDefinition\" />"
},
{
"name": "URL",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/URL\" />"
},
{
"name": "WolframAlphaToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/WolframAlphaToolDefinition\" />"
},
{
"name": "AgenticSystemCreateResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemCreateResponse\" />"
},
{
"name": "CreateAgenticSystemSessionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgenticSystemSessionRequest\" />"
},
{
"name": "AgenticSystemSessionCreateResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemSessionCreateResponse\" />"
},
{
"name": "AgenticSystemTurnCreateRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurnCreateRequest\" />"
},
{
"name": "Attachment",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Attachment\" />"
},
{
"name": "AgenticSystemTurnResponseEvent",
"description": "Streamed agent execution response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurnResponseEvent\" />"
},
{
"name": "AgenticSystemTurnResponseStepCompletePayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurnResponseStepCompletePayload\" />"
},
{
"name": "AgenticSystemTurnResponseStepProgressPayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurnResponseStepProgressPayload\" />"
},
{
"name": "AgenticSystemTurnResponseStepStartPayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurnResponseStepStartPayload\" />"
},
{
"name": "AgenticSystemTurnResponseStreamChunk",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurnResponseStreamChunk\" />"
},
{
"name": "AgenticSystemTurnResponseTurnCompletePayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurnResponseTurnCompletePayload\" />"
},
{
"name": "AgenticSystemTurnResponseTurnStartPayload",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurnResponseTurnStartPayload\" />"
},
{
"name": "InferenceStep",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/InferenceStep\" />"
},
{
"name": "MemoryRetrievalStep",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryRetrievalStep\" />"
},
{
"name": "ShieldCallStep",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldCallStep\" />"
},
{
"name": "ShieldResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldResponse\" />"
},
{
"name": "ToolExecutionStep",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolExecutionStep\" />"
},
{
"name": "ToolResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ToolResponse\" />"
},
{
"name": "Turn",
"description": "A single turn in an interaction with an Agentic System.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Turn\" />"
},
{
"name": "CreateDatasetRequest",
"description": "Request to create a dataset.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CreateDatasetRequest\" />"
},
{
"name": "TrainEvalDataset",
"description": "Dataset to be used for training or evaluating language models.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/TrainEvalDataset\" />"
},
{
"name": "TrainEvalDatasetColumnType",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainEvalDatasetColumnType\" />"
},
{
"name": "CreateExperimentRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateExperimentRequest\" />"
},
{
"name": "Experiment",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Experiment\" />"
},
{
"name": "ExperimentStatus",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ExperimentStatus\" />"
},
{
"name": "CreateMemoryBankRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateMemoryBankRequest\" />"
},
{
"name": "MemoryBank",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBank\" />"
},
{
"name": "CreateRunRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateRunRequest\" />"
},
{
"name": "Run",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Run\" />"
},
{
"name": "DeleteAgenticSystemSessionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteAgenticSystemSessionRequest\" />"
},
{
"name": "DeleteDocumentsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeleteDocumentsRequest\" />"
},
{
"name": "EmbeddingsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EmbeddingsRequest\" />"
},
{
"name": "EmbeddingsResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EmbeddingsResponse\" />"
},
{
"name": "Checkpoint",
"description": "Checkpoint created during training runs\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Checkpoint\" />"
},
{
"name": "EvaluateQuestionAnsweringRequest",
"description": "Request to evaluate question answering.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateQuestionAnsweringRequest\" />"
},
{
"name": "EvaluationJob",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluationJob\" />"
},
{
"name": "EvaluateSummarizationRequest",
"description": "Request to evaluate summarization.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateSummarizationRequest\" />"
},
{
"name": "EvaluateTextGenerationRequest",
"description": "Request to evaluate text generation.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateTextGenerationRequest\" />"
},
{
"name": "Session",
"description": "A single session of an interaction with an Agentic System.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Session\" />"
},
{
"name": "AgenticSystemStepResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemStepResponse\" />"
},
{
"name": "Artifact",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Artifact\" />"
},
{
"name": "ArtifactType",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ArtifactType\" />"
},
{
"name": "MemoryBankDocument",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBankDocument\" />"
},
{
"name": "EvaluationJobArtifactsResponse",
"description": "Artifacts of a evaluation job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluationJobArtifactsResponse\" />"
},
{
"name": "EvaluationJobLogStream",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluationJobLogStream\" />"
},
{
"name": "EvaluationJobStatusResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluationJobStatusResponse\" />"
},
{
"name": "LogSearchRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogSearchRequest\" />"
},
{
"name": "Log",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Log\" />"
},
{
"name": "Metric",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Metric\" />"
},
{
"name": "PostTrainingJobArtifactsResponse",
"description": "Artifacts of a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobArtifactsResponse\" />"
},
{
"name": "PostTrainingJobLogStream",
"description": "Stream of logs from a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobLogStream\" />"
},
{
"name": "PostTrainingJobStatus",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobStatus\" />"
},
{
"name": "PostTrainingJobStatusResponse",
"description": "Status of a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobStatusResponse\" />"
},
{
"name": "PostTrainingJob",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJob\" />"
},
{
"name": "InsertDocumentsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/InsertDocumentsRequest\" />"
},
{
"name": "LogMessagesRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogMessagesRequest\" />"
},
{
"name": "LogMetricsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogMetricsRequest\" />"
},
{
"name": "DPOAlignmentConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />"
},
{
"name": "OptimizerConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/OptimizerConfig\" />"
},
{
"name": "PostTrainingRLHFRequest",
"description": "Request to finetune a model.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingRLHFRequest\" />"
},
{
"name": "RLHFAlgorithm",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RLHFAlgorithm\" />"
},
{
"name": "TrainingConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainingConfig\" />"
},
{
"name": "QueryDocumentsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/QueryDocumentsRequest\" />"
},
{
"name": "QueryDocumentsResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/QueryDocumentsResponse\" />"
},
{
"name": "DialogGenerations",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DialogGenerations\" />"
},
{
"name": "RewardScoringRequest",
"description": "Request to score a reward function. A list of prompts and a list of responses per prompt.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/RewardScoringRequest\" />"
},
{
"name": "RewardScoringResponse",
"description": "Response from the reward scoring. Batch of (prompt, response, score) tuples that pass the threshold.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/RewardScoringResponse\" />"
},
{
"name": "ScoredDialogGenerations",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoredDialogGenerations\" />"
},
{
"name": "ScoredMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoredMessage\" />"
},
{
"name": "DoraFinetuningConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DoraFinetuningConfig\" />"
},
{
"name": "FinetuningAlgorithm",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/FinetuningAlgorithm\" />"
},
{
"name": "LoraFinetuningConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LoraFinetuningConfig\" />"
},
{
"name": "PostTrainingSFTRequest",
"description": "Request to finetune a model.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingSFTRequest\" />"
},
{
"name": "QLoraFinetuningConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/QLoraFinetuningConfig\" />"
},
{
"name": "SyntheticDataGenerationRequest",
"description": "Request to generate synthetic data. A small batch of prompts and a filtering function\n\n<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerationRequest\" />"
},
{
"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\" />"
},
{
"name": "UpdateDocumentsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateDocumentsRequest\" />"
},
{
"name": "UpdateExperimentRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateExperimentRequest\" />"
},
{
"name": "UpdateRunRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateRunRequest\" />"
},
{
"name": "UploadArtifactRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UploadArtifactRequest\" />"
}
],
"x-tagGroups": [
{
"name": "Operations",
"tags": [
"AgenticSystem",
"BatchInference",
"Datasets",
"Evaluations",
"Inference",
"Memory",
"Observability",
"PostTraining",
"RewardScoring",
"SyntheticDataGeneration"
]
},
{
"name": "Types",
"tags": [
"AgentConfig",
"AgenticSystemCreateResponse",
"AgenticSystemSessionCreateResponse",
"AgenticSystemStepResponse",
"AgenticSystemTurnCreateRequest",
"AgenticSystemTurnResponseEvent",
"AgenticSystemTurnResponseStepCompletePayload",
"AgenticSystemTurnResponseStepProgressPayload",
"AgenticSystemTurnResponseStepStartPayload",
"AgenticSystemTurnResponseStreamChunk",
"AgenticSystemTurnResponseTurnCompletePayload",
"AgenticSystemTurnResponseTurnStartPayload",
"Artifact",
"ArtifactType",
"Attachment",
"BatchChatCompletionRequest",
"BatchChatCompletionResponse",
"BatchCompletionRequest",
"BatchCompletionResponse",
"BraveSearchToolDefinition",
"BuiltinShield",
"BuiltinTool",
"ChatCompletionRequest",
"ChatCompletionResponseEvent",
"ChatCompletionResponseEventType",
"ChatCompletionResponseStreamChunk",
"Checkpoint",
"CodeInterpreterToolDefinition",
"CompletionMessage",
"CompletionRequest",
"CompletionResponseStreamChunk",
"CreateAgenticSystemSessionRequest",
"CreateDatasetRequest",
"CreateExperimentRequest",
"CreateMemoryBankRequest",
"CreateRunRequest",
"DPOAlignmentConfig",
"DeleteAgenticSystemSessionRequest",
"DeleteDocumentsRequest",
"DialogGenerations",
"DoraFinetuningConfig",
"EmbeddingsRequest",
"EmbeddingsResponse",
"EvaluateQuestionAnsweringRequest",
"EvaluateSummarizationRequest",
"EvaluateTextGenerationRequest",
"EvaluationJob",
"EvaluationJobArtifactsResponse",
"EvaluationJobLogStream",
"EvaluationJobStatusResponse",
"Experiment",
"ExperimentStatus",
"FinetuningAlgorithm",
"FunctionCallToolDefinition",
"InferenceStep",
"InsertDocumentsRequest",
"Log",
"LogMessagesRequest",
"LogMetricsRequest",
"LogSearchRequest",
"LoraFinetuningConfig",
"MemoryBank",
"MemoryBankDocument",
"MemoryRetrievalStep",
"MemoryToolDefinition",
"Metric",
"OnViolationAction",
"OptimizerConfig",
"PhotogenToolDefinition",
"PostTrainingJob",
"PostTrainingJobArtifactsResponse",
"PostTrainingJobLogStream",
"PostTrainingJobStatus",
"PostTrainingJobStatusResponse",
"PostTrainingRLHFRequest",
"PostTrainingSFTRequest",
"QLoraFinetuningConfig",
"QueryDocumentsRequest",
"QueryDocumentsResponse",
"RLHFAlgorithm",
"RestAPIExecutionConfig",
"RestAPIMethod",
"RewardScoringRequest",
"RewardScoringResponse",
"Run",
"SamplingParams",
"SamplingStrategy",
"ScoredDialogGenerations",
"ScoredMessage",
"Session",
"ShieldCallStep",
"ShieldDefinition",
"ShieldResponse",
"StopReason",
"SyntheticDataGenerationRequest",
"SyntheticDataGenerationResponse",
"SystemMessage",
"TokenLogProbs",
"ToolCall",
"ToolCallDelta",
"ToolCallParseStatus",
"ToolChoice",
"ToolDefinition",
"ToolExecutionStep",
"ToolParamDefinition",
"ToolPromptFormat",
"ToolResponse",
"ToolResponseMessage",
"TrainEvalDataset",
"TrainEvalDatasetColumnType",
"TrainingConfig",
"Turn",
"URL",
"UpdateDocumentsRequest",
"UpdateExperimentRequest",
"UpdateRunRequest",
"UploadArtifactRequest",
"UserMessage",
"WolframAlphaToolDefinition"
]
}
]
};
options = {
downloadFileName: "openapi.json",
expandResponses: "200",
expandSingleSchemaField: true,
jsonSampleExpandLevel: "all",
schemaExpansionLevel: "all",
};
element = document.getElementById("openapi-container");
Redoc.init(spec, options, element);
if (spec.info && spec.info.title) {
document.title = spec.info.title;
}
});
</script>
</head>
<body>
<div id="openapi-container"></div>
</body>
</html>
View git blame Copy permalink