diff --git a/docs/openapi_generator/generate.py b/docs/openapi_generator/generate.py index 46bc32297..3aa7ea6dc 100644 --- a/docs/openapi_generator/generate.py +++ b/docs/openapi_generator/generate.py @@ -33,10 +33,8 @@ schema_utils.json_schema_type = json_schema_type # this line needs to be here to ensure json_schema_type has been altered before # the imports use the annotation -from llama_stack.distribution.stack import ( # noqa: E402 - LLAMA_STACK_API_VERSION, - LlamaStack, -) +from llama_stack.apis.version import LLAMA_STACK_API_VERSION # noqa: E402 +from llama_stack.distribution.stack import LlamaStack # noqa: E402 def main(output_dir: str): diff --git a/docs/openapi_generator/pyopenapi/generator.py b/docs/openapi_generator/pyopenapi/generator.py index 835c4401c..2e1fbb856 100644 --- a/docs/openapi_generator/pyopenapi/generator.py +++ b/docs/openapi_generator/pyopenapi/generator.py @@ -204,7 +204,7 @@ class ContentBuilder: if self.schema_transformer: schema_transformer: Callable[[SchemaOrRef], SchemaOrRef] = ( self.schema_transformer - ) # type: ignore + ) schema = schema_transformer(schema) if not examples: diff --git a/docs/openapi_generator/pyopenapi/operations.py b/docs/openapi_generator/pyopenapi/operations.py index c33fa70e2..cc3a06b7b 100644 --- a/docs/openapi_generator/pyopenapi/operations.py +++ b/docs/openapi_generator/pyopenapi/operations.py @@ -12,7 +12,7 @@ import uuid from dataclasses import dataclass from typing import Any, Callable, Dict, Iterable, Iterator, List, Optional, Tuple, Union -from llama_stack.distribution.stack import LLAMA_STACK_API_VERSION +from llama_stack.apis.version import LLAMA_STACK_API_VERSION from termcolor import colored diff --git a/docs/resources/llama-stack-spec.html b/docs/resources/llama-stack-spec.html index d76c0ba38..838633a4f 100644 --- a/docs/resources/llama-stack-spec.html +++ b/docs/resources/llama-stack-spec.html @@ -21,7 +21,7 @@ "info": { "title": "[DRAFT] Llama Stack Specification", "version": "alpha", - "description": "This is the specification of the llama stack that provides\n a set of endpoints and their corresponding interfaces that are tailored to\n best leverage Llama Models. The specification is still in draft and subject to change.\n Generated at 2024-11-18 18:52:41.983165" + "description": "This is the specification of the llama stack that provides\n a set of endpoints and their corresponding interfaces that are tailored to\n best leverage Llama Models. The specification is still in draft and subject to change.\n Generated at 2024-11-18 23:37:24.867143" }, "servers": [ { @@ -152,433 +152,10 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "completion_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - }, - "logprobs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "logprobs_by_token": { - "type": "object", - "additionalProperties": { - "type": "number" - } - } - }, - "additionalProperties": false, - "required": [ - "logprobs_by_token" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "completion_message" - ], - "title": "Chat completion response." + "$ref": "#/components/schemas/ChatCompletionResponse" }, { - "type": "object", - "properties": { - "event": { - "type": "object", - "properties": { - "event_type": { - "type": "string", - "enum": [ - "start", - "complete", - "progress" - ] - }, - "delta": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - ] - }, - "parse_status": { - "type": "string", - "enum": [ - "started", - "in_progress", - "failure", - "success" - ] - } - }, - "additionalProperties": false, - "required": [ - "content", - "parse_status" - ] - } - ] - }, - "logprobs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "logprobs_by_token": { - "type": "object", - "additionalProperties": { - "type": "number" - } - } - }, - "additionalProperties": false, - "required": [ - "logprobs_by_token" - ] - } - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - } - }, - "additionalProperties": false, - "required": [ - "event_type", - "delta" - ], - "title": "Chat completion response event." - } - }, - "additionalProperties": false, - "required": [ - "event" - ], - "title": "SSE-stream of these events." + "$ref": "#/components/schemas/ChatCompletionResponseStreamChunk" } ] } @@ -622,83 +199,10 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "content": { - "type": "string" - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "logprobs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "logprobs_by_token": { - "type": "object", - "additionalProperties": { - "type": "number" - } - } - }, - "additionalProperties": false, - "required": [ - "logprobs_by_token" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "content", - "stop_reason" - ], - "title": "Completion response." + "$ref": "#/components/schemas/CompletionResponse" }, { - "type": "object", - "properties": { - "delta": { - "type": "string" - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "logprobs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "logprobs_by_token": { - "type": "object", - "additionalProperties": { - "type": "number" - } - } - }, - "additionalProperties": false, - "required": [ - "logprobs_by_token" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "delta" - ], - "title": "streamed completion response." + "$ref": "#/components/schemas/CompletionResponseStreamChunk" } ] } @@ -822,3859 +326,10 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "turn_id": { - "type": "string" - }, - "session_id": { - "type": "string" - }, - "input_messages": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] - }, - { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] - } - ] - } - }, - "steps": { - "type": "array", - "items": { - "oneOf": [ - { - "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", - "default": "inference" - }, - "model_response": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "model_response" - ] - }, - { - "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", - "default": "tool_execution" - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - }, - "tool_responses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "call_id", - "tool_name", - "content" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "tool_calls", - "tool_responses" - ] - }, - { - "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", - "default": "shield_call" - }, - "violation": { - "type": "object", - "properties": { - "violation_level": { - "type": "string", - "enum": [ - "info", - "warn", - "error" - ] - }, - "user_message": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "violation_level", - "metadata" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type" - ] - }, - { - "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", - "default": "memory_retrieval" - }, - "memory_bank_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "inserted_context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "memory_bank_ids", - "inserted_context" - ] - } - ] - } - }, - "output_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - }, - "output_attachments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - }, - "mime_type": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "content", - "mime_type" - ] - } - }, - "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." + "$ref": "#/components/schemas/Turn" }, { - "type": "object", - "properties": { - "event": { - "type": "object", - "properties": { - "payload": { - "oneOf": [ - { - "type": "object", - "properties": { - "event_type": { - "type": "string", - "const": "step_start", - "default": "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" - ] - }, - { - "type": "object", - "properties": { - "event_type": { - "type": "string", - "const": "step_progress", - "default": "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": { - "type": "object", - "properties": { - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - ] - }, - "parse_status": { - "type": "string", - "enum": [ - "started", - "in_progress", - "failure", - "success" - ] - } - }, - "additionalProperties": false, - "required": [ - "content", - "parse_status" - ] - }, - "tool_response_text_delta": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "event_type", - "step_type", - "step_id" - ] - }, - { - "type": "object", - "properties": { - "event_type": { - "type": "string", - "const": "step_complete", - "default": "step_complete" - }, - "step_type": { - "type": "string", - "enum": [ - "inference", - "tool_execution", - "shield_call", - "memory_retrieval" - ] - }, - "step_details": { - "oneOf": [ - { - "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", - "default": "inference" - }, - "model_response": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "model_response" - ] - }, - { - "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", - "default": "tool_execution" - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - }, - "tool_responses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "call_id", - "tool_name", - "content" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "tool_calls", - "tool_responses" - ] - }, - { - "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", - "default": "shield_call" - }, - "violation": { - "type": "object", - "properties": { - "violation_level": { - "type": "string", - "enum": [ - "info", - "warn", - "error" - ] - }, - "user_message": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "violation_level", - "metadata" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type" - ] - }, - { - "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", - "default": "memory_retrieval" - }, - "memory_bank_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "inserted_context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "memory_bank_ids", - "inserted_context" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "event_type", - "step_type", - "step_details" - ] - }, - { - "type": "object", - "properties": { - "event_type": { - "type": "string", - "const": "turn_start", - "default": "turn_start" - }, - "turn_id": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "event_type", - "turn_id" - ] - }, - { - "type": "object", - "properties": { - "event_type": { - "type": "string", - "const": "turn_complete", - "default": "turn_complete" - }, - "turn": { - "type": "object", - "properties": { - "turn_id": { - "type": "string" - }, - "session_id": { - "type": "string" - }, - "input_messages": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] - }, - { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] - } - ] - } - }, - "steps": { - "type": "array", - "items": { - "oneOf": [ - { - "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", - "default": "inference" - }, - "model_response": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "model_response" - ] - }, - { - "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", - "default": "tool_execution" - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - }, - "tool_responses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "call_id", - "tool_name", - "content" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "tool_calls", - "tool_responses" - ] - }, - { - "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", - "default": "shield_call" - }, - "violation": { - "type": "object", - "properties": { - "violation_level": { - "type": "string", - "enum": [ - "info", - "warn", - "error" - ] - }, - "user_message": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "violation_level", - "metadata" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type" - ] - }, - { - "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", - "default": "memory_retrieval" - }, - "memory_bank_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "inserted_context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "memory_bank_ids", - "inserted_context" - ] - } - ] - } - }, - "output_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - }, - "output_attachments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - }, - "mime_type": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "content", - "mime_type" - ] - } - }, - "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." - } - }, - "additionalProperties": false, - "required": [ - "event_type", - "turn" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "payload" - ], - "title": "Streamed agent execution response." - } - }, - "additionalProperties": false, - "required": [ - "event" - ], - "title": "streamed agent turn completion response." + "$ref": "#/components/schemas/AgentTurnResponseStreamChunk" } ] } @@ -5036,217 +691,7 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "dataset", - "default": "dataset" - }, - "dataset_schema": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "string", - "default": "string" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "number", - "default": "number" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "boolean", - "default": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "array", - "default": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "object", - "default": "object" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "json", - "default": "json" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "union", - "default": "union" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "chat_completion_input", - "default": "chat_completion_input" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "completion_input", - "default": "completion_input" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "agent_turn_input", - "default": "agent_turn_input" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - } - }, - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "dataset_schema", - "url", - "metadata" - ] + "$ref": "#/components/schemas/Dataset" }, { "type": "null" @@ -5291,67 +736,7 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "eval_task", - "default": "eval_task" - }, - "dataset_id": { - "type": "string" - }, - "scoring_functions": { - "type": "array", - "items": { - "type": "string" - } - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "dataset_id", - "scoring_functions", - "metadata" - ] + "$ref": "#/components/schemas/EvalTask" }, { "type": "null" @@ -5398,143 +783,16 @@ { "oneOf": [ { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "vector", - "default": "vector" - }, - "embedding_model": { - "type": "string" - }, - "chunk_size_in_tokens": { - "type": "integer" - }, - "overlap_size_in_tokens": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type", - "embedding_model", - "chunk_size_in_tokens" - ] + "$ref": "#/components/schemas/VectorMemoryBank" }, { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "keyvalue", - "default": "keyvalue" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] + "$ref": "#/components/schemas/KeyValueMemoryBank" }, { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "keyword", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] + "$ref": "#/components/schemas/KeywordMemoryBank" }, { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "graph", - "default": "graph" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] + "$ref": "#/components/schemas/GraphMemoryBank" } ] }, @@ -5581,56 +839,7 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "model", - "default": "model" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "metadata" - ] + "$ref": "#/components/schemas/Model" }, { "type": "null" @@ -5737,255 +946,7 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "scoring_function", - "default": "scoring_function" - }, - "description": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "return_type": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "string", - "default": "string" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "number", - "default": "number" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "boolean", - "default": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "array", - "default": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "object", - "default": "object" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "json", - "default": "json" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "union", - "default": "union" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "chat_completion_input", - "default": "chat_completion_input" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "completion_input", - "default": "completion_input" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "agent_turn_input", - "default": "agent_turn_input" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - }, - "params": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm_as_judge", - "default": "llm_as_judge" - }, - "judge_model": { - "type": "string" - }, - "prompt_template": { - "type": "string" - }, - "judge_score_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type", - "judge_model" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "regex_parser", - "default": "regex_parser" - }, - "parsing_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "metadata", - "return_type" - ] + "$ref": "#/components/schemas/ScoringFn" }, { "type": "null" @@ -6030,56 +991,7 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "shield", - "default": "shield" - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type" - ], - "title": "A safety shield resource that can be used to check content" + "$ref": "#/components/schemas/Shield" }, { "type": "null" @@ -6448,11 +1360,7 @@ "schema": { "oneOf": [ { - "type": "string", - "enum": [ - "completed", - "in_progress" - ] + "$ref": "#/components/schemas/JobStatus" }, { "type": "null" @@ -6565,143 +1473,16 @@ "schema": { "oneOf": [ { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "vector", - "default": "vector" - }, - "embedding_model": { - "type": "string" - }, - "chunk_size_in_tokens": { - "type": "integer" - }, - "overlap_size_in_tokens": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type", - "embedding_model", - "chunk_size_in_tokens" - ] + "$ref": "#/components/schemas/VectorMemoryBank" }, { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "keyvalue", - "default": "keyvalue" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] + "$ref": "#/components/schemas/KeyValueMemoryBank" }, { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "keyword", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] + "$ref": "#/components/schemas/KeywordMemoryBank" }, { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "graph", - "default": "graph" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] + "$ref": "#/components/schemas/GraphMemoryBank" } ] } @@ -6765,20 +1546,7 @@ "schema": { "type": "object", "additionalProperties": { - "type": "object", - "properties": { - "provider_id": { - "type": "string" - }, - "provider_type": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "provider_id", - "provider_type" - ] + "$ref": "#/components/schemas/ProviderInfo" } } } @@ -6813,27 +1581,7 @@ "additionalProperties": { "type": "array", "items": { - "type": "object", - "properties": { - "route": { - "type": "string" - }, - "method": { - "type": "string" - }, - "provider_types": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "route", - "method", - "provider_types" - ] + "$ref": "#/components/schemas/RouteInfo" } } } @@ -7548,6 +2296,475 @@ "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "components": { "schemas": { + "BuiltinTool": { + "type": "string", + "enum": [ + "brave_search", + "wolfram_alpha", + "photogen", + "code_interpreter" + ] + }, + "CompletionMessage": { + "type": "object", + "properties": { + "role": { + "type": "string", + "const": "assistant", + "default": "assistant" + }, + "content": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + } + ] + }, + "stop_reason": { + "$ref": "#/components/schemas/StopReason" + }, + "tool_calls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ToolCall" + } + } + }, + "additionalProperties": false, + "required": [ + "role", + "content", + "stop_reason", + "tool_calls" + ] + }, + "ImageMedia": { + "type": "object", + "properties": { + "image": { + "oneOf": [ + { + "type": "object", + "properties": { + "format": { + "type": "string" + }, + "format_description": { + "type": "string" + } + }, + "additionalProperties": false, + "title": "This class represents an image object. To create" + }, + { + "$ref": "#/components/schemas/URL" + } + ] + } + }, + "additionalProperties": false, + "required": [ + "image" + ] + }, + "SamplingParams": { + "type": "object", + "properties": { + "strategy": { + "$ref": "#/components/schemas/SamplingStrategy", + "default": "greedy" + }, + "temperature": { + "type": "number", + "default": 0.0 + }, + "top_p": { + "type": "number", + "default": 0.95 + }, + "top_k": { + "type": "integer", + "default": 0 + }, + "max_tokens": { + "type": "integer", + "default": 0 + }, + "repetition_penalty": { + "type": "number", + "default": 1.0 + } + }, + "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", + "default": "system" + }, + "content": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + } + ] + } + }, + "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", + "default": true + }, + "default": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + }, + "additionalProperties": false, + "required": [ + "param_type" + ] + }, + "ToolPromptFormat": { + "type": "string", + "enum": [ + "json", + "function_tag", + "python_list" + ], + "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli" + }, + "ToolResponseMessage": { + "type": "object", + "properties": { + "role": { + "type": "string", + "const": "ipython", + "default": "ipython" + }, + "call_id": { + "type": "string" + }, + "tool_name": { + "oneOf": [ + { + "$ref": "#/components/schemas/BuiltinTool" + }, + { + "type": "string" + } + ] + }, + "content": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + } + ] + } + }, + "additionalProperties": false, + "required": [ + "role", + "call_id", + "tool_name", + "content" + ] + }, + "URL": { + "type": "string", + "format": "uri", + "pattern": "^(https?://|file://|data:)" + }, + "UserMessage": { + "type": "object", + "properties": { + "role": { + "type": "string", + "const": "user", + "default": "user" + }, + "content": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + } + ] + }, + "context": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + } + ] + } + }, + "additionalProperties": false, + "required": [ + "role", + "content" + ] + }, "BatchChatCompletionRequest": { "type": "object", "properties": { @@ -7561,793 +2778,35 @@ "items": { "oneOf": [ { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/UserMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "system", - "default": "system" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/SystemMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] + "$ref": "#/components/schemas/ToolResponseMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] + "$ref": "#/components/schemas/CompletionMessage" } ] } } }, "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] + "$ref": "#/components/schemas/SamplingParams" }, "tools": { "type": "array", "items": { - "type": "object", - "properties": { - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "description": { - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "param_type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": true - }, - "default": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "additionalProperties": false, - "required": [ - "param_type" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "tool_name" - ] + "$ref": "#/components/schemas/ToolDefinition" } }, "tool_choice": { - "type": "string", - "enum": [ - "auto", - "required" - ] + "$ref": "#/components/schemas/ToolChoice" }, "tool_prompt_format": { - "type": "string", - "enum": [ - "json", - "function_tag", - "python_list" - ], - "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli" + "$ref": "#/components/schemas/ToolPromptFormat" }, "logprobs": { "type": "object", @@ -8372,221 +2831,7 @@ "completion_message_batch": { "type": "array", "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] + "$ref": "#/components/schemas/CompletionMessage" } } }, @@ -8609,42 +2854,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" }, { "type": "array", @@ -8654,42 +2864,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" } ] } @@ -8698,42 +2873,7 @@ } }, "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] + "$ref": "#/components/schemas/SamplingParams" }, "logprobs": { "type": "object", @@ -8758,221 +2898,7 @@ "completion_message_batch": { "type": "array", "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] + "$ref": "#/components/schemas/CompletionMessage" } } }, @@ -9004,792 +2930,34 @@ "items": { "oneOf": [ { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/UserMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "system", - "default": "system" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/SystemMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] + "$ref": "#/components/schemas/ToolResponseMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] + "$ref": "#/components/schemas/CompletionMessage" } ] } }, "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] + "$ref": "#/components/schemas/SamplingParams" }, "tools": { "type": "array", "items": { - "type": "object", - "properties": { - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "description": { - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "param_type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": true - }, - "default": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "additionalProperties": false, - "required": [ - "param_type" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "tool_name" - ] + "$ref": "#/components/schemas/ToolDefinition" } }, "tool_choice": { - "type": "string", - "enum": [ - "auto", - "required" - ] + "$ref": "#/components/schemas/ToolChoice" }, "tool_prompt_format": { - "type": "string", - "enum": [ - "json", - "function_tag", - "python_list" - ], - "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli" + "$ref": "#/components/schemas/ToolPromptFormat" }, "response_format": { "oneOf": [ @@ -9895,6 +3063,126 @@ "messages" ] }, + "ChatCompletionResponse": { + "type": "object", + "properties": { + "completion_message": { + "$ref": "#/components/schemas/CompletionMessage" + }, + "logprobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenLogProbs" + } + } + }, + "additionalProperties": false, + "required": [ + "completion_message" + ], + "title": "Chat completion response." + }, + "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": { @@ -9907,42 +3195,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" }, { "type": "array", @@ -9952,42 +3205,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" } ] } @@ -9995,42 +3213,7 @@ ] }, "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] + "$ref": "#/components/schemas/SamplingParams" }, "response_format": { "oneOf": [ @@ -10136,1034 +3319,601 @@ "content" ] }, - "CreateAgentRequest": { + "CompletionResponse": { "type": "object", "properties": { - "agent_config": { + "content": { + "type": "string" + }, + "stop_reason": { + "$ref": "#/components/schemas/StopReason" + }, + "logprobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenLogProbs" + } + } + }, + "additionalProperties": false, + "required": [ + "content", + "stop_reason" + ], + "title": "Completion response." + }, + "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": { + "type": "string" + } + }, + "output_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "tools": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/SearchToolDefinition" + }, + { + "$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", + "default": "auto" + }, + "tool_prompt_format": { + "$ref": "#/components/schemas/ToolPromptFormat", + "default": "json" + }, + "max_infer_iters": { + "type": "integer", + "default": 10 + }, + "model": { + "type": "string" + }, + "instructions": { + "type": "string" + }, + "enable_session_persistence": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "max_infer_iters", + "model", + "instructions", + "enable_session_persistence" + ] + }, + "CodeInterpreterToolDefinition": { + "type": "object", + "properties": { + "input_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "output_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "const": "code_interpreter", + "default": "code_interpreter" + }, + "enable_inline_code_execution": { + "type": "boolean", + "default": true + }, + "remote_execution": { + "$ref": "#/components/schemas/RestAPIExecutionConfig" + } + }, + "additionalProperties": false, + "required": [ + "type", + "enable_inline_code_execution" + ] + }, + "FunctionCallToolDefinition": { + "type": "object", + "properties": { + "input_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "output_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "const": "function_call", + "default": "function_call" + }, + "function_name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "parameters": { "type": "object", - "properties": { - "sampling_params": { + "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": { + "type": "string" + } + }, + "output_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "const": "memory", + "default": "memory" + }, + "memory_bank_configs": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "bank_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "vector", + "default": "vector" + } + }, + "additionalProperties": false, + "required": [ + "bank_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "bank_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "keyvalue", + "default": "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", + "default": "keyword" + } + }, + "additionalProperties": false, + "required": [ + "bank_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "bank_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "graph", + "default": "graph" + }, + "entities": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false, + "required": [ + "bank_id", + "type", + "entities" + ] + } + ] + } + }, + "query_generator_config": { + "oneOf": [ + { "type": "object", "properties": { - "strategy": { + "type": { "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" + "const": "default", + "default": "default" }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 + "sep": { + "type": "string", + "default": " " } }, "additionalProperties": false, "required": [ - "strategy" + "type", + "sep" ] }, - "input_shields": { - "type": "array", - "items": { - "type": "string" - } + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "llm", + "default": "llm" + }, + "model": { + "type": "string" + }, + "template": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "type", + "model", + "template" + ] }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "tools": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "brave_search", - "default": "brave_search" - }, - "api_key": { - "type": "string" - }, - "engine": { - "type": "string", - "enum": [ - "bing", - "brave" - ], - "default": "brave" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key", - "engine" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "wolfram_alpha", - "default": "wolfram_alpha" - }, - "api_key": { - "type": "string" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "photogen", - "default": "photogen" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "code_interpreter", - "default": "code_interpreter" - }, - "enable_inline_code_execution": { - "type": "boolean", - "default": true - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "enable_inline_code_execution" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "function_call", - "default": "function_call" - }, - "function_name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "param_type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": true - }, - "default": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "additionalProperties": false, - "required": [ - "param_type" - ] - } - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "function_name", - "description", - "parameters" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "memory", - "default": "memory" - }, - "memory_bank_configs": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "vector", - "default": "vector" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "keyvalue", - "default": "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", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "graph", - "default": "graph" - }, - "entities": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type", - "entities" - ] - } - ] - } - }, - "query_generator_config": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "default", - "default": "default" - }, - "sep": { - "type": "string", - "default": " " - } - }, - "additionalProperties": false, - "required": [ - "type", - "sep" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm", - "default": "llm" - }, - "model": { - "type": "string" - }, - "template": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "template" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "custom", - "default": "custom" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - }, - "max_tokens_in_context": { - "type": "integer", - "default": 4096 - }, - "max_chunks": { - "type": "integer", - "default": 10 - } - }, - "additionalProperties": false, - "required": [ - "type", - "memory_bank_configs", - "query_generator_config", - "max_tokens_in_context", - "max_chunks" - ] - } - ] - } - }, - "tool_choice": { - "type": "string", - "enum": [ - "auto", - "required" - ], - "default": "auto" - }, - "tool_prompt_format": { - "type": "string", - "enum": [ - "json", - "function_tag", - "python_list" - ], - "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli", - "default": "json" - }, - "max_infer_iters": { - "type": "integer", - "default": 10 - }, - "model": { - "type": "string" - }, - "instructions": { - "type": "string" - }, - "enable_session_persistence": { - "type": "boolean" + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "custom", + "default": "custom" + } + }, + "additionalProperties": false, + "required": [ + "type" + ] } - }, - "additionalProperties": false, - "required": [ - "max_infer_iters", - "model", - "instructions", - "enable_session_persistence" ] + }, + "max_tokens_in_context": { + "type": "integer", + "default": 4096 + }, + "max_chunks": { + "type": "integer", + "default": 10 + } + }, + "additionalProperties": false, + "required": [ + "type", + "memory_bank_configs", + "query_generator_config", + "max_tokens_in_context", + "max_chunks" + ] + }, + "PhotogenToolDefinition": { + "type": "object", + "properties": { + "input_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "output_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "const": "photogen", + "default": "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": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + }, + "headers": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + }, + "body": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "url", + "method" + ] + }, + "RestAPIMethod": { + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE" + ] + }, + "SearchToolDefinition": { + "type": "object", + "properties": { + "input_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "output_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "const": "brave_search", + "default": "brave_search" + }, + "api_key": { + "type": "string" + }, + "engine": { + "type": "string", + "enum": [ + "bing", + "brave" + ], + "default": "brave" + }, + "remote_execution": { + "$ref": "#/components/schemas/RestAPIExecutionConfig" + } + }, + "additionalProperties": false, + "required": [ + "type", + "api_key", + "engine" + ] + }, + "WolframAlphaToolDefinition": { + "type": "object", + "properties": { + "input_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "output_shields": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "const": "wolfram_alpha", + "default": "wolfram_alpha" + }, + "api_key": { + "type": "string" + }, + "remote_execution": { + "$ref": "#/components/schemas/RestAPIExecutionConfig" + } + }, + "additionalProperties": false, + "required": [ + "type", + "api_key" + ] + }, + "CreateAgentRequest": { + "type": "object", + "properties": { + "agent_config": { + "$ref": "#/components/schemas/AgentConfig" } }, "additionalProperties": false, @@ -11211,6 +3961,45 @@ "session_id" ] }, + "Attachment": { + "type": "object", + "properties": { + "content": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + }, + { + "$ref": "#/components/schemas/URL" + } + ] + }, + "mime_type": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "content", + "mime_type" + ] + }, "CreateAgentTurnRequest": { "type": "object", "properties": { @@ -11225,334 +4014,10 @@ "items": { "oneOf": [ { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/UserMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] + "$ref": "#/components/schemas/ToolResponseMessage" } ] } @@ -11560,122 +4025,7 @@ "attachments": { "type": "array", "items": { - "type": "object", - "properties": { - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - }, - "mime_type": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "content", - "mime_type" - ] + "$ref": "#/components/schemas/Attachment" } }, "stream": { @@ -11689,6 +4039,554 @@ "messages" ] }, + "AgentTurnResponseEvent": { + "type": "object", + "properties": { + "payload": { + "oneOf": [ + { + "$ref": "#/components/schemas/AgentTurnResponseStepStartPayload" + }, + { + "$ref": "#/components/schemas/AgentTurnResponseStepProgressPayload" + }, + { + "$ref": "#/components/schemas/AgentTurnResponseStepCompletePayload" + }, + { + "$ref": "#/components/schemas/AgentTurnResponseTurnStartPayload" + }, + { + "$ref": "#/components/schemas/AgentTurnResponseTurnCompletePayload" + } + ] + } + }, + "additionalProperties": false, + "required": [ + "payload" + ], + "title": "Streamed agent execution response." + }, + "AgentTurnResponseStepCompletePayload": { + "type": "object", + "properties": { + "event_type": { + "type": "string", + "const": "step_complete", + "default": "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" + ] + }, + "AgentTurnResponseStepProgressPayload": { + "type": "object", + "properties": { + "event_type": { + "type": "string", + "const": "step_progress", + "default": "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" + ] + }, + "AgentTurnResponseStepStartPayload": { + "type": "object", + "properties": { + "event_type": { + "type": "string", + "const": "step_start", + "default": "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" + ] + }, + "AgentTurnResponseStreamChunk": { + "type": "object", + "properties": { + "event": { + "$ref": "#/components/schemas/AgentTurnResponseEvent" + } + }, + "additionalProperties": false, + "required": [ + "event" + ], + "title": "streamed agent turn completion response." + }, + "AgentTurnResponseTurnCompletePayload": { + "type": "object", + "properties": { + "event_type": { + "type": "string", + "const": "turn_complete", + "default": "turn_complete" + }, + "turn": { + "$ref": "#/components/schemas/Turn" + } + }, + "additionalProperties": false, + "required": [ + "event_type", + "turn" + ] + }, + "AgentTurnResponseTurnStartPayload": { + "type": "object", + "properties": { + "event_type": { + "type": "string", + "const": "turn_start", + "default": "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", + "default": "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", + "default": "memory_retrieval" + }, + "memory_bank_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "inserted_context": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + } + ] + } + }, + "additionalProperties": false, + "required": [ + "turn_id", + "step_id", + "step_type", + "memory_bank_ids", + "inserted_context" + ] + }, + "SafetyViolation": { + "type": "object", + "properties": { + "violation_level": { + "$ref": "#/components/schemas/ViolationLevel" + }, + "user_message": { + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "violation_level", + "metadata" + ] + }, + "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", + "default": "shield_call" + }, + "violation": { + "$ref": "#/components/schemas/SafetyViolation" + } + }, + "additionalProperties": false, + "required": [ + "turn_id", + "step_id", + "step_type" + ] + }, + "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", + "default": "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" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + } + ] + } + }, + "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." + }, + "ViolationLevel": { + "type": "string", + "enum": [ + "info", + "warn", + "error" + ] + }, "DeleteAgentsRequest": { "type": "object", "properties": { @@ -11731,42 +4629,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" }, { "type": "array", @@ -11776,42 +4639,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" } ] } @@ -11844,6 +4672,166 @@ "embeddings" ] }, + "AgentCandidate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "agent", + "default": "agent" + }, + "config": { + "$ref": "#/components/schemas/AgentConfig" + } + }, + "additionalProperties": false, + "required": [ + "type", + "config" + ] + }, + "AppEvalTaskConfig": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "app", + "default": "app" + }, + "eval_candidate": { + "oneOf": [ + { + "$ref": "#/components/schemas/ModelCandidate" + }, + { + "$ref": "#/components/schemas/AgentCandidate" + } + ] + }, + "scoring_params": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/LLMAsJudgeScoringFnParams" + }, + { + "$ref": "#/components/schemas/RegexParserScoringFnParams" + } + ] + } + }, + "num_examples": { + "type": "integer" + } + }, + "additionalProperties": false, + "required": [ + "type", + "eval_candidate", + "scoring_params" + ] + }, + "BenchmarkEvalTaskConfig": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "benchmark", + "default": "benchmark" + }, + "eval_candidate": { + "oneOf": [ + { + "$ref": "#/components/schemas/ModelCandidate" + }, + { + "$ref": "#/components/schemas/AgentCandidate" + } + ] + }, + "num_examples": { + "type": "integer" + } + }, + "additionalProperties": false, + "required": [ + "type", + "eval_candidate" + ] + }, + "LLMAsJudgeScoringFnParams": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "llm_as_judge", + "default": "llm_as_judge" + }, + "judge_model": { + "type": "string" + }, + "prompt_template": { + "type": "string" + }, + "judge_score_regexes": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false, + "required": [ + "type", + "judge_model" + ] + }, + "ModelCandidate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "model", + "default": "model" + }, + "model": { + "type": "string" + }, + "sampling_params": { + "$ref": "#/components/schemas/SamplingParams" + }, + "system_message": { + "$ref": "#/components/schemas/SystemMessage" + } + }, + "additionalProperties": false, + "required": [ + "type", + "model", + "sampling_params" + ] + }, + "RegexParserScoringFnParams": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "regex_parser", + "default": "regex_parser" + }, + "parsing_regexes": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + }, "EvaluateRowsRequest": { "type": "object", "properties": { @@ -11887,2515 +4875,10 @@ "task_config": { "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "benchmark", - "default": "benchmark" - }, - "eval_candidate": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "model", - "default": "model" - }, - "model": { - "type": "string" - }, - "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] - }, - "system_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "system", - "default": "system" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "sampling_params" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "agent", - "default": "agent" - }, - "config": { - "type": "object", - "properties": { - "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] - }, - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "tools": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "brave_search", - "default": "brave_search" - }, - "api_key": { - "type": "string" - }, - "engine": { - "type": "string", - "enum": [ - "bing", - "brave" - ], - "default": "brave" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key", - "engine" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "wolfram_alpha", - "default": "wolfram_alpha" - }, - "api_key": { - "type": "string" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "photogen", - "default": "photogen" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "code_interpreter", - "default": "code_interpreter" - }, - "enable_inline_code_execution": { - "type": "boolean", - "default": true - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "enable_inline_code_execution" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "function_call", - "default": "function_call" - }, - "function_name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "param_type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": true - }, - "default": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "additionalProperties": false, - "required": [ - "param_type" - ] - } - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "function_name", - "description", - "parameters" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "memory", - "default": "memory" - }, - "memory_bank_configs": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "vector", - "default": "vector" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "keyvalue", - "default": "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", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "graph", - "default": "graph" - }, - "entities": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type", - "entities" - ] - } - ] - } - }, - "query_generator_config": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "default", - "default": "default" - }, - "sep": { - "type": "string", - "default": " " - } - }, - "additionalProperties": false, - "required": [ - "type", - "sep" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm", - "default": "llm" - }, - "model": { - "type": "string" - }, - "template": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "template" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "custom", - "default": "custom" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - }, - "max_tokens_in_context": { - "type": "integer", - "default": 4096 - }, - "max_chunks": { - "type": "integer", - "default": 10 - } - }, - "additionalProperties": false, - "required": [ - "type", - "memory_bank_configs", - "query_generator_config", - "max_tokens_in_context", - "max_chunks" - ] - } - ] - } - }, - "tool_choice": { - "type": "string", - "enum": [ - "auto", - "required" - ], - "default": "auto" - }, - "tool_prompt_format": { - "type": "string", - "enum": [ - "json", - "function_tag", - "python_list" - ], - "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli", - "default": "json" - }, - "max_infer_iters": { - "type": "integer", - "default": 10 - }, - "model": { - "type": "string" - }, - "instructions": { - "type": "string" - }, - "enable_session_persistence": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "max_infer_iters", - "model", - "instructions", - "enable_session_persistence" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "config" - ] - } - ] - }, - "num_examples": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "type", - "eval_candidate" - ] + "$ref": "#/components/schemas/BenchmarkEvalTaskConfig" }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "app", - "default": "app" - }, - "eval_candidate": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "model", - "default": "model" - }, - "model": { - "type": "string" - }, - "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] - }, - "system_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "system", - "default": "system" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "sampling_params" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "agent", - "default": "agent" - }, - "config": { - "type": "object", - "properties": { - "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] - }, - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "tools": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "brave_search", - "default": "brave_search" - }, - "api_key": { - "type": "string" - }, - "engine": { - "type": "string", - "enum": [ - "bing", - "brave" - ], - "default": "brave" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key", - "engine" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "wolfram_alpha", - "default": "wolfram_alpha" - }, - "api_key": { - "type": "string" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "photogen", - "default": "photogen" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "code_interpreter", - "default": "code_interpreter" - }, - "enable_inline_code_execution": { - "type": "boolean", - "default": true - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "enable_inline_code_execution" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "function_call", - "default": "function_call" - }, - "function_name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "param_type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": true - }, - "default": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "additionalProperties": false, - "required": [ - "param_type" - ] - } - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "function_name", - "description", - "parameters" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "memory", - "default": "memory" - }, - "memory_bank_configs": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "vector", - "default": "vector" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "keyvalue", - "default": "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", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "graph", - "default": "graph" - }, - "entities": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type", - "entities" - ] - } - ] - } - }, - "query_generator_config": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "default", - "default": "default" - }, - "sep": { - "type": "string", - "default": " " - } - }, - "additionalProperties": false, - "required": [ - "type", - "sep" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm", - "default": "llm" - }, - "model": { - "type": "string" - }, - "template": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "template" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "custom", - "default": "custom" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - }, - "max_tokens_in_context": { - "type": "integer", - "default": 4096 - }, - "max_chunks": { - "type": "integer", - "default": 10 - } - }, - "additionalProperties": false, - "required": [ - "type", - "memory_bank_configs", - "query_generator_config", - "max_tokens_in_context", - "max_chunks" - ] - } - ] - } - }, - "tool_choice": { - "type": "string", - "enum": [ - "auto", - "required" - ], - "default": "auto" - }, - "tool_prompt_format": { - "type": "string", - "enum": [ - "json", - "function_tag", - "python_list" - ], - "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli", - "default": "json" - }, - "max_infer_iters": { - "type": "integer", - "default": 10 - }, - "model": { - "type": "string" - }, - "instructions": { - "type": "string" - }, - "enable_session_persistence": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "max_infer_iters", - "model", - "instructions", - "enable_session_persistence" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "config" - ] - } - ] - }, - "scoring_params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm_as_judge", - "default": "llm_as_judge" - }, - "judge_model": { - "type": "string" - }, - "prompt_template": { - "type": "string" - }, - "judge_score_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type", - "judge_model" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "regex_parser", - "default": "regex_parser" - }, - "parsing_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - } - }, - "num_examples": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "type", - "eval_candidate", - "scoring_params" - ] + "$ref": "#/components/schemas/AppEvalTaskConfig" } ] } @@ -14442,67 +4925,7 @@ "scores": { "type": "object", "additionalProperties": { - "type": "object", - "properties": { - "score_rows": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "aggregated_results": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "score_rows", - "aggregated_results" - ] + "$ref": "#/components/schemas/ScoringResult" } } }, @@ -14512,3764 +4935,10 @@ "scores" ] }, - "GetAgentsSessionRequest": { + "ScoringResult": { "type": "object", "properties": { - "turn_ids": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - }, - "Session": { - "type": "object", - "properties": { - "session_id": { - "type": "string" - }, - "session_name": { - "type": "string" - }, - "turns": { - "type": "array", - "items": { - "type": "object", - "properties": { - "turn_id": { - "type": "string" - }, - "session_id": { - "type": "string" - }, - "input_messages": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] - }, - { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] - } - ] - } - }, - "steps": { - "type": "array", - "items": { - "oneOf": [ - { - "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", - "default": "inference" - }, - "model_response": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "model_response" - ] - }, - { - "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", - "default": "tool_execution" - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - }, - "tool_responses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "call_id", - "tool_name", - "content" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "tool_calls", - "tool_responses" - ] - }, - { - "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", - "default": "shield_call" - }, - "violation": { - "type": "object", - "properties": { - "violation_level": { - "type": "string", - "enum": [ - "info", - "warn", - "error" - ] - }, - "user_message": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "violation_level", - "metadata" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type" - ] - }, - { - "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", - "default": "memory_retrieval" - }, - "memory_bank_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "inserted_context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "memory_bank_ids", - "inserted_context" - ] - } - ] - } - }, - "output_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - }, - "output_attachments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - }, - "mime_type": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "content", - "mime_type" - ] - } - }, - "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." - } - }, - "started_at": { - "type": "string", - "format": "date-time" - }, - "memory_bank": { - "oneOf": [ - { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "vector", - "default": "vector" - }, - "embedding_model": { - "type": "string" - }, - "chunk_size_in_tokens": { - "type": "integer" - }, - "overlap_size_in_tokens": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type", - "embedding_model", - "chunk_size_in_tokens" - ] - }, - { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "keyvalue", - "default": "keyvalue" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] - }, - { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "keyword", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] - }, - { - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "provider_resource_id": { - "type": "string" - }, - "provider_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "memory_bank", - "default": "memory_bank" - }, - "memory_bank_type": { - "type": "string", - "const": "graph", - "default": "graph" - } - }, - "additionalProperties": false, - "required": [ - "identifier", - "provider_resource_id", - "provider_id", - "type", - "memory_bank_type" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "session_id", - "session_name", - "turns", - "started_at" - ], - "title": "A single session of an interaction with an Agentic System." - }, - "AgentStepResponse": { - "type": "object", - "properties": { - "step": { - "oneOf": [ - { - "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", - "default": "inference" - }, - "model_response": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "model_response" - ] - }, - { - "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", - "default": "tool_execution" - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - }, - "tool_responses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "call_id", - "tool_name", - "content" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "tool_calls", - "tool_responses" - ] - }, - { - "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", - "default": "shield_call" - }, - "violation": { - "type": "object", - "properties": { - "violation_level": { - "type": "string", - "enum": [ - "info", - "warn", - "error" - ] - }, - "user_message": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "violation_level", - "metadata" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type" - ] - }, - { - "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", - "default": "memory_retrieval" - }, - "memory_bank_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "inserted_context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "memory_bank_ids", - "inserted_context" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "step" - ] - }, - "Turn": { - "type": "object", - "properties": { - "turn_id": { - "type": "string" - }, - "session_id": { - "type": "string" - }, - "input_messages": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] - }, - { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] - } - ] - } - }, - "steps": { - "type": "array", - "items": { - "oneOf": [ - { - "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", - "default": "inference" - }, - "model_response": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "model_response" - ] - }, - { - "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", - "default": "tool_execution" - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - }, - "tool_responses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "call_id", - "tool_name", - "content" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "tool_calls", - "tool_responses" - ] - }, - { - "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", - "default": "shield_call" - }, - "violation": { - "type": "object", - "properties": { - "violation_level": { - "type": "string", - "enum": [ - "info", - "warn", - "error" - ] - }, - "user_message": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "violation_level", - "metadata" - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type" - ] - }, - { - "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", - "default": "memory_retrieval" - }, - "memory_bank_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "inserted_context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "turn_id", - "step_id", - "step_type", - "memory_bank_ids", - "inserted_context" - ] - } - ] - } - }, - "output_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] - }, - "output_attachments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - }, - "mime_type": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "content", - "mime_type" - ] - } - }, - "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." - }, - "PaginatedRowsResult": { - "type": "object", - "properties": { - "rows": { + "score_rows": { "type": "array", "items": { "type": "object", @@ -18297,138 +4966,7 @@ } } }, - "total_count": { - "type": "integer" - }, - "next_page_token": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "rows", - "total_count" - ] - }, - "Trace": { - "type": "object", - "properties": { - "trace_id": { - "type": "string" - }, - "root_span_id": { - "type": "string" - }, - "start_time": { - "type": "string", - "format": "date-time" - }, - "end_time": { - "type": "string", - "format": "date-time" - } - }, - "additionalProperties": false, - "required": [ - "trace_id", - "root_span_id", - "start_time" - ] - }, - "PostTrainingJobArtifactsResponse": { - "type": "object", - "properties": { - "job_uuid": { - "type": "string" - }, - "checkpoints": { - "type": "array", - "items": { - "type": "object", - "properties": { - "iters": { - "type": "integer" - }, - "path": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "epoch": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "iters", - "path", - "epoch" - ] - } - } - }, - "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." - }, - "PostTrainingJobStatusResponse": { - "type": "object", - "properties": { - "job_uuid": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "running", - "completed", - "failed", - "scheduled" - ] - }, - "scheduled_at": { - "type": "string", - "format": "date-time" - }, - "started_at": { - "type": "string", - "format": "date-time" - }, - "completed_at": { - "type": "string", - "format": "date-time" - }, - "resources_allocated": { + "aggregated_results": { "type": "object", "additionalProperties": { "oneOf": [ @@ -18452,252 +4990,233 @@ } ] } - }, - "checkpoints": { - "type": "array", - "items": { - "type": "object", - "properties": { - "iters": { - "type": "integer" - }, - "path": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "epoch": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "iters", - "path", - "epoch" - ] - } } }, "additionalProperties": false, "required": [ - "job_uuid", - "status", - "checkpoints" + "score_rows", + "aggregated_results" + ] + }, + "GetAgentsSessionRequest": { + "type": "object", + "properties": { + "turn_ids": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "GraphMemoryBank": { + "type": "object", + "properties": { + "identifier": { + "type": "string" + }, + "provider_resource_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "memory_bank", + "default": "memory_bank" + }, + "memory_bank_type": { + "type": "string", + "const": "graph", + "default": "graph" + } + }, + "additionalProperties": false, + "required": [ + "identifier", + "provider_resource_id", + "provider_id", + "type", + "memory_bank_type" + ] + }, + "KeyValueMemoryBank": { + "type": "object", + "properties": { + "identifier": { + "type": "string" + }, + "provider_resource_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "memory_bank", + "default": "memory_bank" + }, + "memory_bank_type": { + "type": "string", + "const": "keyvalue", + "default": "keyvalue" + } + }, + "additionalProperties": false, + "required": [ + "identifier", + "provider_resource_id", + "provider_id", + "type", + "memory_bank_type" + ] + }, + "KeywordMemoryBank": { + "type": "object", + "properties": { + "identifier": { + "type": "string" + }, + "provider_resource_id": { + "type": "string" + }, + "provider_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "memory_bank", + "default": "memory_bank" + }, + "memory_bank_type": { + "type": "string", + "const": "keyword", + "default": "keyword" + } + }, + "additionalProperties": false, + "required": [ + "identifier", + "provider_resource_id", + "provider_id", + "type", + "memory_bank_type" + ] + }, + "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": { + "oneOf": [ + { + "$ref": "#/components/schemas/VectorMemoryBank" + }, + { + "$ref": "#/components/schemas/KeyValueMemoryBank" + }, + { + "$ref": "#/components/schemas/KeywordMemoryBank" + }, + { + "$ref": "#/components/schemas/GraphMemoryBank" + } + ] + } + }, + "additionalProperties": false, + "required": [ + "session_id", + "session_name", + "turns", + "started_at" ], - "title": "Status of a finetuning job." + "title": "A single session of an interaction with an Agentic System." }, - "PostTrainingJob": { + "VectorMemoryBank": { "type": "object", "properties": { - "job_uuid": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "job_uuid" - ] - }, - "HealthInfo": { - "type": "object", - "properties": { - "status": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "status" - ] - }, - "InsertDocumentsRequest": { - "type": "object", - "properties": { - "bank_id": { + "identifier": { "type": "string" }, - "documents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "document_id": { - "type": "string" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - }, - "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", - "metadata" - ] - } + "provider_resource_id": { + "type": "string" }, - "ttl_seconds": { + "provider_id": { + "type": "string" + }, + "type": { + "type": "string", + "const": "memory_bank", + "default": "memory_bank" + }, + "memory_bank_type": { + "type": "string", + "const": "vector", + "default": "vector" + }, + "embedding_model": { + "type": "string" + }, + "chunk_size_in_tokens": { + "type": "integer" + }, + "overlap_size_in_tokens": { "type": "integer" } }, "additionalProperties": false, "required": [ - "bank_id", - "documents" + "identifier", + "provider_resource_id", + "provider_id", + "type", + "memory_bank_type", + "embedding_model", + "chunk_size_in_tokens" ] }, - "JobCancelRequest": { + "AgentStepResponse": { "type": "object", "properties": { - "task_id": { - "type": "string" - }, - "job_id": { - "type": "string" + "step": { + "oneOf": [ + { + "$ref": "#/components/schemas/InferenceStep" + }, + { + "$ref": "#/components/schemas/ToolExecutionStep" + }, + { + "$ref": "#/components/schemas/ShieldCallStep" + }, + { + "$ref": "#/components/schemas/MemoryRetrievalStep" + } + ] } }, "additionalProperties": false, "required": [ - "task_id", - "job_id" + "step" ] }, "Dataset": { @@ -18865,16 +5384,7 @@ } }, "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] + "$ref": "#/components/schemas/URL" }, "metadata": { "type": "object", @@ -19028,6 +5538,50 @@ "metadata" ] }, + "PaginatedRowsResult": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + } + }, + "total_count": { + "type": "integer" + }, + "next_page_token": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "rows", + "total_count" + ] + }, "ScoringFn": { "type": "object", "properties": { @@ -19220,51 +5774,10 @@ "params": { "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm_as_judge", - "default": "llm_as_judge" - }, - "judge_model": { - "type": "string" - }, - "prompt_template": { - "type": "string" - }, - "judge_score_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type", - "judge_model" - ] + "$ref": "#/components/schemas/LLMAsJudgeScoringFnParams" }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "regex_parser", - "default": "regex_parser" - }, - "parsing_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type" - ] + "$ref": "#/components/schemas/RegexParserScoringFnParams" } ] } @@ -19331,249 +5844,584 @@ ], "title": "A safety shield resource that can be used to check content" }, + "Trace": { + "type": "object", + "properties": { + "trace_id": { + "type": "string" + }, + "root_span_id": { + "type": "string" + }, + "start_time": { + "type": "string", + "format": "date-time" + }, + "end_time": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "required": [ + "trace_id", + "root_span_id", + "start_time" + ] + }, + "Checkpoint": { + "description": "Checkpoint created during training runs" + }, + "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" + ] + }, + "HealthInfo": { + "type": "object", + "properties": { + "status": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "status" + ] + }, + "MemoryBankDocument": { + "type": "object", + "properties": { + "document_id": { + "type": "string" + }, + "content": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + }, + { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ImageMedia" + } + ] + } + }, + { + "$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", + "metadata" + ] + }, + "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" + ] + }, + "JobCancelRequest": { + "type": "object", + "properties": { + "task_id": { + "type": "string" + }, + "job_id": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "task_id", + "job_id" + ] + }, + "JobStatus": { + "type": "string", + "enum": [ + "completed", + "in_progress" + ] + }, + "ProviderInfo": { + "type": "object", + "properties": { + "provider_id": { + "type": "string" + }, + "provider_type": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "provider_id", + "provider_type" + ] + }, + "RouteInfo": { + "type": "object", + "properties": { + "route": { + "type": "string" + }, + "method": { + "type": "string" + }, + "provider_types": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false, + "required": [ + "route", + "method", + "provider_types" + ] + }, + "LogSeverity": { + "type": "string", + "enum": [ + "verbose", + "debug", + "info", + "warn", + "error", + "critical" + ] + }, + "MetricEvent": { + "type": "object", + "properties": { + "trace_id": { + "type": "string" + }, + "span_id": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "attributes": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + }, + "type": { + "type": "string", + "const": "metric", + "default": "metric" + }, + "metric": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "number" + } + ] + }, + "unit": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "trace_id", + "span_id", + "timestamp", + "type", + "metric", + "value", + "unit" + ] + }, + "SpanEndPayload": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "span_end", + "default": "span_end" + }, + "status": { + "$ref": "#/components/schemas/SpanStatus" + } + }, + "additionalProperties": false, + "required": [ + "type", + "status" + ] + }, + "SpanStartPayload": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "span_start", + "default": "span_start" + }, + "name": { + "type": "string" + }, + "parent_span_id": { + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "type", + "name" + ] + }, + "SpanStatus": { + "type": "string", + "enum": [ + "ok", + "error" + ] + }, + "StructuredLogEvent": { + "type": "object", + "properties": { + "trace_id": { + "type": "string" + }, + "span_id": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "attributes": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + }, + "type": { + "type": "string", + "const": "structured_log", + "default": "structured_log" + }, + "payload": { + "oneOf": [ + { + "$ref": "#/components/schemas/SpanStartPayload" + }, + { + "$ref": "#/components/schemas/SpanEndPayload" + } + ] + } + }, + "additionalProperties": false, + "required": [ + "trace_id", + "span_id", + "timestamp", + "type", + "payload" + ] + }, + "UnstructuredLogEvent": { + "type": "object", + "properties": { + "trace_id": { + "type": "string" + }, + "span_id": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "attributes": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "array" + }, + { + "type": "object" + } + ] + } + }, + "type": { + "type": "string", + "const": "unstructured_log", + "default": "unstructured_log" + }, + "message": { + "type": "string" + }, + "severity": { + "$ref": "#/components/schemas/LogSeverity" + } + }, + "additionalProperties": false, + "required": [ + "trace_id", + "span_id", + "timestamp", + "type", + "message", + "severity" + ] + }, "LogEventRequest": { "type": "object", "properties": { "event": { "oneOf": [ { - "type": "object", - "properties": { - "trace_id": { - "type": "string" - }, - "span_id": { - "type": "string" - }, - "timestamp": { - "type": "string", - "format": "date-time" - }, - "attributes": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "type": { - "type": "string", - "const": "unstructured_log", - "default": "unstructured_log" - }, - "message": { - "type": "string" - }, - "severity": { - "type": "string", - "enum": [ - "verbose", - "debug", - "info", - "warn", - "error", - "critical" - ] - } - }, - "additionalProperties": false, - "required": [ - "trace_id", - "span_id", - "timestamp", - "type", - "message", - "severity" - ] + "$ref": "#/components/schemas/UnstructuredLogEvent" }, { - "type": "object", - "properties": { - "trace_id": { - "type": "string" - }, - "span_id": { - "type": "string" - }, - "timestamp": { - "type": "string", - "format": "date-time" - }, - "attributes": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "type": { - "type": "string", - "const": "metric", - "default": "metric" - }, - "metric": { - "type": "string" - }, - "value": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "number" - } - ] - }, - "unit": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "trace_id", - "span_id", - "timestamp", - "type", - "metric", - "value", - "unit" - ] + "$ref": "#/components/schemas/MetricEvent" }, { - "type": "object", - "properties": { - "trace_id": { - "type": "string" - }, - "span_id": { - "type": "string" - }, - "timestamp": { - "type": "string", - "format": "date-time" - }, - "attributes": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "type": { - "type": "string", - "const": "structured_log", - "default": "structured_log" - }, - "payload": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "span_start", - "default": "span_start" - }, - "name": { - "type": "string" - }, - "parent_span_id": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "type", - "name" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "span_end", - "default": "span_end" - }, - "status": { - "type": "string", - "enum": [ - "ok", - "error" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "status" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "trace_id", - "span_id", - "timestamp", - "type", - "payload" - ] + "$ref": "#/components/schemas/StructuredLogEvent" } ] } @@ -19583,6 +6431,101 @@ "event" ] }, + "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" + ] + }, + "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" + ] + }, "PreferenceOptimizeRequest": { "type": "object", "properties": { @@ -19590,16 +6533,7 @@ "type": "string" }, "finetuned_model": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] + "$ref": "#/components/schemas/URL" }, "dataset_id": { "type": "string" @@ -19608,99 +6542,16 @@ "type": "string" }, "algorithm": { - "type": "string", - "enum": [ - "dpo" - ] + "$ref": "#/components/schemas/RLHFAlgorithm" }, "algorithm_config": { - "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" - ] + "$ref": "#/components/schemas/DPOAlignmentConfig" }, "optimizer_config": { - "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" - ] + "$ref": "#/components/schemas/OptimizerConfig" }, "training_config": { - "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" - ] + "$ref": "#/components/schemas/TrainingConfig" }, "hyperparam_search_config": { "type": "object", @@ -19779,42 +6630,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" }, { "type": "array", @@ -19824,42 +6640,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" } ] } @@ -19912,42 +6693,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" }, { "type": "array", @@ -19957,42 +6703,7 @@ "type": "string" }, { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] + "$ref": "#/components/schemas/ImageMedia" } ] } @@ -20181,16 +6892,7 @@ } }, "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] + "$ref": "#/components/schemas/URL" }, "provider_dataset_id": { "type": "string" @@ -20285,6 +6987,73 @@ "scoring_functions" ] }, + "GraphMemoryBankParams": { + "type": "object", + "properties": { + "memory_bank_type": { + "type": "string", + "const": "graph", + "default": "graph" + } + }, + "additionalProperties": false, + "required": [ + "memory_bank_type" + ] + }, + "KeyValueMemoryBankParams": { + "type": "object", + "properties": { + "memory_bank_type": { + "type": "string", + "const": "keyvalue", + "default": "keyvalue" + } + }, + "additionalProperties": false, + "required": [ + "memory_bank_type" + ] + }, + "KeywordMemoryBankParams": { + "type": "object", + "properties": { + "memory_bank_type": { + "type": "string", + "const": "keyword", + "default": "keyword" + } + }, + "additionalProperties": false, + "required": [ + "memory_bank_type" + ] + }, + "VectorMemoryBankParams": { + "type": "object", + "properties": { + "memory_bank_type": { + "type": "string", + "const": "vector", + "default": "vector" + }, + "embedding_model": { + "type": "string" + }, + "chunk_size_in_tokens": { + "type": "integer" + }, + "overlap_size_in_tokens": { + "type": "integer" + } + }, + "additionalProperties": false, + "required": [ + "memory_bank_type", + "embedding_model", + "chunk_size_in_tokens" + ] + }, "RegisterMemoryBankRequest": { "type": "object", "properties": { @@ -20294,71 +7063,16 @@ "params": { "oneOf": [ { - "type": "object", - "properties": { - "memory_bank_type": { - "type": "string", - "const": "vector", - "default": "vector" - }, - "embedding_model": { - "type": "string" - }, - "chunk_size_in_tokens": { - "type": "integer" - }, - "overlap_size_in_tokens": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "memory_bank_type", - "embedding_model", - "chunk_size_in_tokens" - ] + "$ref": "#/components/schemas/VectorMemoryBankParams" }, { - "type": "object", - "properties": { - "memory_bank_type": { - "type": "string", - "const": "keyvalue", - "default": "keyvalue" - } - }, - "additionalProperties": false, - "required": [ - "memory_bank_type" - ] + "$ref": "#/components/schemas/KeyValueMemoryBankParams" }, { - "type": "object", - "properties": { - "memory_bank_type": { - "type": "string", - "const": "keyword", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "memory_bank_type" - ] + "$ref": "#/components/schemas/KeywordMemoryBankParams" }, { - "type": "object", - "properties": { - "memory_bank_type": { - "type": "string", - "const": "graph", - "default": "graph" - } - }, - "additionalProperties": false, - "required": [ - "memory_bank_type" - ] + "$ref": "#/components/schemas/GraphMemoryBankParams" } ] }, @@ -20580,51 +7294,10 @@ "params": { "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm_as_judge", - "default": "llm_as_judge" - }, - "judge_model": { - "type": "string" - }, - "prompt_template": { - "type": "string" - }, - "judge_score_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type", - "judge_model" - ] + "$ref": "#/components/schemas/LLMAsJudgeScoringFnParams" }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "regex_parser", - "default": "regex_parser" - }, - "parsing_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type" - ] + "$ref": "#/components/schemas/RegexParserScoringFnParams" } ] } @@ -20688,2515 +7361,10 @@ "task_config": { "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "benchmark", - "default": "benchmark" - }, - "eval_candidate": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "model", - "default": "model" - }, - "model": { - "type": "string" - }, - "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] - }, - "system_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "system", - "default": "system" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "sampling_params" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "agent", - "default": "agent" - }, - "config": { - "type": "object", - "properties": { - "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] - }, - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "tools": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "brave_search", - "default": "brave_search" - }, - "api_key": { - "type": "string" - }, - "engine": { - "type": "string", - "enum": [ - "bing", - "brave" - ], - "default": "brave" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key", - "engine" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "wolfram_alpha", - "default": "wolfram_alpha" - }, - "api_key": { - "type": "string" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "photogen", - "default": "photogen" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "code_interpreter", - "default": "code_interpreter" - }, - "enable_inline_code_execution": { - "type": "boolean", - "default": true - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "enable_inline_code_execution" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "function_call", - "default": "function_call" - }, - "function_name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "param_type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": true - }, - "default": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "additionalProperties": false, - "required": [ - "param_type" - ] - } - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "function_name", - "description", - "parameters" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "memory", - "default": "memory" - }, - "memory_bank_configs": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "vector", - "default": "vector" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "keyvalue", - "default": "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", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "graph", - "default": "graph" - }, - "entities": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type", - "entities" - ] - } - ] - } - }, - "query_generator_config": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "default", - "default": "default" - }, - "sep": { - "type": "string", - "default": " " - } - }, - "additionalProperties": false, - "required": [ - "type", - "sep" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm", - "default": "llm" - }, - "model": { - "type": "string" - }, - "template": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "template" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "custom", - "default": "custom" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - }, - "max_tokens_in_context": { - "type": "integer", - "default": 4096 - }, - "max_chunks": { - "type": "integer", - "default": 10 - } - }, - "additionalProperties": false, - "required": [ - "type", - "memory_bank_configs", - "query_generator_config", - "max_tokens_in_context", - "max_chunks" - ] - } - ] - } - }, - "tool_choice": { - "type": "string", - "enum": [ - "auto", - "required" - ], - "default": "auto" - }, - "tool_prompt_format": { - "type": "string", - "enum": [ - "json", - "function_tag", - "python_list" - ], - "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli", - "default": "json" - }, - "max_infer_iters": { - "type": "integer", - "default": 10 - }, - "model": { - "type": "string" - }, - "instructions": { - "type": "string" - }, - "enable_session_persistence": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "max_infer_iters", - "model", - "instructions", - "enable_session_persistence" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "config" - ] - } - ] - }, - "num_examples": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "type", - "eval_candidate" - ] + "$ref": "#/components/schemas/BenchmarkEvalTaskConfig" }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "app", - "default": "app" - }, - "eval_candidate": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "model", - "default": "model" - }, - "model": { - "type": "string" - }, - "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] - }, - "system_message": { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "system", - "default": "system" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "sampling_params" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "agent", - "default": "agent" - }, - "config": { - "type": "object", - "properties": { - "sampling_params": { - "type": "object", - "properties": { - "strategy": { - "type": "string", - "enum": [ - "greedy", - "top_p", - "top_k" - ], - "default": "greedy" - }, - "temperature": { - "type": "number", - "default": 0.0 - }, - "top_p": { - "type": "number", - "default": 0.95 - }, - "top_k": { - "type": "integer", - "default": 0 - }, - "max_tokens": { - "type": "integer", - "default": 0 - }, - "repetition_penalty": { - "type": "number", - "default": 1.0 - } - }, - "additionalProperties": false, - "required": [ - "strategy" - ] - }, - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "tools": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "brave_search", - "default": "brave_search" - }, - "api_key": { - "type": "string" - }, - "engine": { - "type": "string", - "enum": [ - "bing", - "brave" - ], - "default": "brave" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key", - "engine" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "wolfram_alpha", - "default": "wolfram_alpha" - }, - "api_key": { - "type": "string" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "api_key" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "photogen", - "default": "photogen" - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "code_interpreter", - "default": "code_interpreter" - }, - "enable_inline_code_execution": { - "type": "boolean", - "default": true - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "enable_inline_code_execution" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "function_call", - "default": "function_call" - }, - "function_name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "param_type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": true - }, - "default": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "additionalProperties": false, - "required": [ - "param_type" - ] - } - }, - "remote_execution": { - "type": "object", - "properties": { - "url": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "method": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ] - }, - "params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - }, - "body": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "url", - "method" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "function_name", - "description", - "parameters" - ] - }, - { - "type": "object", - "properties": { - "input_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "output_shields": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "const": "memory", - "default": "memory" - }, - "memory_bank_configs": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "vector", - "default": "vector" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "keyvalue", - "default": "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", - "default": "keyword" - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "bank_id": { - "type": "string" - }, - "type": { - "type": "string", - "const": "graph", - "default": "graph" - }, - "entities": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "bank_id", - "type", - "entities" - ] - } - ] - } - }, - "query_generator_config": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "default", - "default": "default" - }, - "sep": { - "type": "string", - "default": " " - } - }, - "additionalProperties": false, - "required": [ - "type", - "sep" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm", - "default": "llm" - }, - "model": { - "type": "string" - }, - "template": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "type", - "model", - "template" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "custom", - "default": "custom" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - }, - "max_tokens_in_context": { - "type": "integer", - "default": 4096 - }, - "max_chunks": { - "type": "integer", - "default": 10 - } - }, - "additionalProperties": false, - "required": [ - "type", - "memory_bank_configs", - "query_generator_config", - "max_tokens_in_context", - "max_chunks" - ] - } - ] - } - }, - "tool_choice": { - "type": "string", - "enum": [ - "auto", - "required" - ], - "default": "auto" - }, - "tool_prompt_format": { - "type": "string", - "enum": [ - "json", - "function_tag", - "python_list" - ], - "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli", - "default": "json" - }, - "max_infer_iters": { - "type": "integer", - "default": 10 - }, - "model": { - "type": "string" - }, - "instructions": { - "type": "string" - }, - "enable_session_persistence": { - "type": "boolean" - } - }, - "additionalProperties": false, - "required": [ - "max_infer_iters", - "model", - "instructions", - "enable_session_persistence" - ] - } - }, - "additionalProperties": false, - "required": [ - "type", - "config" - ] - } - ] - }, - "scoring_params": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm_as_judge", - "default": "llm_as_judge" - }, - "judge_model": { - "type": "string" - }, - "prompt_template": { - "type": "string" - }, - "judge_score_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type", - "judge_model" - ] - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "regex_parser", - "default": "regex_parser" - }, - "parsing_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - } - ] - } - }, - "num_examples": { - "type": "integer" - } - }, - "additionalProperties": false, - "required": [ - "type", - "eval_candidate", - "scoring_params" - ] + "$ref": "#/components/schemas/AppEvalTaskConfig" } ] } @@ -23230,659 +7398,16 @@ "items": { "oneOf": [ { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/UserMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "system", - "default": "system" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/SystemMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] + "$ref": "#/components/schemas/ToolResponseMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] + "$ref": "#/components/schemas/CompletionMessage" } ] } @@ -23924,50 +7449,7 @@ "type": "object", "properties": { "violation": { - "type": "object", - "properties": { - "violation_level": { - "type": "string", - "enum": [ - "info", - "warn", - "error" - ] - }, - "user_message": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "violation_level", - "metadata" - ] + "$ref": "#/components/schemas/SafetyViolation" } }, "additionalProperties": false @@ -24010,51 +7492,10 @@ { "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm_as_judge", - "default": "llm_as_judge" - }, - "judge_model": { - "type": "string" - }, - "prompt_template": { - "type": "string" - }, - "judge_score_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type", - "judge_model" - ] + "$ref": "#/components/schemas/LLMAsJudgeScoringFnParams" }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "regex_parser", - "default": "regex_parser" - }, - "parsing_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type" - ] + "$ref": "#/components/schemas/RegexParserScoringFnParams" } ] }, @@ -24077,67 +7518,7 @@ "results": { "type": "object", "additionalProperties": { - "type": "object", - "properties": { - "score_rows": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "aggregated_results": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "score_rows", - "aggregated_results" - ] + "$ref": "#/components/schemas/ScoringResult" } } }, @@ -24159,51 +7540,10 @@ { "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "llm_as_judge", - "default": "llm_as_judge" - }, - "judge_model": { - "type": "string" - }, - "prompt_template": { - "type": "string" - }, - "judge_score_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type", - "judge_model" - ] + "$ref": "#/components/schemas/LLMAsJudgeScoringFnParams" }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "regex_parser", - "default": "regex_parser" - }, - "parsing_regexes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "required": [ - "type" - ] + "$ref": "#/components/schemas/RegexParserScoringFnParams" } ] }, @@ -24233,67 +7573,7 @@ "results": { "type": "object", "additionalProperties": { - "type": "object", - "properties": { - "score_rows": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "aggregated_results": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "null" - }, - { - "type": "boolean" - }, - { - "type": "number" - }, - { - "type": "string" - }, - { - "type": "array" - }, - { - "type": "object" - } - ] - } - } - }, - "additionalProperties": false, - "required": [ - "score_rows", - "aggregated_results" - ] + "$ref": "#/components/schemas/ScoringResult" } } }, @@ -24302,6 +7582,108 @@ "results" ] }, + "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" + ] + }, + "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" + ] + }, "SupervisedFineTuneRequest": { "type": "object", "properties": { @@ -24318,175 +7700,26 @@ "type": "string" }, "algorithm": { - "type": "string", - "enum": [ - "full", - "lora", - "qlora", - "dora" - ] + "$ref": "#/components/schemas/FinetuningAlgorithm" }, "algorithm_config": { "oneOf": [ { - "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" - ] + "$ref": "#/components/schemas/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" - ] + "$ref": "#/components/schemas/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" - ] + "$ref": "#/components/schemas/DoraFinetuningConfig" } ] }, "optimizer_config": { - "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" - ] + "$ref": "#/components/schemas/OptimizerConfig" }, "training_config": { - "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" - ] + "$ref": "#/components/schemas/TrainingConfig" }, "hyperparam_search_config": { "type": "object", @@ -24561,659 +7794,16 @@ "items": { "oneOf": [ { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "user", - "default": "user" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "context": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/UserMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "system", - "default": "system" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "content" - ] + "$ref": "#/components/schemas/SystemMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "ipython", - "default": "ipython" - }, - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "type": "string" - } - ] - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - } - }, - "additionalProperties": false, - "required": [ - "role", - "call_id", - "tool_name", - "content" - ] + "$ref": "#/components/schemas/ToolResponseMessage" }, { - "type": "object", - "properties": { - "role": { - "type": "string", - "const": "assistant", - "default": "assistant" - }, - "content": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - }, - { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "image": { - "oneOf": [ - { - "type": "object", - "properties": { - "format": { - "type": "string" - }, - "format_description": { - "type": "string" - } - }, - "additionalProperties": false, - "title": "This class represents an image object. To create" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - } - ] - } - }, - "additionalProperties": false, - "required": [ - "image" - ] - } - ] - } - } - ] - }, - "stop_reason": { - "type": "string", - "enum": [ - "end_of_turn", - "end_of_message", - "out_of_tokens" - ] - }, - "tool_calls": { - "type": "array", - "items": { - "type": "object", - "properties": { - "call_id": { - "type": "string" - }, - "tool_name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "brave_search", - "wolfram_alpha", - "photogen", - "code_interpreter" - ] - }, - { - "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" - ] - } - } - }, - "additionalProperties": false, - "required": [ - "role", - "content", - "stop_reason", - "tool_calls" - ] + "$ref": "#/components/schemas/CompletionMessage" } ] } @@ -25336,6 +7926,14 @@ } ], "tags": [ + { + "name": "AgentCandidate", + "description": "" + }, + { + "name": "AgentConfig", + "description": "" + }, { "name": "AgentCreateResponse", "description": "" @@ -25348,9 +7946,45 @@ "name": "AgentStepResponse", "description": "" }, + { + "name": "AgentTurnResponseEvent", + "description": "Streamed agent execution response.\n\n" + }, + { + "name": "AgentTurnResponseStepCompletePayload", + "description": "" + }, + { + "name": "AgentTurnResponseStepProgressPayload", + "description": "" + }, + { + "name": "AgentTurnResponseStepStartPayload", + "description": "" + }, + { + "name": "AgentTurnResponseStreamChunk", + "description": "streamed agent turn completion response.\n\n" + }, + { + "name": "AgentTurnResponseTurnCompletePayload", + "description": "" + }, + { + "name": "AgentTurnResponseTurnStartPayload", + "description": "" + }, { "name": "Agents" }, + { + "name": "AppEvalTaskConfig", + "description": "" + }, + { + "name": "Attachment", + "description": "" + }, { "name": "BatchChatCompletionRequest", "description": "" @@ -25370,6 +8004,14 @@ { "name": "BatchInference" }, + { + "name": "BenchmarkEvalTaskConfig", + "description": "" + }, + { + "name": "BuiltinTool", + "description": "" + }, { "name": "CancelTrainingJobRequest", "description": "" @@ -25378,10 +8020,46 @@ "name": "ChatCompletionRequest", "description": "" }, + { + "name": "ChatCompletionResponse", + "description": "Chat completion response.\n\n" + }, + { + "name": "ChatCompletionResponseEvent", + "description": "Chat completion response event.\n\n" + }, + { + "name": "ChatCompletionResponseEventType", + "description": "" + }, + { + "name": "ChatCompletionResponseStreamChunk", + "description": "SSE-stream of these events.\n\n" + }, + { + "name": "Checkpoint", + "description": "Checkpoint created during training runs\n\n" + }, + { + "name": "CodeInterpreterToolDefinition", + "description": "" + }, + { + "name": "CompletionMessage", + "description": "" + }, { "name": "CompletionRequest", "description": "" }, + { + "name": "CompletionResponse", + "description": "Completion response.\n\n" + }, + { + "name": "CompletionResponseStreamChunk", + "description": "streamed completion response.\n\n" + }, { "name": "CreateAgentRequest", "description": "" @@ -25394,6 +8072,10 @@ "name": "CreateAgentTurnRequest", "description": "" }, + { + "name": "DPOAlignmentConfig", + "description": "" + }, { "name": "Dataset", "description": "" @@ -25412,6 +8094,10 @@ "name": "DeleteAgentsSessionRequest", "description": "" }, + { + "name": "DoraFinetuningConfig", + "description": "" + }, { "name": "EmbeddingsRequest", "description": "" @@ -25438,17 +8124,41 @@ "name": "EvaluateRowsRequest", "description": "" }, + { + "name": "FinetuningAlgorithm", + "description": "" + }, + { + "name": "FunctionCallToolDefinition", + "description": "" + }, { "name": "GetAgentsSessionRequest", "description": "" }, + { + "name": "GraphMemoryBank", + "description": "" + }, + { + "name": "GraphMemoryBankParams", + "description": "" + }, { "name": "HealthInfo", "description": "" }, + { + "name": "ImageMedia", + "description": "" + }, { "name": "Inference" }, + { + "name": "InferenceStep", + "description": "" + }, { "name": "InsertDocumentsRequest", "description": "" @@ -25464,27 +8174,87 @@ "name": "JobCancelRequest", "description": "" }, + { + "name": "JobStatus", + "description": "" + }, + { + "name": "KeyValueMemoryBank", + "description": "" + }, + { + "name": "KeyValueMemoryBankParams", + "description": "" + }, + { + "name": "KeywordMemoryBank", + "description": "" + }, + { + "name": "KeywordMemoryBankParams", + "description": "" + }, + { + "name": "LLMAsJudgeScoringFnParams", + "description": "" + }, { "name": "LogEventRequest", "description": "" }, + { + "name": "LogSeverity", + "description": "" + }, + { + "name": "LoraFinetuningConfig", + "description": "" + }, { "name": "Memory" }, + { + "name": "MemoryBankDocument", + "description": "" + }, { "name": "MemoryBanks" }, + { + "name": "MemoryRetrievalStep", + "description": "" + }, + { + "name": "MemoryToolDefinition", + "description": "" + }, + { + "name": "MetricEvent", + "description": "" + }, { "name": "Model", "description": "" }, + { + "name": "ModelCandidate", + "description": "" + }, { "name": "Models" }, + { + "name": "OptimizerConfig", + "description": "" + }, { "name": "PaginatedRowsResult", "description": "" }, + { + "name": "PhotogenToolDefinition", + "description": "" + }, { "name": "PostTraining" }, @@ -25500,6 +8270,10 @@ "name": "PostTrainingJobLogStream", "description": "Stream of logs from a finetuning job.\n\n" }, + { + "name": "PostTrainingJobStatus", + "description": "" + }, { "name": "PostTrainingJobStatusResponse", "description": "Status of a finetuning job.\n\n" @@ -25508,6 +8282,14 @@ "name": "PreferenceOptimizeRequest", "description": "" }, + { + "name": "ProviderInfo", + "description": "" + }, + { + "name": "QLoraFinetuningConfig", + "description": "" + }, { "name": "QueryDocumentsRequest", "description": "" @@ -25516,6 +8298,14 @@ "name": "QueryDocumentsResponse", "description": "" }, + { + "name": "RLHFAlgorithm", + "description": "" + }, + { + "name": "RegexParserScoringFnParams", + "description": "" + }, { "name": "RegisterDatasetRequest", "description": "" @@ -25540,6 +8330,18 @@ "name": "RegisterShieldRequest", "description": "" }, + { + "name": "RestAPIExecutionConfig", + "description": "" + }, + { + "name": "RestAPIMethod", + "description": "" + }, + { + "name": "RouteInfo", + "description": "" + }, { "name": "RunEvalRequest", "description": "" @@ -25555,6 +8357,18 @@ { "name": "Safety" }, + { + "name": "SafetyViolation", + "description": "" + }, + { + "name": "SamplingParams", + "description": "" + }, + { + "name": "SamplingStrategy", + "description": "" + }, { "name": "ScoreBatchRequest", "description": "" @@ -25581,6 +8395,14 @@ { "name": "ScoringFunctions" }, + { + "name": "ScoringResult", + "description": "" + }, + { + "name": "SearchToolDefinition", + "description": "" + }, { "name": "Session", "description": "A single session of an interaction with an Agentic System.\n\n" @@ -25589,9 +8411,33 @@ "name": "Shield", "description": "A safety shield resource that can be used to check content\n\n" }, + { + "name": "ShieldCallStep", + "description": "" + }, { "name": "Shields" }, + { + "name": "SpanEndPayload", + "description": "" + }, + { + "name": "SpanStartPayload", + "description": "" + }, + { + "name": "SpanStatus", + "description": "" + }, + { + "name": "StopReason", + "description": "" + }, + { + "name": "StructuredLogEvent", + "description": "" + }, { "name": "SupervisedFineTuneRequest", "description": "" @@ -25607,17 +8453,73 @@ "name": "SyntheticDataGenerationResponse", "description": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold.\n\n" }, + { + "name": "SystemMessage", + "description": "" + }, { "name": "Telemetry" }, + { + "name": "TokenLogProbs", + "description": "" + }, + { + "name": "ToolCall", + "description": "" + }, + { + "name": "ToolCallDelta", + "description": "" + }, + { + "name": "ToolCallParseStatus", + "description": "" + }, + { + "name": "ToolChoice", + "description": "" + }, + { + "name": "ToolDefinition", + "description": "" + }, + { + "name": "ToolExecutionStep", + "description": "" + }, + { + "name": "ToolParamDefinition", + "description": "" + }, + { + "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 (parameters)\n\nThe detailed prompts for each of these formats are added to llama cli\n\n" + }, + { + "name": "ToolResponse", + "description": "" + }, + { + "name": "ToolResponseMessage", + "description": "" + }, { "name": "Trace", "description": "" }, + { + "name": "TrainingConfig", + "description": "" + }, { "name": "Turn", "description": "A single turn in an interaction with an Agentic System.\n\n" }, + { + "name": "URL", + "description": "" + }, { "name": "UnregisterMemoryBankRequest", "description": "" @@ -25625,6 +8527,30 @@ { "name": "UnregisterModelRequest", "description": "" + }, + { + "name": "UnstructuredLogEvent", + "description": "" + }, + { + "name": "UserMessage", + "description": "" + }, + { + "name": "VectorMemoryBank", + "description": "" + }, + { + "name": "VectorMemoryBankParams", + "description": "" + }, + { + "name": "ViolationLevel", + "description": "" + }, + { + "name": "WolframAlphaToolDefinition", + "description": "" } ], "x-tagGroups": [ @@ -25654,65 +8580,149 @@ { "name": "Types", "tags": [ + "AgentCandidate", + "AgentConfig", "AgentCreateResponse", "AgentSessionCreateResponse", "AgentStepResponse", + "AgentTurnResponseEvent", + "AgentTurnResponseStepCompletePayload", + "AgentTurnResponseStepProgressPayload", + "AgentTurnResponseStepStartPayload", + "AgentTurnResponseStreamChunk", + "AgentTurnResponseTurnCompletePayload", + "AgentTurnResponseTurnStartPayload", + "AppEvalTaskConfig", + "Attachment", "BatchChatCompletionRequest", "BatchChatCompletionResponse", "BatchCompletionRequest", "BatchCompletionResponse", + "BenchmarkEvalTaskConfig", + "BuiltinTool", "CancelTrainingJobRequest", "ChatCompletionRequest", + "ChatCompletionResponse", + "ChatCompletionResponseEvent", + "ChatCompletionResponseEventType", + "ChatCompletionResponseStreamChunk", + "Checkpoint", + "CodeInterpreterToolDefinition", + "CompletionMessage", "CompletionRequest", + "CompletionResponse", + "CompletionResponseStreamChunk", "CreateAgentRequest", "CreateAgentSessionRequest", "CreateAgentTurnRequest", + "DPOAlignmentConfig", "Dataset", "DeleteAgentsRequest", "DeleteAgentsSessionRequest", + "DoraFinetuningConfig", "EmbeddingsRequest", "EmbeddingsResponse", "EvalTask", "EvaluateResponse", "EvaluateRowsRequest", + "FinetuningAlgorithm", + "FunctionCallToolDefinition", "GetAgentsSessionRequest", + "GraphMemoryBank", + "GraphMemoryBankParams", "HealthInfo", + "ImageMedia", + "InferenceStep", "InsertDocumentsRequest", "Job", "JobCancelRequest", + "JobStatus", + "KeyValueMemoryBank", + "KeyValueMemoryBankParams", + "KeywordMemoryBank", + "KeywordMemoryBankParams", + "LLMAsJudgeScoringFnParams", "LogEventRequest", + "LogSeverity", + "LoraFinetuningConfig", + "MemoryBankDocument", + "MemoryRetrievalStep", + "MemoryToolDefinition", + "MetricEvent", "Model", + "ModelCandidate", + "OptimizerConfig", "PaginatedRowsResult", + "PhotogenToolDefinition", "PostTrainingJob", "PostTrainingJobArtifactsResponse", "PostTrainingJobLogStream", + "PostTrainingJobStatus", "PostTrainingJobStatusResponse", "PreferenceOptimizeRequest", + "ProviderInfo", + "QLoraFinetuningConfig", "QueryDocumentsRequest", "QueryDocumentsResponse", + "RLHFAlgorithm", + "RegexParserScoringFnParams", "RegisterDatasetRequest", "RegisterEvalTaskRequest", "RegisterMemoryBankRequest", "RegisterModelRequest", "RegisterScoringFunctionRequest", "RegisterShieldRequest", + "RestAPIExecutionConfig", + "RestAPIMethod", + "RouteInfo", "RunEvalRequest", "RunShieldRequest", "RunShieldResponse", + "SafetyViolation", + "SamplingParams", + "SamplingStrategy", "ScoreBatchRequest", "ScoreBatchResponse", "ScoreRequest", "ScoreResponse", "ScoringFn", + "ScoringResult", + "SearchToolDefinition", "Session", "Shield", + "ShieldCallStep", + "SpanEndPayload", + "SpanStartPayload", + "SpanStatus", + "StopReason", + "StructuredLogEvent", "SupervisedFineTuneRequest", "SyntheticDataGenerateRequest", "SyntheticDataGenerationResponse", + "SystemMessage", + "TokenLogProbs", + "ToolCall", + "ToolCallDelta", + "ToolCallParseStatus", + "ToolChoice", + "ToolDefinition", + "ToolExecutionStep", + "ToolParamDefinition", + "ToolPromptFormat", + "ToolResponse", + "ToolResponseMessage", "Trace", + "TrainingConfig", "Turn", + "URL", "UnregisterMemoryBankRequest", - "UnregisterModelRequest" + "UnregisterModelRequest", + "UnstructuredLogEvent", + "UserMessage", + "VectorMemoryBank", + "VectorMemoryBankParams", + "ViolationLevel", + "WolframAlphaToolDefinition" ] } ] diff --git a/docs/resources/llama-stack-spec.yaml b/docs/resources/llama-stack-spec.yaml index 10038b0d2..994e3aac4 100644 --- a/docs/resources/llama-stack-spec.yaml +++ b/docs/resources/llama-stack-spec.yaml @@ -1,6 +1,63 @@ components: responses: {} schemas: + AgentCandidate: + additionalProperties: false + properties: + config: + $ref: '#/components/schemas/AgentConfig' + type: + const: agent + default: agent + type: string + required: + - type + - config + type: object + AgentConfig: + additionalProperties: false + properties: + enable_session_persistence: + type: boolean + input_shields: + items: + type: string + type: array + instructions: + type: string + max_infer_iters: + default: 10 + type: integer + model: + type: string + output_shields: + items: + type: string + type: array + sampling_params: + $ref: '#/components/schemas/SamplingParams' + tool_choice: + $ref: '#/components/schemas/ToolChoice' + default: auto + tool_prompt_format: + $ref: '#/components/schemas/ToolPromptFormat' + default: json + tools: + items: + oneOf: + - $ref: '#/components/schemas/SearchToolDefinition' + - $ref: '#/components/schemas/WolframAlphaToolDefinition' + - $ref: '#/components/schemas/PhotogenToolDefinition' + - $ref: '#/components/schemas/CodeInterpreterToolDefinition' + - $ref: '#/components/schemas/FunctionCallToolDefinition' + - $ref: '#/components/schemas/MemoryToolDefinition' + type: array + required: + - max_infer_iters + - model + - instructions + - enable_session_persistence + type: object AgentCreateResponse: additionalProperties: false properties: @@ -22,414 +79,188 @@ components: properties: step: oneOf: - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - model_response: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: inference - default: inference - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - model_response - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: tool_execution - default: tool_execution - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - tool_responses: - items: - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - content - type: object - type: array - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - tool_calls - - tool_responses - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: shield_call - default: shield_call - type: string - turn_id: - type: string - violation: - additionalProperties: false - properties: - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - user_message: - type: string - violation_level: - enum: - - info - - warn - - error - type: string - required: - - violation_level - - metadata - type: object - required: - - turn_id - - step_id - - step_type - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - inserted_context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - memory_bank_ids: - items: - type: string - type: array - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: memory_retrieval - default: memory_retrieval - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - memory_bank_ids - - inserted_context - type: object + - $ref: '#/components/schemas/InferenceStep' + - $ref: '#/components/schemas/ToolExecutionStep' + - $ref: '#/components/schemas/ShieldCallStep' + - $ref: '#/components/schemas/MemoryRetrievalStep' required: - step type: object + AgentTurnResponseEvent: + additionalProperties: false + properties: + payload: + oneOf: + - $ref: '#/components/schemas/AgentTurnResponseStepStartPayload' + - $ref: '#/components/schemas/AgentTurnResponseStepProgressPayload' + - $ref: '#/components/schemas/AgentTurnResponseStepCompletePayload' + - $ref: '#/components/schemas/AgentTurnResponseTurnStartPayload' + - $ref: '#/components/schemas/AgentTurnResponseTurnCompletePayload' + required: + - payload + title: Streamed agent execution response. + type: object + AgentTurnResponseStepCompletePayload: + additionalProperties: false + properties: + event_type: + const: step_complete + default: step_complete + type: string + step_details: + oneOf: + - $ref: '#/components/schemas/InferenceStep' + - $ref: '#/components/schemas/ToolExecutionStep' + - $ref: '#/components/schemas/ShieldCallStep' + - $ref: '#/components/schemas/MemoryRetrievalStep' + step_type: + enum: + - inference + - tool_execution + - shield_call + - memory_retrieval + type: string + required: + - event_type + - step_type + - step_details + type: object + AgentTurnResponseStepProgressPayload: + additionalProperties: false + properties: + event_type: + const: step_progress + default: step_progress + type: string + model_response_text_delta: + type: string + step_id: + type: string + step_type: + enum: + - inference + - tool_execution + - shield_call + - memory_retrieval + type: string + tool_call_delta: + $ref: '#/components/schemas/ToolCallDelta' + tool_response_text_delta: + type: string + required: + - event_type + - step_type + - step_id + type: object + AgentTurnResponseStepStartPayload: + additionalProperties: false + properties: + event_type: + const: step_start + default: step_start + type: string + metadata: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + step_id: + type: string + step_type: + enum: + - inference + - tool_execution + - shield_call + - memory_retrieval + type: string + required: + - event_type + - step_type + - step_id + type: object + AgentTurnResponseStreamChunk: + additionalProperties: false + properties: + event: + $ref: '#/components/schemas/AgentTurnResponseEvent' + required: + - event + title: streamed agent turn completion response. + type: object + AgentTurnResponseTurnCompletePayload: + additionalProperties: false + properties: + event_type: + const: turn_complete + default: turn_complete + type: string + turn: + $ref: '#/components/schemas/Turn' + required: + - event_type + - turn + type: object + AgentTurnResponseTurnStartPayload: + additionalProperties: false + properties: + event_type: + const: turn_start + default: turn_start + type: string + turn_id: + type: string + required: + - event_type + - turn_id + type: object + AppEvalTaskConfig: + additionalProperties: false + properties: + eval_candidate: + oneOf: + - $ref: '#/components/schemas/ModelCandidate' + - $ref: '#/components/schemas/AgentCandidate' + num_examples: + type: integer + scoring_params: + additionalProperties: + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + - $ref: '#/components/schemas/RegexParserScoringFnParams' + type: object + type: + const: app + default: app + type: string + required: + - type + - eval_candidate + - scoring_params + type: object + Attachment: + additionalProperties: false + properties: + content: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + - $ref: '#/components/schemas/URL' + mime_type: + type: string + required: + - content + - mime_type + type: object BatchChatCompletionRequest: additionalProperties: false properties: @@ -444,468 +275,23 @@ components: items: items: oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: system - default: system - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object + - $ref: '#/components/schemas/UserMessage' + - $ref: '#/components/schemas/SystemMessage' + - $ref: '#/components/schemas/ToolResponseMessage' + - $ref: '#/components/schemas/CompletionMessage' type: array type: array model: type: string sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object + $ref: '#/components/schemas/SamplingParams' tool_choice: - enum: - - auto - - required - type: string + $ref: '#/components/schemas/ToolChoice' tool_prompt_format: - 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\ - \ (parameters)\n\nThe detailed prompts\ - \ for each of these formats are added to llama cli" - enum: - - json - - function_tag - - python_list - title: This Enum refers to the prompt format for calling custom / zero shot - tools - type: string + $ref: '#/components/schemas/ToolPromptFormat' tools: items: - additionalProperties: false - properties: - description: - type: string - parameters: - additionalProperties: - additionalProperties: false - properties: - default: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: - type: string - param_type: - type: string - required: - default: true - type: boolean - required: - - param_type - type: object - type: object - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - tool_name - type: object + $ref: '#/components/schemas/ToolDefinition' type: array required: - model @@ -916,121 +302,7 @@ components: properties: completion_message_batch: items: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object + $ref: '#/components/schemas/CompletionMessage' type: array required: - completion_message_batch @@ -1042,53 +314,11 @@ components: items: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' - items: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' type: array type: array logprobs: @@ -1101,33 +331,7 @@ components: model: type: string sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object + $ref: '#/components/schemas/SamplingParams' required: - model - content_batch @@ -1137,125 +341,35 @@ components: properties: completion_message_batch: items: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object + $ref: '#/components/schemas/CompletionMessage' type: array required: - completion_message_batch type: object + BenchmarkEvalTaskConfig: + additionalProperties: false + properties: + eval_candidate: + oneOf: + - $ref: '#/components/schemas/ModelCandidate' + - $ref: '#/components/schemas/AgentCandidate' + num_examples: + type: integer + type: + const: benchmark + default: benchmark + type: string + required: + - type + - eval_candidate + type: object + BuiltinTool: + enum: + - brave_search + - wolfram_alpha + - photogen + - code_interpreter + type: string CancelTrainingJobRequest: additionalProperties: false properties: @@ -1277,368 +391,10 @@ components: messages: items: oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: system - default: system - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object + - $ref: '#/components/schemas/UserMessage' + - $ref: '#/components/schemas/SystemMessage' + - $ref: '#/components/schemas/ToolResponseMessage' + - $ref: '#/components/schemas/CompletionMessage' type: array model_id: type: string @@ -1685,156 +441,134 @@ components: - bnf type: object sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object + $ref: '#/components/schemas/SamplingParams' stream: type: boolean tool_choice: - enum: - - auto - - required - type: string + $ref: '#/components/schemas/ToolChoice' tool_prompt_format: - 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\ - \ (parameters)\n\nThe detailed prompts\ - \ for each of these formats are added to llama cli" - enum: - - json - - function_tag - - python_list - title: This Enum refers to the prompt format for calling custom / zero shot - tools - type: string + $ref: '#/components/schemas/ToolPromptFormat' tools: items: - additionalProperties: false - properties: - description: - type: string - parameters: - additionalProperties: - additionalProperties: false - properties: - default: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: - type: string - param_type: - type: string - required: - default: true - type: boolean - required: - - param_type - type: object - type: object - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - tool_name - type: object + $ref: '#/components/schemas/ToolDefinition' type: array required: - model_id - messages type: object + ChatCompletionResponse: + additionalProperties: false + properties: + completion_message: + $ref: '#/components/schemas/CompletionMessage' + logprobs: + items: + $ref: '#/components/schemas/TokenLogProbs' + type: array + required: + - completion_message + title: Chat completion response. + type: object + ChatCompletionResponseEvent: + additionalProperties: false + properties: + delta: + oneOf: + - type: string + - $ref: '#/components/schemas/ToolCallDelta' + event_type: + $ref: '#/components/schemas/ChatCompletionResponseEventType' + logprobs: + items: + $ref: '#/components/schemas/TokenLogProbs' + type: array + stop_reason: + $ref: '#/components/schemas/StopReason' + required: + - event_type + - delta + title: Chat completion response event. + type: object + ChatCompletionResponseEventType: + enum: + - start + - complete + - progress + type: string + ChatCompletionResponseStreamChunk: + additionalProperties: false + properties: + event: + $ref: '#/components/schemas/ChatCompletionResponseEvent' + required: + - event + title: SSE-stream of these events. + type: object + Checkpoint: + description: Checkpoint created during training runs + CodeInterpreterToolDefinition: + additionalProperties: false + properties: + enable_inline_code_execution: + default: true + type: boolean + input_shields: + items: + type: string + type: array + output_shields: + items: + type: string + type: array + remote_execution: + $ref: '#/components/schemas/RestAPIExecutionConfig' + type: + const: code_interpreter + default: code_interpreter + type: string + required: + - type + - enable_inline_code_execution + type: object + CompletionMessage: + additionalProperties: false + properties: + content: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + role: + const: assistant + default: assistant + type: string + stop_reason: + $ref: '#/components/schemas/StopReason' + tool_calls: + items: + $ref: '#/components/schemas/ToolCall' + type: array + required: + - role + - content + - stop_reason + - tool_calls + type: object CompletionRequest: additionalProperties: false properties: content: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' - items: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' type: array logprobs: additionalProperties: false @@ -1888,645 +622,49 @@ components: - bnf type: object sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object + $ref: '#/components/schemas/SamplingParams' stream: type: boolean required: - model_id - content type: object + CompletionResponse: + additionalProperties: false + properties: + content: + type: string + logprobs: + items: + $ref: '#/components/schemas/TokenLogProbs' + type: array + stop_reason: + $ref: '#/components/schemas/StopReason' + required: + - content + - stop_reason + title: Completion response. + type: object + CompletionResponseStreamChunk: + additionalProperties: false + properties: + delta: + type: string + logprobs: + items: + $ref: '#/components/schemas/TokenLogProbs' + type: array + stop_reason: + $ref: '#/components/schemas/StopReason' + required: + - delta + title: streamed completion response. + type: object CreateAgentRequest: additionalProperties: false properties: agent_config: - additionalProperties: false - properties: - enable_session_persistence: - type: boolean - input_shields: - items: - type: string - type: array - instructions: - type: string - max_infer_iters: - default: 10 - type: integer - model: - type: string - output_shields: - items: - type: string - type: array - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - tool_choice: - default: auto - enum: - - auto - - required - type: string - tool_prompt_format: - default: json - 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 (parameters)\n\ - \nThe detailed prompts for each of these formats are added to llama\ - \ cli" - enum: - - json - - function_tag - - python_list - title: This Enum refers to the prompt format for calling custom / zero - shot tools - type: string - tools: - items: - oneOf: - - additionalProperties: false - properties: - api_key: - type: string - engine: - default: brave - enum: - - bing - - brave - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: brave_search - default: brave_search - type: string - required: - - type - - api_key - - engine - type: object - - additionalProperties: false - properties: - api_key: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: wolfram_alpha - default: wolfram_alpha - type: string - required: - - type - - api_key - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: photogen - default: photogen - type: string - required: - - type - type: object - - additionalProperties: false - properties: - enable_inline_code_execution: - default: true - type: boolean - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: code_interpreter - default: code_interpreter - type: string - required: - - type - - enable_inline_code_execution - type: object - - additionalProperties: false - properties: - description: - type: string - function_name: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - parameters: - additionalProperties: - additionalProperties: false - properties: - default: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: - type: string - param_type: - type: string - required: - default: true - type: boolean - required: - - param_type - type: object - type: object - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: function_call - default: function_call - type: string - required: - - type - - function_name - - description - - parameters - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - max_chunks: - default: 10 - type: integer - max_tokens_in_context: - default: 4096 - type: integer - memory_bank_configs: - items: - oneOf: - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: vector - default: vector - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - keys: - items: - type: string - type: array - type: - const: keyvalue - default: keyvalue - type: string - required: - - bank_id - - type - - keys - type: object - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: keyword - default: keyword - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - entities: - items: - type: string - type: array - type: - const: graph - default: graph - type: string - required: - - bank_id - - type - - entities - type: object - type: array - output_shields: - items: - type: string - type: array - query_generator_config: - oneOf: - - additionalProperties: false - properties: - sep: - default: ' ' - type: string - type: - const: default - default: default - type: string - required: - - type - - sep - type: object - - additionalProperties: false - properties: - model: - type: string - template: - type: string - type: - const: llm - default: llm - type: string - required: - - type - - model - - template - type: object - - additionalProperties: false - properties: - type: - const: custom - default: custom - type: string - required: - - type - type: object - type: - const: memory - default: memory - type: string - required: - - type - - memory_bank_configs - - query_generator_config - - max_tokens_in_context - - max_chunks - type: object - type: array - required: - - max_infer_iters - - model - - instructions - - enable_session_persistence - type: object + $ref: '#/components/schemas/AgentConfig' required: - agent_config type: object @@ -2548,262 +686,13 @@ components: type: string attachments: items: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - mime_type: - type: string - required: - - content - - mime_type - type: object + $ref: '#/components/schemas/Attachment' type: array messages: items: oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object + - $ref: '#/components/schemas/UserMessage' + - $ref: '#/components/schemas/ToolResponseMessage' type: array session_id: type: string @@ -2814,6 +703,23 @@ components: - session_id - messages type: object + DPOAlignmentConfig: + additionalProperties: false + properties: + epsilon: + type: number + gamma: + type: number + reward_clip: + type: number + reward_scale: + type: number + required: + - reward_scale + - reward_clip + - epsilon + - gamma + type: object Dataset: additionalProperties: false properties: @@ -2932,13 +838,7 @@ components: default: dataset type: string url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object + $ref: '#/components/schemas/URL' required: - identifier - provider_resource_id @@ -2967,6 +867,28 @@ components: - agent_id - session_id type: object + DoraFinetuningConfig: + additionalProperties: false + properties: + alpha: + type: integer + apply_lora_to_mlp: + type: boolean + apply_lora_to_output: + type: boolean + lora_attn_modules: + items: + type: string + type: array + rank: + type: integer + required: + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha + type: object EmbeddingsRequest: additionalProperties: false properties: @@ -2974,53 +896,11 @@ components: items: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' - items: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' type: array type: array model_id: @@ -3096,34 +976,7 @@ components: type: array scores: additionalProperties: - additionalProperties: false - properties: - aggregated_results: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - score_rows: - items: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - type: array - required: - - score_rows - - aggregated_results - type: object + $ref: '#/components/schemas/ScoringResult' type: object required: - generations @@ -3150,1510 +1003,8 @@ components: type: array task_config: oneOf: - - additionalProperties: false - properties: - eval_candidate: - oneOf: - - additionalProperties: false - properties: - model: - type: string - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - system_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: system - default: system - type: string - required: - - role - - content - type: object - type: - const: model - default: model - type: string - required: - - type - - model - - sampling_params - type: object - - additionalProperties: false - properties: - config: - additionalProperties: false - properties: - enable_session_persistence: - type: boolean - input_shields: - items: - type: string - type: array - instructions: - type: string - max_infer_iters: - default: 10 - type: integer - model: - type: string - output_shields: - items: - type: string - type: array - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - tool_choice: - default: auto - enum: - - auto - - required - type: string - tool_prompt_format: - default: json - 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 (parameters)\n\ - \nThe detailed prompts for each of these formats are added\ - \ to llama cli" - enum: - - json - - function_tag - - python_list - title: This Enum refers to the prompt format for calling - custom / zero shot tools - type: string - tools: - items: - oneOf: - - additionalProperties: false - properties: - api_key: - type: string - engine: - default: brave - enum: - - bing - - brave - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: brave_search - default: brave_search - type: string - required: - - type - - api_key - - engine - type: object - - additionalProperties: false - properties: - api_key: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: wolfram_alpha - default: wolfram_alpha - type: string - required: - - type - - api_key - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: photogen - default: photogen - type: string - required: - - type - type: object - - additionalProperties: false - properties: - enable_inline_code_execution: - default: true - type: boolean - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: code_interpreter - default: code_interpreter - type: string - required: - - type - - enable_inline_code_execution - type: object - - additionalProperties: false - properties: - description: - type: string - function_name: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - parameters: - additionalProperties: - additionalProperties: false - properties: - default: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: - type: string - param_type: - type: string - required: - default: true - type: boolean - required: - - param_type - type: object - type: object - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: function_call - default: function_call - type: string - required: - - type - - function_name - - description - - parameters - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - max_chunks: - default: 10 - type: integer - max_tokens_in_context: - default: 4096 - type: integer - memory_bank_configs: - items: - oneOf: - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: vector - default: vector - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - keys: - items: - type: string - type: array - type: - const: keyvalue - default: keyvalue - type: string - required: - - bank_id - - type - - keys - type: object - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: keyword - default: keyword - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - entities: - items: - type: string - type: array - type: - const: graph - default: graph - type: string - required: - - bank_id - - type - - entities - type: object - type: array - output_shields: - items: - type: string - type: array - query_generator_config: - oneOf: - - additionalProperties: false - properties: - sep: - default: ' ' - type: string - type: - const: default - default: default - type: string - required: - - type - - sep - type: object - - additionalProperties: false - properties: - model: - type: string - template: - type: string - type: - const: llm - default: llm - type: string - required: - - type - - model - - template - type: object - - additionalProperties: false - properties: - type: - const: custom - default: custom - type: string - required: - - type - type: object - type: - const: memory - default: memory - type: string - required: - - type - - memory_bank_configs - - query_generator_config - - max_tokens_in_context - - max_chunks - type: object - type: array - required: - - max_infer_iters - - model - - instructions - - enable_session_persistence - type: object - type: - const: agent - default: agent - type: string - required: - - type - - config - type: object - num_examples: - type: integer - type: - const: benchmark - default: benchmark - type: string - required: - - type - - eval_candidate - type: object - - additionalProperties: false - properties: - eval_candidate: - oneOf: - - additionalProperties: false - properties: - model: - type: string - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - system_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: system - default: system - type: string - required: - - role - - content - type: object - type: - const: model - default: model - type: string - required: - - type - - model - - sampling_params - type: object - - additionalProperties: false - properties: - config: - additionalProperties: false - properties: - enable_session_persistence: - type: boolean - input_shields: - items: - type: string - type: array - instructions: - type: string - max_infer_iters: - default: 10 - type: integer - model: - type: string - output_shields: - items: - type: string - type: array - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - tool_choice: - default: auto - enum: - - auto - - required - type: string - tool_prompt_format: - default: json - 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 (parameters)\n\ - \nThe detailed prompts for each of these formats are added\ - \ to llama cli" - enum: - - json - - function_tag - - python_list - title: This Enum refers to the prompt format for calling - custom / zero shot tools - type: string - tools: - items: - oneOf: - - additionalProperties: false - properties: - api_key: - type: string - engine: - default: brave - enum: - - bing - - brave - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: brave_search - default: brave_search - type: string - required: - - type - - api_key - - engine - type: object - - additionalProperties: false - properties: - api_key: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: wolfram_alpha - default: wolfram_alpha - type: string - required: - - type - - api_key - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: photogen - default: photogen - type: string - required: - - type - type: object - - additionalProperties: false - properties: - enable_inline_code_execution: - default: true - type: boolean - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: code_interpreter - default: code_interpreter - type: string - required: - - type - - enable_inline_code_execution - type: object - - additionalProperties: false - properties: - description: - type: string - function_name: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - parameters: - additionalProperties: - additionalProperties: false - properties: - default: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: - type: string - param_type: - type: string - required: - default: true - type: boolean - required: - - param_type - type: object - type: object - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: function_call - default: function_call - type: string - required: - - type - - function_name - - description - - parameters - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - max_chunks: - default: 10 - type: integer - max_tokens_in_context: - default: 4096 - type: integer - memory_bank_configs: - items: - oneOf: - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: vector - default: vector - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - keys: - items: - type: string - type: array - type: - const: keyvalue - default: keyvalue - type: string - required: - - bank_id - - type - - keys - type: object - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: keyword - default: keyword - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - entities: - items: - type: string - type: array - type: - const: graph - default: graph - type: string - required: - - bank_id - - type - - entities - type: object - type: array - output_shields: - items: - type: string - type: array - query_generator_config: - oneOf: - - additionalProperties: false - properties: - sep: - default: ' ' - type: string - type: - const: default - default: default - type: string - required: - - type - - sep - type: object - - additionalProperties: false - properties: - model: - type: string - template: - type: string - type: - const: llm - default: llm - type: string - required: - - type - - model - - template - type: object - - additionalProperties: false - properties: - type: - const: custom - default: custom - type: string - required: - - type - type: object - type: - const: memory - default: memory - type: string - required: - - type - - memory_bank_configs - - query_generator_config - - max_tokens_in_context - - max_chunks - type: object - type: array - required: - - max_infer_iters - - model - - instructions - - enable_session_persistence - type: object - type: - const: agent - default: agent - type: string - required: - - type - - config - type: object - num_examples: - type: integer - scoring_params: - additionalProperties: - oneOf: - - additionalProperties: false - properties: - judge_model: - type: string - judge_score_regexes: - items: - type: string - type: array - prompt_template: - type: string - type: - const: llm_as_judge - default: llm_as_judge - type: string - required: - - type - - judge_model - type: object - - additionalProperties: false - properties: - parsing_regexes: - items: - type: string - type: array - type: - const: regex_parser - default: regex_parser - type: string - required: - - type - type: object - type: object - type: - const: app - default: app - type: string - required: - - type - - eval_candidate - - scoring_params - type: object + - $ref: '#/components/schemas/BenchmarkEvalTaskConfig' + - $ref: '#/components/schemas/AppEvalTaskConfig' task_id: type: string required: @@ -4662,6 +1013,44 @@ components: - scoring_functions - task_config type: object + FinetuningAlgorithm: + enum: + - full + - lora + - qlora + - dora + type: string + FunctionCallToolDefinition: + additionalProperties: false + properties: + description: + type: string + function_name: + type: string + input_shields: + items: + type: string + type: array + output_shields: + items: + type: string + type: array + parameters: + additionalProperties: + $ref: '#/components/schemas/ToolParamDefinition' + type: object + remote_execution: + $ref: '#/components/schemas/RestAPIExecutionConfig' + type: + const: function_call + default: function_call + type: string + required: + - type + - function_name + - description + - parameters + type: object GetAgentsSessionRequest: additionalProperties: false properties: @@ -4670,6 +1059,40 @@ components: type: string type: array type: object + GraphMemoryBank: + additionalProperties: false + properties: + identifier: + type: string + memory_bank_type: + const: graph + default: graph + type: string + provider_id: + type: string + provider_resource_id: + type: string + type: + const: memory_bank + default: memory_bank + type: string + required: + - identifier + - provider_resource_id + - provider_id + - type + - memory_bank_type + type: object + GraphMemoryBankParams: + additionalProperties: false + properties: + memory_bank_type: + const: graph + default: graph + type: string + required: + - memory_bank_type + type: object HealthInfo: additionalProperties: false properties: @@ -4678,6 +1101,48 @@ components: required: - status type: object + ImageMedia: + additionalProperties: false + properties: + image: + oneOf: + - additionalProperties: false + properties: + format: + type: string + format_description: + type: string + title: This class represents an image object. To create + type: object + - $ref: '#/components/schemas/URL' + required: + - image + type: object + InferenceStep: + additionalProperties: false + properties: + completed_at: + format: date-time + type: string + model_response: + $ref: '#/components/schemas/CompletionMessage' + started_at: + format: date-time + type: string + step_id: + type: string + step_type: + const: inference + default: inference + type: string + turn_id: + type: string + required: + - turn_id + - step_id + - step_type + - model_response + type: object InsertDocumentsRequest: additionalProperties: false properties: @@ -4685,85 +1150,7 @@ components: type: string documents: items: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - document_id: - type: string - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - mime_type: - type: string - required: - - document_id - - content - - metadata - type: object + $ref: '#/components/schemas/MemoryBankDocument' type: array ttl_seconds: type: integer @@ -4790,157 +1177,379 @@ components: - task_id - job_id type: object + JobStatus: + enum: + - completed + - in_progress + type: string + KeyValueMemoryBank: + additionalProperties: false + properties: + identifier: + type: string + memory_bank_type: + const: keyvalue + default: keyvalue + type: string + provider_id: + type: string + provider_resource_id: + type: string + type: + const: memory_bank + default: memory_bank + type: string + required: + - identifier + - provider_resource_id + - provider_id + - type + - memory_bank_type + type: object + KeyValueMemoryBankParams: + additionalProperties: false + properties: + memory_bank_type: + const: keyvalue + default: keyvalue + type: string + required: + - memory_bank_type + type: object + KeywordMemoryBank: + additionalProperties: false + properties: + identifier: + type: string + memory_bank_type: + const: keyword + default: keyword + type: string + provider_id: + type: string + provider_resource_id: + type: string + type: + const: memory_bank + default: memory_bank + type: string + required: + - identifier + - provider_resource_id + - provider_id + - type + - memory_bank_type + type: object + KeywordMemoryBankParams: + additionalProperties: false + properties: + memory_bank_type: + const: keyword + default: keyword + type: string + required: + - memory_bank_type + type: object + LLMAsJudgeScoringFnParams: + additionalProperties: false + properties: + judge_model: + type: string + judge_score_regexes: + items: + type: string + type: array + prompt_template: + type: string + type: + const: llm_as_judge + default: llm_as_judge + type: string + required: + - type + - judge_model + type: object LogEventRequest: additionalProperties: false properties: event: oneOf: - - additionalProperties: false - properties: - attributes: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - message: - type: string - severity: - enum: - - verbose - - debug - - info - - warn - - error - - critical - type: string - span_id: - type: string - timestamp: - format: date-time - type: string - trace_id: - type: string - type: - const: unstructured_log - default: unstructured_log - type: string - required: - - trace_id - - span_id - - timestamp - - type - - message - - severity - type: object - - additionalProperties: false - properties: - attributes: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - metric: - type: string - span_id: - type: string - timestamp: - format: date-time - type: string - trace_id: - type: string - type: - const: metric - default: metric - type: string - unit: - type: string - value: - oneOf: - - type: integer - - type: number - required: - - trace_id - - span_id - - timestamp - - type - - metric - - value - - unit - type: object - - additionalProperties: false - properties: - attributes: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - payload: - oneOf: - - additionalProperties: false - properties: - name: - type: string - parent_span_id: - type: string - type: - const: span_start - default: span_start - type: string - required: - - type - - name - type: object - - additionalProperties: false - properties: - status: - enum: - - ok - - error - type: string - type: - const: span_end - default: span_end - type: string - required: - - type - - status - type: object - span_id: - type: string - timestamp: - format: date-time - type: string - trace_id: - type: string - type: - const: structured_log - default: structured_log - type: string - required: - - trace_id - - span_id - - timestamp - - type - - payload - type: object + - $ref: '#/components/schemas/UnstructuredLogEvent' + - $ref: '#/components/schemas/MetricEvent' + - $ref: '#/components/schemas/StructuredLogEvent' required: - event type: object + LogSeverity: + enum: + - verbose + - debug + - info + - warn + - error + - critical + type: string + LoraFinetuningConfig: + additionalProperties: false + properties: + alpha: + type: integer + apply_lora_to_mlp: + type: boolean + apply_lora_to_output: + type: boolean + lora_attn_modules: + items: + type: string + type: array + rank: + type: integer + required: + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha + type: object + MemoryBankDocument: + additionalProperties: false + properties: + content: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + - $ref: '#/components/schemas/URL' + document_id: + type: string + metadata: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + mime_type: + type: string + required: + - document_id + - content + - metadata + type: object + MemoryRetrievalStep: + additionalProperties: false + properties: + completed_at: + format: date-time + type: string + inserted_context: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + memory_bank_ids: + items: + type: string + type: array + started_at: + format: date-time + type: string + step_id: + type: string + step_type: + const: memory_retrieval + default: memory_retrieval + type: string + turn_id: + type: string + required: + - turn_id + - step_id + - step_type + - memory_bank_ids + - inserted_context + type: object + MemoryToolDefinition: + additionalProperties: false + properties: + input_shields: + items: + type: string + type: array + max_chunks: + default: 10 + type: integer + max_tokens_in_context: + default: 4096 + type: integer + memory_bank_configs: + items: + oneOf: + - additionalProperties: false + properties: + bank_id: + type: string + type: + const: vector + default: vector + type: string + required: + - bank_id + - type + type: object + - additionalProperties: false + properties: + bank_id: + type: string + keys: + items: + type: string + type: array + type: + const: keyvalue + default: keyvalue + type: string + required: + - bank_id + - type + - keys + type: object + - additionalProperties: false + properties: + bank_id: + type: string + type: + const: keyword + default: keyword + type: string + required: + - bank_id + - type + type: object + - additionalProperties: false + properties: + bank_id: + type: string + entities: + items: + type: string + type: array + type: + const: graph + default: graph + type: string + required: + - bank_id + - type + - entities + type: object + type: array + output_shields: + items: + type: string + type: array + query_generator_config: + oneOf: + - additionalProperties: false + properties: + sep: + default: ' ' + type: string + type: + const: default + default: default + type: string + required: + - type + - sep + type: object + - additionalProperties: false + properties: + model: + type: string + template: + type: string + type: + const: llm + default: llm + type: string + required: + - type + - model + - template + type: object + - additionalProperties: false + properties: + type: + const: custom + default: custom + type: string + required: + - type + type: object + type: + const: memory + default: memory + type: string + required: + - type + - memory_bank_configs + - query_generator_config + - max_tokens_in_context + - max_chunks + type: object + MetricEvent: + additionalProperties: false + properties: + attributes: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + metric: + type: string + span_id: + type: string + timestamp: + format: date-time + type: string + trace_id: + type: string + type: + const: metric + default: metric + type: string + unit: + type: string + value: + oneOf: + - type: integer + - type: number + required: + - trace_id + - span_id + - timestamp + - type + - metric + - value + - unit + type: object Model: additionalProperties: false properties: @@ -4971,6 +1580,45 @@ components: - type - metadata type: object + ModelCandidate: + additionalProperties: false + properties: + model: + type: string + sampling_params: + $ref: '#/components/schemas/SamplingParams' + system_message: + $ref: '#/components/schemas/SystemMessage' + type: + const: model + default: model + type: string + required: + - type + - model + - sampling_params + type: object + OptimizerConfig: + additionalProperties: false + properties: + lr: + type: number + lr_min: + type: number + optimizer_type: + enum: + - adam + - adamw + - sgd + type: string + weight_decay: + type: number + required: + - optimizer_type + - lr + - lr_min + - weight_decay + type: object PaginatedRowsResult: additionalProperties: false properties: @@ -4994,6 +1642,26 @@ components: - rows - total_count type: object + PhotogenToolDefinition: + additionalProperties: false + properties: + input_shields: + items: + type: string + type: array + output_shields: + items: + type: string + type: array + remote_execution: + $ref: '#/components/schemas/RestAPIExecutionConfig' + type: + const: photogen + default: photogen + type: string + required: + - type + type: object PostTrainingJob: additionalProperties: false properties: @@ -5007,25 +1675,7 @@ components: properties: checkpoints: items: - additionalProperties: false - properties: - epoch: - type: integer - iters: - type: integer - path: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - iters - - path - - epoch - type: object + $ref: '#/components/schemas/Checkpoint' type: array job_uuid: type: string @@ -5048,30 +1698,19 @@ components: - log_lines title: Stream of logs from a finetuning job. type: object + PostTrainingJobStatus: + enum: + - running + - completed + - failed + - scheduled + type: string PostTrainingJobStatusResponse: additionalProperties: false properties: checkpoints: items: - additionalProperties: false - properties: - epoch: - type: integer - iters: - type: integer - path: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - iters - - path - - epoch - type: object + $ref: '#/components/schemas/Checkpoint' type: array completed_at: format: date-time @@ -5095,12 +1734,7 @@ components: format: date-time type: string status: - enum: - - running - - completed - - failed - - scheduled - type: string + $ref: '#/components/schemas/PostTrainingJobStatus' required: - job_uuid - status @@ -5111,36 +1745,13 @@ components: additionalProperties: false properties: algorithm: - enum: - - dpo - type: string + $ref: '#/components/schemas/RLHFAlgorithm' algorithm_config: - additionalProperties: false - properties: - epsilon: - type: number - gamma: - type: number - reward_clip: - type: number - reward_scale: - type: number - required: - - reward_scale - - reward_clip - - epsilon - - gamma - type: object + $ref: '#/components/schemas/DPOAlignmentConfig' dataset_id: type: string finetuned_model: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object + $ref: '#/components/schemas/URL' hyperparam_search_config: additionalProperties: oneOf: @@ -5164,52 +1775,9 @@ components: - type: object type: object optimizer_config: - additionalProperties: false - properties: - lr: - type: number - lr_min: - type: number - optimizer_type: - enum: - - adam - - adamw - - sgd - type: string - weight_decay: - type: number - required: - - optimizer_type - - lr - - lr_min - - weight_decay - type: object + $ref: '#/components/schemas/OptimizerConfig' training_config: - additionalProperties: false - properties: - batch_size: - type: integer - enable_activation_checkpointing: - type: boolean - fsdp_cpu_offload: - type: boolean - memory_efficient_fsdp_wrap: - type: boolean - n_epochs: - type: integer - n_iters: - type: integer - shuffle: - type: boolean - required: - - n_epochs - - batch_size - - shuffle - - n_iters - - enable_activation_checkpointing - - memory_efficient_fsdp_wrap - - fsdp_cpu_offload - type: object + $ref: '#/components/schemas/TrainingConfig' validation_dataset_id: type: string required: @@ -5224,6 +1792,39 @@ components: - hyperparam_search_config - logger_config type: object + ProviderInfo: + additionalProperties: false + properties: + provider_id: + type: string + provider_type: + type: string + required: + - provider_id + - provider_type + type: object + QLoraFinetuningConfig: + additionalProperties: false + properties: + alpha: + type: integer + apply_lora_to_mlp: + type: boolean + apply_lora_to_output: + type: boolean + lora_attn_modules: + items: + type: string + type: array + rank: + type: integer + required: + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha + type: object QueryDocumentsRequest: additionalProperties: false properties: @@ -5242,53 +1843,11 @@ components: query: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' - items: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' type: array required: - bank_id @@ -5304,53 +1863,11 @@ components: content: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' - items: oneOf: - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object + - $ref: '#/components/schemas/ImageMedia' type: array document_id: type: string @@ -5370,6 +1887,24 @@ components: - chunks - scores type: object + RLHFAlgorithm: + enum: + - dpo + type: string + RegexParserScoringFnParams: + additionalProperties: false + properties: + parsing_regexes: + items: + type: string + type: array + type: + const: regex_parser + default: regex_parser + type: string + required: + - type + type: object RegisterDatasetRequest: additionalProperties: false properties: @@ -5484,13 +2019,7 @@ components: provider_id: type: string url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object + $ref: '#/components/schemas/URL' required: - dataset_id - dataset_schema @@ -5533,50 +2062,10 @@ components: type: string params: oneOf: - - additionalProperties: false - properties: - chunk_size_in_tokens: - type: integer - embedding_model: - type: string - memory_bank_type: - const: vector - default: vector - type: string - overlap_size_in_tokens: - type: integer - required: - - memory_bank_type - - embedding_model - - chunk_size_in_tokens - type: object - - additionalProperties: false - properties: - memory_bank_type: - const: keyvalue - default: keyvalue - type: string - required: - - memory_bank_type - type: object - - additionalProperties: false - properties: - memory_bank_type: - const: keyword - default: keyword - type: string - required: - - memory_bank_type - type: object - - additionalProperties: false - properties: - memory_bank_type: - const: graph - default: graph - type: string - required: - - memory_bank_type - type: object + - $ref: '#/components/schemas/VectorMemoryBankParams' + - $ref: '#/components/schemas/KeyValueMemoryBankParams' + - $ref: '#/components/schemas/KeywordMemoryBankParams' + - $ref: '#/components/schemas/GraphMemoryBankParams' provider_id: type: string provider_memory_bank_id: @@ -5614,37 +2103,8 @@ components: type: string params: oneOf: - - additionalProperties: false - properties: - judge_model: - type: string - judge_score_regexes: - items: - type: string - type: array - prompt_template: - type: string - type: - const: llm_as_judge - default: llm_as_judge - type: string - required: - - type - - judge_model - type: object - - additionalProperties: false - properties: - parsing_regexes: - items: - type: string - type: array - type: - const: regex_parser - default: regex_parser - type: string - required: - - type - type: object + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + - $ref: '#/components/schemas/RegexParserScoringFnParams' provider_id: type: string provider_scoring_fn_id: @@ -5770,1515 +2230,77 @@ components: required: - shield_id type: object + RestAPIExecutionConfig: + additionalProperties: false + properties: + body: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + headers: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + method: + $ref: '#/components/schemas/RestAPIMethod' + params: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + url: + $ref: '#/components/schemas/URL' + required: + - url + - method + type: object + RestAPIMethod: + enum: + - GET + - POST + - PUT + - DELETE + type: string + RouteInfo: + additionalProperties: false + properties: + method: + type: string + provider_types: + items: + type: string + type: array + route: + type: string + required: + - route + - method + - provider_types + type: object RunEvalRequest: additionalProperties: false properties: task_config: oneOf: - - additionalProperties: false - properties: - eval_candidate: - oneOf: - - additionalProperties: false - properties: - model: - type: string - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - system_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: system - default: system - type: string - required: - - role - - content - type: object - type: - const: model - default: model - type: string - required: - - type - - model - - sampling_params - type: object - - additionalProperties: false - properties: - config: - additionalProperties: false - properties: - enable_session_persistence: - type: boolean - input_shields: - items: - type: string - type: array - instructions: - type: string - max_infer_iters: - default: 10 - type: integer - model: - type: string - output_shields: - items: - type: string - type: array - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - tool_choice: - default: auto - enum: - - auto - - required - type: string - tool_prompt_format: - default: json - 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 (parameters)\n\ - \nThe detailed prompts for each of these formats are added\ - \ to llama cli" - enum: - - json - - function_tag - - python_list - title: This Enum refers to the prompt format for calling - custom / zero shot tools - type: string - tools: - items: - oneOf: - - additionalProperties: false - properties: - api_key: - type: string - engine: - default: brave - enum: - - bing - - brave - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: brave_search - default: brave_search - type: string - required: - - type - - api_key - - engine - type: object - - additionalProperties: false - properties: - api_key: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: wolfram_alpha - default: wolfram_alpha - type: string - required: - - type - - api_key - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: photogen - default: photogen - type: string - required: - - type - type: object - - additionalProperties: false - properties: - enable_inline_code_execution: - default: true - type: boolean - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: code_interpreter - default: code_interpreter - type: string - required: - - type - - enable_inline_code_execution - type: object - - additionalProperties: false - properties: - description: - type: string - function_name: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - parameters: - additionalProperties: - additionalProperties: false - properties: - default: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: - type: string - param_type: - type: string - required: - default: true - type: boolean - required: - - param_type - type: object - type: object - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: function_call - default: function_call - type: string - required: - - type - - function_name - - description - - parameters - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - max_chunks: - default: 10 - type: integer - max_tokens_in_context: - default: 4096 - type: integer - memory_bank_configs: - items: - oneOf: - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: vector - default: vector - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - keys: - items: - type: string - type: array - type: - const: keyvalue - default: keyvalue - type: string - required: - - bank_id - - type - - keys - type: object - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: keyword - default: keyword - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - entities: - items: - type: string - type: array - type: - const: graph - default: graph - type: string - required: - - bank_id - - type - - entities - type: object - type: array - output_shields: - items: - type: string - type: array - query_generator_config: - oneOf: - - additionalProperties: false - properties: - sep: - default: ' ' - type: string - type: - const: default - default: default - type: string - required: - - type - - sep - type: object - - additionalProperties: false - properties: - model: - type: string - template: - type: string - type: - const: llm - default: llm - type: string - required: - - type - - model - - template - type: object - - additionalProperties: false - properties: - type: - const: custom - default: custom - type: string - required: - - type - type: object - type: - const: memory - default: memory - type: string - required: - - type - - memory_bank_configs - - query_generator_config - - max_tokens_in_context - - max_chunks - type: object - type: array - required: - - max_infer_iters - - model - - instructions - - enable_session_persistence - type: object - type: - const: agent - default: agent - type: string - required: - - type - - config - type: object - num_examples: - type: integer - type: - const: benchmark - default: benchmark - type: string - required: - - type - - eval_candidate - type: object - - additionalProperties: false - properties: - eval_candidate: - oneOf: - - additionalProperties: false - properties: - model: - type: string - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - system_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: system - default: system - type: string - required: - - role - - content - type: object - type: - const: model - default: model - type: string - required: - - type - - model - - sampling_params - type: object - - additionalProperties: false - properties: - config: - additionalProperties: false - properties: - enable_session_persistence: - type: boolean - input_shields: - items: - type: string - type: array - instructions: - type: string - max_infer_iters: - default: 10 - type: integer - model: - type: string - output_shields: - items: - type: string - type: array - sampling_params: - additionalProperties: false - properties: - max_tokens: - default: 0 - type: integer - repetition_penalty: - default: 1.0 - type: number - strategy: - default: greedy - enum: - - greedy - - top_p - - top_k - type: string - temperature: - default: 0.0 - type: number - top_k: - default: 0 - type: integer - top_p: - default: 0.95 - type: number - required: - - strategy - type: object - tool_choice: - default: auto - enum: - - auto - - required - type: string - tool_prompt_format: - default: json - 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 (parameters)\n\ - \nThe detailed prompts for each of these formats are added\ - \ to llama cli" - enum: - - json - - function_tag - - python_list - title: This Enum refers to the prompt format for calling - custom / zero shot tools - type: string - tools: - items: - oneOf: - - additionalProperties: false - properties: - api_key: - type: string - engine: - default: brave - enum: - - bing - - brave - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: brave_search - default: brave_search - type: string - required: - - type - - api_key - - engine - type: object - - additionalProperties: false - properties: - api_key: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: wolfram_alpha - default: wolfram_alpha - type: string - required: - - type - - api_key - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: photogen - default: photogen - type: string - required: - - type - type: object - - additionalProperties: false - properties: - enable_inline_code_execution: - default: true - type: boolean - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: code_interpreter - default: code_interpreter - type: string - required: - - type - - enable_inline_code_execution - type: object - - additionalProperties: false - properties: - description: - type: string - function_name: - type: string - input_shields: - items: - type: string - type: array - output_shields: - items: - type: string - type: array - parameters: - additionalProperties: - additionalProperties: false - properties: - default: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: - type: string - param_type: - type: string - required: - default: true - type: boolean - required: - - param_type - type: object - type: object - remote_execution: - additionalProperties: false - properties: - body: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - headers: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - method: - enum: - - GET - - POST - - PUT - - DELETE - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - url - - method - type: object - type: - const: function_call - default: function_call - type: string - required: - - type - - function_name - - description - - parameters - type: object - - additionalProperties: false - properties: - input_shields: - items: - type: string - type: array - max_chunks: - default: 10 - type: integer - max_tokens_in_context: - default: 4096 - type: integer - memory_bank_configs: - items: - oneOf: - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: vector - default: vector - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - keys: - items: - type: string - type: array - type: - const: keyvalue - default: keyvalue - type: string - required: - - bank_id - - type - - keys - type: object - - additionalProperties: false - properties: - bank_id: - type: string - type: - const: keyword - default: keyword - type: string - required: - - bank_id - - type - type: object - - additionalProperties: false - properties: - bank_id: - type: string - entities: - items: - type: string - type: array - type: - const: graph - default: graph - type: string - required: - - bank_id - - type - - entities - type: object - type: array - output_shields: - items: - type: string - type: array - query_generator_config: - oneOf: - - additionalProperties: false - properties: - sep: - default: ' ' - type: string - type: - const: default - default: default - type: string - required: - - type - - sep - type: object - - additionalProperties: false - properties: - model: - type: string - template: - type: string - type: - const: llm - default: llm - type: string - required: - - type - - model - - template - type: object - - additionalProperties: false - properties: - type: - const: custom - default: custom - type: string - required: - - type - type: object - type: - const: memory - default: memory - type: string - required: - - type - - memory_bank_configs - - query_generator_config - - max_tokens_in_context - - max_chunks - type: object - type: array - required: - - max_infer_iters - - model - - instructions - - enable_session_persistence - type: object - type: - const: agent - default: agent - type: string - required: - - type - - config - type: object - num_examples: - type: integer - scoring_params: - additionalProperties: - oneOf: - - additionalProperties: false - properties: - judge_model: - type: string - judge_score_regexes: - items: - type: string - type: array - prompt_template: - type: string - type: - const: llm_as_judge - default: llm_as_judge - type: string - required: - - type - - judge_model - type: object - - additionalProperties: false - properties: - parsing_regexes: - items: - type: string - type: array - type: - const: regex_parser - default: regex_parser - type: string - required: - - type - type: object - type: object - type: - const: app - default: app - type: string - required: - - type - - eval_candidate - - scoring_params - type: object + - $ref: '#/components/schemas/BenchmarkEvalTaskConfig' + - $ref: '#/components/schemas/AppEvalTaskConfig' task_id: type: string required: @@ -7291,368 +2313,10 @@ components: messages: items: oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: system - default: system - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object + - $ref: '#/components/schemas/UserMessage' + - $ref: '#/components/schemas/SystemMessage' + - $ref: '#/components/schemas/ToolResponseMessage' + - $ref: '#/components/schemas/CompletionMessage' type: array params: additionalProperties: @@ -7675,31 +2339,59 @@ components: additionalProperties: false properties: violation: - additionalProperties: false - properties: - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - user_message: - type: string - violation_level: - enum: - - info - - warn - - error - type: string - required: - - violation_level - - metadata - type: object + $ref: '#/components/schemas/SafetyViolation' type: object + SafetyViolation: + additionalProperties: false + properties: + metadata: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + user_message: + type: string + violation_level: + $ref: '#/components/schemas/ViolationLevel' + required: + - violation_level + - metadata + type: object + SamplingParams: + additionalProperties: false + properties: + max_tokens: + default: 0 + type: integer + repetition_penalty: + default: 1.0 + type: number + strategy: + $ref: '#/components/schemas/SamplingStrategy' + default: greedy + temperature: + default: 0.0 + type: number + top_k: + default: 0 + type: integer + top_p: + default: 0.95 + type: number + required: + - strategy + type: object + SamplingStrategy: + enum: + - greedy + - top_p + - top_k + type: string ScoreBatchRequest: additionalProperties: false properties: @@ -7711,37 +2403,8 @@ components: additionalProperties: oneOf: - oneOf: - - additionalProperties: false - properties: - judge_model: - type: string - judge_score_regexes: - items: - type: string - type: array - prompt_template: - type: string - type: - const: llm_as_judge - default: llm_as_judge - type: string - required: - - type - - judge_model - type: object - - additionalProperties: false - properties: - parsing_regexes: - items: - type: string - type: array - type: - const: regex_parser - default: regex_parser - type: string - required: - - type - type: object + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + - $ref: '#/components/schemas/RegexParserScoringFnParams' - type: 'null' type: object required: @@ -7756,34 +2419,7 @@ components: type: string results: additionalProperties: - additionalProperties: false - properties: - aggregated_results: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - score_rows: - items: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - type: array - required: - - score_rows - - aggregated_results - type: object + $ref: '#/components/schemas/ScoringResult' type: object required: - results @@ -7807,37 +2443,8 @@ components: additionalProperties: oneOf: - oneOf: - - additionalProperties: false - properties: - judge_model: - type: string - judge_score_regexes: - items: - type: string - type: array - prompt_template: - type: string - type: - const: llm_as_judge - default: llm_as_judge - type: string - required: - - type - - judge_model - type: object - - additionalProperties: false - properties: - parsing_regexes: - items: - type: string - type: array - type: - const: regex_parser - default: regex_parser - type: string - required: - - type - type: object + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + - $ref: '#/components/schemas/RegexParserScoringFnParams' - type: 'null' type: object required: @@ -7849,34 +2456,7 @@ components: properties: results: additionalProperties: - additionalProperties: false - properties: - aggregated_results: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - score_rows: - items: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - type: array - required: - - score_rows - - aggregated_results - type: object + $ref: '#/components/schemas/ScoringResult' type: object required: - results @@ -7900,37 +2480,8 @@ components: type: object params: oneOf: - - additionalProperties: false - properties: - judge_model: - type: string - judge_score_regexes: - items: - type: string - type: array - prompt_template: - type: string - type: - const: llm_as_judge - default: llm_as_judge - type: string - required: - - type - - judge_model - type: object - - additionalProperties: false - properties: - parsing_regexes: - items: - type: string - type: array - type: - const: regex_parser - default: regex_parser - type: string - required: - - type - type: object + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + - $ref: '#/components/schemas/RegexParserScoringFnParams' provider_id: type: string provider_resource_id: @@ -8039,111 +2590,74 @@ components: - metadata - return_type type: object + ScoringResult: + additionalProperties: false + properties: + aggregated_results: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + score_rows: + items: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + type: array + required: + - score_rows + - aggregated_results + type: object + SearchToolDefinition: + additionalProperties: false + properties: + api_key: + type: string + engine: + default: brave + enum: + - bing + - brave + type: string + input_shields: + items: + type: string + type: array + output_shields: + items: + type: string + type: array + remote_execution: + $ref: '#/components/schemas/RestAPIExecutionConfig' + type: + const: brave_search + default: brave_search + type: string + required: + - type + - api_key + - engine + type: object Session: additionalProperties: false properties: memory_bank: oneOf: - - additionalProperties: false - properties: - chunk_size_in_tokens: - type: integer - embedding_model: - type: string - identifier: - type: string - memory_bank_type: - const: vector - default: vector - type: string - overlap_size_in_tokens: - type: integer - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - - embedding_model - - chunk_size_in_tokens - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: keyvalue - default: keyvalue - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: keyword - default: keyword - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: graph - default: graph - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object + - $ref: '#/components/schemas/VectorMemoryBank' + - $ref: '#/components/schemas/KeyValueMemoryBank' + - $ref: '#/components/schemas/KeywordMemoryBank' + - $ref: '#/components/schemas/GraphMemoryBank' session_id: type: string session_name: @@ -8153,824 +2667,7 @@ components: type: string turns: items: - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - input_messages: - items: - oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object - type: array - output_attachments: - items: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - mime_type: - type: string - required: - - content - - mime_type - type: object - type: array - output_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - session_id: - type: string - started_at: - format: date-time - type: string - steps: - items: - oneOf: - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - model_response: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: inference - default: inference - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - model_response - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: tool_execution - default: tool_execution - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - tool_responses: - items: - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - content - type: object - type: array - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - tool_calls - - tool_responses - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: shield_call - default: shield_call - type: string - turn_id: - type: string - violation: - additionalProperties: false - properties: - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - user_message: - type: string - violation_level: - enum: - - info - - warn - - error - type: string - required: - - violation_level - - metadata - type: object - required: - - turn_id - - step_id - - step_type - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - inserted_context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - memory_bank_ids: - items: - type: string - type: array - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: memory_retrieval - default: memory_retrieval - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - memory_bank_ids - - inserted_context - type: object - type: array - turn_id: - type: string - 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. - type: object + $ref: '#/components/schemas/Turn' type: array required: - session_id @@ -9009,81 +2706,114 @@ components: - type title: A safety shield resource that can be used to check content type: object + ShieldCallStep: + additionalProperties: false + properties: + completed_at: + format: date-time + type: string + started_at: + format: date-time + type: string + step_id: + type: string + step_type: + const: shield_call + default: shield_call + type: string + turn_id: + type: string + violation: + $ref: '#/components/schemas/SafetyViolation' + required: + - turn_id + - step_id + - step_type + type: object + SpanEndPayload: + additionalProperties: false + properties: + status: + $ref: '#/components/schemas/SpanStatus' + type: + const: span_end + default: span_end + type: string + required: + - type + - status + type: object + SpanStartPayload: + additionalProperties: false + properties: + name: + type: string + parent_span_id: + type: string + type: + const: span_start + default: span_start + type: string + required: + - type + - name + type: object + SpanStatus: + enum: + - ok + - error + type: string + StopReason: + enum: + - end_of_turn + - end_of_message + - out_of_tokens + type: string + StructuredLogEvent: + additionalProperties: false + properties: + attributes: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + payload: + oneOf: + - $ref: '#/components/schemas/SpanStartPayload' + - $ref: '#/components/schemas/SpanEndPayload' + span_id: + type: string + timestamp: + format: date-time + type: string + trace_id: + type: string + type: + const: structured_log + default: structured_log + type: string + required: + - trace_id + - span_id + - timestamp + - type + - payload + type: object SupervisedFineTuneRequest: additionalProperties: false properties: algorithm: - enum: - - full - - lora - - qlora - - dora - type: string + $ref: '#/components/schemas/FinetuningAlgorithm' algorithm_config: oneOf: - - additionalProperties: false - properties: - alpha: - type: integer - apply_lora_to_mlp: - type: boolean - apply_lora_to_output: - type: boolean - lora_attn_modules: - items: - type: string - type: array - rank: - type: integer - required: - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha - type: object - - additionalProperties: false - properties: - alpha: - type: integer - apply_lora_to_mlp: - type: boolean - apply_lora_to_output: - type: boolean - lora_attn_modules: - items: - type: string - type: array - rank: - type: integer - required: - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha - type: object - - additionalProperties: false - properties: - alpha: - type: integer - apply_lora_to_mlp: - type: boolean - apply_lora_to_output: - type: boolean - lora_attn_modules: - items: - type: string - type: array - rank: - type: integer - required: - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha - type: object + - $ref: '#/components/schemas/LoraFinetuningConfig' + - $ref: '#/components/schemas/QLoraFinetuningConfig' + - $ref: '#/components/schemas/DoraFinetuningConfig' dataset_id: type: string hyperparam_search_config: @@ -9111,52 +2841,9 @@ components: model: type: string optimizer_config: - additionalProperties: false - properties: - lr: - type: number - lr_min: - type: number - optimizer_type: - enum: - - adam - - adamw - - sgd - type: string - weight_decay: - type: number - required: - - optimizer_type - - lr - - lr_min - - weight_decay - type: object + $ref: '#/components/schemas/OptimizerConfig' training_config: - additionalProperties: false - properties: - batch_size: - type: integer - enable_activation_checkpointing: - type: boolean - fsdp_cpu_offload: - type: boolean - memory_efficient_fsdp_wrap: - type: boolean - n_epochs: - type: integer - n_iters: - type: integer - shuffle: - type: boolean - required: - - n_epochs - - batch_size - - shuffle - - n_iters - - enable_activation_checkpointing - - memory_efficient_fsdp_wrap - - fsdp_cpu_offload - type: object + $ref: '#/components/schemas/TrainingConfig' validation_dataset_id: type: string required: @@ -9177,368 +2864,10 @@ components: dialogs: items: oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: system - default: system - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object + - $ref: '#/components/schemas/UserMessage' + - $ref: '#/components/schemas/SystemMessage' + - $ref: '#/components/schemas/ToolResponseMessage' + - $ref: '#/components/schemas/CompletionMessage' type: array filtering_function: enum: @@ -9586,6 +2915,236 @@ components: title: Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold. type: object + SystemMessage: + additionalProperties: false + properties: + content: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + role: + const: system + default: system + type: string + required: + - role + - content + type: object + TokenLogProbs: + additionalProperties: false + properties: + logprobs_by_token: + additionalProperties: + type: number + type: object + required: + - logprobs_by_token + type: object + ToolCall: + additionalProperties: false + properties: + arguments: + additionalProperties: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: 'null' + - items: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: 'null' + type: array + - additionalProperties: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: 'null' + type: object + type: object + call_id: + type: string + tool_name: + oneOf: + - $ref: '#/components/schemas/BuiltinTool' + - type: string + required: + - call_id + - tool_name + - arguments + type: object + ToolCallDelta: + additionalProperties: false + properties: + content: + oneOf: + - type: string + - $ref: '#/components/schemas/ToolCall' + parse_status: + $ref: '#/components/schemas/ToolCallParseStatus' + required: + - content + - parse_status + type: object + ToolCallParseStatus: + enum: + - started + - in_progress + - failure + - success + type: string + ToolChoice: + enum: + - auto + - required + type: string + ToolDefinition: + additionalProperties: false + properties: + description: + type: string + parameters: + additionalProperties: + $ref: '#/components/schemas/ToolParamDefinition' + type: object + tool_name: + oneOf: + - $ref: '#/components/schemas/BuiltinTool' + - type: string + required: + - tool_name + type: object + ToolExecutionStep: + additionalProperties: false + properties: + completed_at: + format: date-time + type: string + started_at: + format: date-time + type: string + step_id: + type: string + step_type: + const: tool_execution + default: tool_execution + type: string + tool_calls: + items: + $ref: '#/components/schemas/ToolCall' + type: array + tool_responses: + items: + $ref: '#/components/schemas/ToolResponse' + type: array + turn_id: + type: string + required: + - turn_id + - step_id + - step_type + - tool_calls + - tool_responses + type: object + ToolParamDefinition: + additionalProperties: false + properties: + default: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: + type: string + param_type: + type: string + required: + default: true + type: boolean + required: + - param_type + type: object + ToolPromptFormat: + 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 (parameters)\n\ + \nThe detailed prompts for each of these formats are added to llama cli" + enum: + - json + - function_tag + - python_list + title: This Enum refers to the prompt format for calling custom / zero shot + tools + type: string + ToolResponse: + additionalProperties: false + properties: + call_id: + type: string + content: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + tool_name: + oneOf: + - $ref: '#/components/schemas/BuiltinTool' + - type: string + required: + - call_id + - tool_name + - content + type: object + ToolResponseMessage: + additionalProperties: false + properties: + call_id: + type: string + content: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + role: + const: ipython + default: ipython + type: string + tool_name: + oneOf: + - $ref: '#/components/schemas/BuiltinTool' + - type: string + required: + - role + - call_id + - tool_name + - content + type: object Trace: additionalProperties: false properties: @@ -9604,6 +3163,32 @@ components: - root_span_id - start_time type: object + TrainingConfig: + additionalProperties: false + properties: + batch_size: + type: integer + enable_activation_checkpointing: + type: boolean + fsdp_cpu_offload: + type: boolean + memory_efficient_fsdp_wrap: + type: boolean + n_epochs: + type: integer + n_iters: + type: integer + shuffle: + type: boolean + required: + - n_epochs + - batch_size + - shuffle + - n_iters + - enable_activation_checkpointing + - memory_efficient_fsdp_wrap + - fsdp_cpu_offload + type: object Turn: additionalProperties: false properties: @@ -9613,378 +3198,15 @@ components: input_messages: items: oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object + - $ref: '#/components/schemas/UserMessage' + - $ref: '#/components/schemas/ToolResponseMessage' type: array output_attachments: items: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - mime_type: - type: string - required: - - content - - mime_type - type: object + $ref: '#/components/schemas/Attachment' type: array output_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object + $ref: '#/components/schemas/CompletionMessage' session_id: type: string started_at: @@ -9993,412 +3215,10 @@ components: steps: items: oneOf: - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - model_response: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: inference - default: inference - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - model_response - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: tool_execution - default: tool_execution - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - tool_responses: - items: - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - content - type: object - type: array - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - tool_calls - - tool_responses - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: shield_call - default: shield_call - type: string - turn_id: - type: string - violation: - additionalProperties: false - properties: - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - user_message: - type: string - violation_level: - enum: - - info - - warn - - error - type: string - required: - - violation_level - - metadata - type: object - required: - - turn_id - - step_id - - step_type - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - inserted_context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - memory_bank_ids: - items: - type: string - type: array - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: memory_retrieval - default: memory_retrieval - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - memory_bank_ids - - inserted_context - type: object + - $ref: '#/components/schemas/InferenceStep' + - $ref: '#/components/schemas/ToolExecutionStep' + - $ref: '#/components/schemas/ShieldCallStep' + - $ref: '#/components/schemas/MemoryRetrievalStep' type: array turn_id: type: string @@ -10412,6 +3232,10 @@ components: - started_at title: A single turn in an interaction with an Agentic System. type: object + URL: + format: uri + pattern: ^(https?://|file://|data:) + type: string UnregisterMemoryBankRequest: additionalProperties: false properties: @@ -10428,11 +3252,155 @@ components: required: - model_id type: object + UnstructuredLogEvent: + additionalProperties: false + properties: + attributes: + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + type: object + message: + type: string + severity: + $ref: '#/components/schemas/LogSeverity' + span_id: + type: string + timestamp: + format: date-time + type: string + trace_id: + type: string + type: + const: unstructured_log + default: unstructured_log + type: string + required: + - trace_id + - span_id + - timestamp + - type + - message + - severity + type: object + UserMessage: + additionalProperties: false + properties: + content: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + context: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + - items: + oneOf: + - type: string + - $ref: '#/components/schemas/ImageMedia' + type: array + role: + const: user + default: user + type: string + required: + - role + - content + type: object + VectorMemoryBank: + additionalProperties: false + properties: + chunk_size_in_tokens: + type: integer + embedding_model: + type: string + identifier: + type: string + memory_bank_type: + const: vector + default: vector + type: string + overlap_size_in_tokens: + type: integer + provider_id: + type: string + provider_resource_id: + type: string + type: + const: memory_bank + default: memory_bank + type: string + required: + - identifier + - provider_resource_id + - provider_id + - type + - memory_bank_type + - embedding_model + - chunk_size_in_tokens + type: object + VectorMemoryBankParams: + additionalProperties: false + properties: + chunk_size_in_tokens: + type: integer + embedding_model: + type: string + memory_bank_type: + const: vector + default: vector + type: string + overlap_size_in_tokens: + type: integer + required: + - memory_bank_type + - embedding_model + - chunk_size_in_tokens + type: object + ViolationLevel: + enum: + - info + - warn + - error + type: string + WolframAlphaToolDefinition: + additionalProperties: false + properties: + api_key: + type: string + input_shields: + items: + type: string + type: array + output_shields: + items: + type: string + type: array + remote_execution: + $ref: '#/components/schemas/RestAPIExecutionConfig' + type: + const: wolfram_alpha + default: wolfram_alpha + type: string + required: + - type + - api_key + type: object info: description: "This is the specification of the llama stack that provides\n \ \ a set of endpoints and their corresponding interfaces that are tailored\ \ to\n best leverage Llama Models. The specification is still in\ - \ draft and subject to change.\n Generated at 2024-11-18 18:52:41.983165" + \ draft and subject to change.\n Generated at 2024-11-18 23:37:24.867143" title: '[DRAFT] Llama Stack Specification' version: alpha jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema @@ -10626,2230 +3594,8 @@ paths: text/event-stream: schema: oneOf: - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - input_messages: - items: - oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object - type: array - output_attachments: - items: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - mime_type: - type: string - required: - - content - - mime_type - type: object - type: array - output_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - session_id: - type: string - started_at: - format: date-time - type: string - steps: - items: - oneOf: - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - model_response: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image - object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: inference - default: inference - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - model_response - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: tool_execution - default: tool_execution - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - tool_responses: - items: - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image - object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image - object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - content - type: object - type: array - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - tool_calls - - tool_responses - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: shield_call - default: shield_call - type: string - turn_id: - type: string - violation: - additionalProperties: false - properties: - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - user_message: - type: string - violation_level: - enum: - - info - - warn - - error - type: string - required: - - violation_level - - metadata - type: object - required: - - turn_id - - step_id - - step_type - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - inserted_context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - memory_bank_ids: - items: - type: string - type: array - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: memory_retrieval - default: memory_retrieval - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - memory_bank_ids - - inserted_context - type: object - type: array - turn_id: - type: string - 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. - type: object - - additionalProperties: false - properties: - event: - additionalProperties: false - properties: - payload: - oneOf: - - additionalProperties: false - properties: - event_type: - const: step_start - default: step_start - type: string - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - step_id: - type: string - step_type: - enum: - - inference - - tool_execution - - shield_call - - memory_retrieval - type: string - required: - - event_type - - step_type - - step_id - type: object - - additionalProperties: false - properties: - event_type: - const: step_progress - default: step_progress - type: string - model_response_text_delta: - type: string - step_id: - type: string - step_type: - enum: - - inference - - tool_execution - - shield_call - - memory_retrieval - type: string - tool_call_delta: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - parse_status: - enum: - - started - - in_progress - - failure - - success - type: string - required: - - content - - parse_status - type: object - tool_response_text_delta: - type: string - required: - - event_type - - step_type - - step_id - type: object - - additionalProperties: false - properties: - event_type: - const: step_complete - default: step_complete - type: string - step_details: - oneOf: - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - model_response: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: inference - default: inference - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - model_response - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: tool_execution - default: tool_execution - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - tool_responses: - items: - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - content - type: object - type: array - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - tool_calls - - tool_responses - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: shield_call - default: shield_call - type: string - turn_id: - type: string - violation: - additionalProperties: false - properties: - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - user_message: - type: string - violation_level: - enum: - - info - - warn - - error - type: string - required: - - violation_level - - metadata - type: object - required: - - turn_id - - step_id - - step_type - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - inserted_context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image - object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - memory_bank_ids: - items: - type: string - type: array - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: memory_retrieval - default: memory_retrieval - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - memory_bank_ids - - inserted_context - type: object - step_type: - enum: - - inference - - tool_execution - - shield_call - - memory_retrieval - type: string - required: - - event_type - - step_type - - step_details - type: object - - additionalProperties: false - properties: - event_type: - const: turn_start - default: turn_start - type: string - turn_id: - type: string - required: - - event_type - - turn_id - type: object - - additionalProperties: false - properties: - event_type: - const: turn_complete - default: turn_complete - type: string - turn: - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - input_messages: - items: - oneOf: - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: user - default: user - type: string - required: - - role - - content - type: object - - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: ipython - default: ipython - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - role - - call_id - - tool_name - - content - type: object - type: array - output_attachments: - items: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - mime_type: - type: string - required: - - content - - mime_type - type: object - type: array - output_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image - object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - session_id: - type: string - started_at: - format: date-time - type: string - steps: - items: - oneOf: - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - model_response: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: inference - default: inference - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - model_response - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: tool_execution - default: tool_execution - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - tool_responses: - items: - additionalProperties: false - properties: - call_id: - type: string - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - content - type: object - type: array - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - tool_calls - - tool_responses - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: shield_call - default: shield_call - type: string - turn_id: - type: string - violation: - additionalProperties: false - properties: - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - user_message: - type: string - violation_level: - enum: - - info - - warn - - error - type: string - required: - - violation_level - - metadata - type: object - required: - - turn_id - - step_id - - step_type - type: object - - additionalProperties: false - properties: - completed_at: - format: date-time - type: string - inserted_context: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an - image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents - an image object. To create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - memory_bank_ids: - items: - type: string - type: array - started_at: - format: date-time - type: string - step_id: - type: string - step_type: - const: memory_retrieval - default: memory_retrieval - type: string - turn_id: - type: string - required: - - turn_id - - step_id - - step_type - - memory_bank_ids - - inserted_context - type: object - type: array - turn_id: - type: string - 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. - type: object - required: - - event_type - - turn - type: object - required: - - payload - title: Streamed agent execution response. - type: object - required: - - event - title: streamed agent turn completion response. - type: object + - $ref: '#/components/schemas/Turn' + - $ref: '#/components/schemas/AgentTurnResponseStreamChunk' description: A single turn in an interaction with an Agentic System. **OR** streamed agent turn completion response. tags: @@ -12998,139 +3744,7 @@ paths: application/json: schema: oneOf: - - additionalProperties: false - properties: - dataset_schema: - additionalProperties: - oneOf: - - additionalProperties: false - properties: - type: - const: string - default: string - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: number - default: number - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: boolean - default: boolean - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: array - default: array - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: object - default: object - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: json - default: json - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: union - default: union - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: chat_completion_input - default: chat_completion_input - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: completion_input - default: completion_input - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: agent_turn_input - default: agent_turn_input - type: string - required: - - type - type: object - type: object - identifier: - type: string - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - provider_id: - type: string - provider_resource_id: - type: string - type: - const: dataset - default: dataset - type: string - url: - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - identifier - - provider_resource_id - - provider_id - - type - - dataset_schema - - url - - metadata - type: object + - $ref: '#/components/schemas/Dataset' - type: 'null' description: OK tags: @@ -13196,43 +3810,7 @@ paths: application/json: schema: oneOf: - - additionalProperties: false - properties: - dataset_id: - type: string - identifier: - type: string - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - provider_id: - type: string - provider_resource_id: - type: string - scoring_functions: - items: - type: string - type: array - type: - const: eval_task - default: eval_task - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - dataset_id - - scoring_functions - - metadata - type: object + - $ref: '#/components/schemas/EvalTask' - type: 'null' description: OK tags: @@ -13378,10 +3956,7 @@ paths: application/json: schema: oneOf: - - enum: - - completed - - in_progress - type: string + - $ref: '#/components/schemas/JobStatus' - type: 'null' description: OK tags: @@ -13452,242 +4027,8 @@ paths: text/event-stream: schema: oneOf: - - additionalProperties: false - properties: - completion_message: - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - - items: - oneOf: - - type: string - - additionalProperties: false - properties: - image: - oneOf: - - additionalProperties: false - properties: - format: - type: string - format_description: - type: string - title: This class represents an image object. To - create - type: object - - additionalProperties: false - properties: - uri: - type: string - required: - - uri - type: object - required: - - image - type: object - type: array - role: - const: assistant - default: assistant - type: string - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - tool_calls: - items: - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - type: array - required: - - role - - content - - stop_reason - - tool_calls - type: object - logprobs: - items: - additionalProperties: false - properties: - logprobs_by_token: - additionalProperties: - type: number - type: object - required: - - logprobs_by_token - type: object - type: array - required: - - completion_message - title: Chat completion response. - type: object - - additionalProperties: false - properties: - event: - additionalProperties: false - properties: - delta: - oneOf: - - type: string - - additionalProperties: false - properties: - content: - oneOf: - - type: string - - additionalProperties: false - properties: - arguments: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - - items: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: array - - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: 'null' - type: object - type: object - call_id: - type: string - tool_name: - oneOf: - - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - type: string - - type: string - required: - - call_id - - tool_name - - arguments - type: object - parse_status: - enum: - - started - - in_progress - - failure - - success - type: string - required: - - content - - parse_status - type: object - event_type: - enum: - - start - - complete - - progress - type: string - logprobs: - items: - additionalProperties: false - properties: - logprobs_by_token: - additionalProperties: - type: number - type: object - required: - - logprobs_by_token - type: object - type: array - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - required: - - event_type - - delta - title: Chat completion response event. - type: object - required: - - event - title: SSE-stream of these events. - type: object + - $ref: '#/components/schemas/ChatCompletionResponse' + - $ref: '#/components/schemas/ChatCompletionResponseStreamChunk' description: Chat completion response. **OR** SSE-stream of these events. tags: - Inference @@ -13713,59 +4054,8 @@ paths: text/event-stream: schema: oneOf: - - additionalProperties: false - properties: - content: - type: string - logprobs: - items: - additionalProperties: false - properties: - logprobs_by_token: - additionalProperties: - type: number - type: object - required: - - logprobs_by_token - type: object - type: array - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - required: - - content - - stop_reason - title: Completion response. - type: object - - additionalProperties: false - properties: - delta: - type: string - logprobs: - items: - additionalProperties: false - properties: - logprobs_by_token: - additionalProperties: - type: number - type: object - required: - - logprobs_by_token - type: object - type: array - stop_reason: - enum: - - end_of_turn - - end_of_message - - out_of_tokens - type: string - required: - - delta - title: streamed completion response. - type: object + - $ref: '#/components/schemas/CompletionResponse' + - $ref: '#/components/schemas/CompletionResponseStreamChunk' description: Completion response. **OR** streamed completion response. tags: - Inference @@ -13816,106 +4106,10 @@ paths: schema: oneOf: - oneOf: - - additionalProperties: false - properties: - chunk_size_in_tokens: - type: integer - embedding_model: - type: string - identifier: - type: string - memory_bank_type: - const: vector - default: vector - type: string - overlap_size_in_tokens: - type: integer - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - - embedding_model - - chunk_size_in_tokens - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: keyvalue - default: keyvalue - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: keyword - default: keyword - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: graph - default: graph - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object + - $ref: '#/components/schemas/VectorMemoryBank' + - $ref: '#/components/schemas/KeyValueMemoryBank' + - $ref: '#/components/schemas/KeywordMemoryBank' + - $ref: '#/components/schemas/GraphMemoryBank' - type: 'null' description: OK tags: @@ -13936,106 +4130,10 @@ paths: application/jsonl: schema: oneOf: - - additionalProperties: false - properties: - chunk_size_in_tokens: - type: integer - embedding_model: - type: string - identifier: - type: string - memory_bank_type: - const: vector - default: vector - type: string - overlap_size_in_tokens: - type: integer - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - - embedding_model - - chunk_size_in_tokens - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: keyvalue - default: keyvalue - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: keyword - default: keyword - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object - - additionalProperties: false - properties: - identifier: - type: string - memory_bank_type: - const: graph - default: graph - type: string - provider_id: - type: string - provider_resource_id: - type: string - type: - const: memory_bank - default: memory_bank - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - memory_bank_type - type: object + - $ref: '#/components/schemas/VectorMemoryBank' + - $ref: '#/components/schemas/KeyValueMemoryBank' + - $ref: '#/components/schemas/KeywordMemoryBank' + - $ref: '#/components/schemas/GraphMemoryBank' description: OK tags: - MemoryBanks @@ -14146,35 +4244,7 @@ paths: application/json: schema: oneOf: - - additionalProperties: false - properties: - identifier: - type: string - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - provider_id: - type: string - provider_resource_id: - type: string - type: - const: model - default: model - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - metadata - type: object + - $ref: '#/components/schemas/Model' - type: 'null' description: OK tags: @@ -14422,16 +4492,7 @@ paths: application/json: schema: additionalProperties: - additionalProperties: false - properties: - provider_id: - type: string - provider_type: - type: string - required: - - provider_id - - provider_type - type: object + $ref: '#/components/schemas/ProviderInfo' type: object description: OK tags: @@ -14453,21 +4514,7 @@ paths: schema: additionalProperties: items: - additionalProperties: false - properties: - method: - type: string - provider_types: - items: - type: string - type: array - route: - type: string - required: - - route - - method - - provider_types - type: object + $ref: '#/components/schemas/RouteInfo' type: array type: object description: OK @@ -14519,163 +4566,7 @@ paths: application/json: schema: oneOf: - - additionalProperties: false - properties: - description: - type: string - identifier: - type: string - metadata: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - params: - oneOf: - - additionalProperties: false - properties: - judge_model: - type: string - judge_score_regexes: - items: - type: string - type: array - prompt_template: - type: string - type: - const: llm_as_judge - default: llm_as_judge - type: string - required: - - type - - judge_model - type: object - - additionalProperties: false - properties: - parsing_regexes: - items: - type: string - type: array - type: - const: regex_parser - default: regex_parser - type: string - required: - - type - type: object - provider_id: - type: string - provider_resource_id: - type: string - return_type: - oneOf: - - additionalProperties: false - properties: - type: - const: string - default: string - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: number - default: number - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: boolean - default: boolean - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: array - default: array - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: object - default: object - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: json - default: json - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: union - default: union - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: chat_completion_input - default: chat_completion_input - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: completion_input - default: completion_input - type: string - required: - - type - type: object - - additionalProperties: false - properties: - type: - const: agent_turn_input - default: agent_turn_input - type: string - required: - - type - type: object - type: - const: scoring_function - default: scoring_function - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - - metadata - - return_type - type: object + - $ref: '#/components/schemas/ScoringFn' - type: 'null' description: OK tags: @@ -14791,35 +4682,7 @@ paths: application/json: schema: oneOf: - - additionalProperties: false - properties: - identifier: - type: string - params: - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - type: object - provider_id: - type: string - provider_resource_id: - type: string - type: - const: shield - default: shield - type: string - required: - - identifier - - provider_resource_id - - provider_id - - type - title: A safety shield resource that can be used to check content - type: object + - $ref: '#/components/schemas/Shield' - type: 'null' description: OK tags: @@ -14943,6 +4806,10 @@ security: servers: - url: http://any-hosted-llama-stack.com tags: +- description: + name: AgentCandidate +- description: + name: AgentConfig - description: name: AgentCreateResponse @@ -14952,7 +4819,38 @@ tags: - description: name: AgentStepResponse +- description: 'Streamed agent execution response. + + + ' + name: AgentTurnResponseEvent +- description: + name: AgentTurnResponseStepCompletePayload +- description: + name: AgentTurnResponseStepProgressPayload +- description: + name: AgentTurnResponseStepStartPayload +- description: 'streamed agent turn completion response. + + + ' + name: AgentTurnResponseStreamChunk +- description: + name: AgentTurnResponseTurnCompletePayload +- description: + name: AgentTurnResponseTurnStartPayload - name: Agents +- description: + name: AppEvalTaskConfig +- description: + name: Attachment - description: name: BatchChatCompletionRequest @@ -14966,15 +4864,62 @@ tags: /> name: BatchCompletionResponse - name: BatchInference +- description: + name: BenchmarkEvalTaskConfig +- description: + name: BuiltinTool - description: name: CancelTrainingJobRequest - description: name: ChatCompletionRequest +- description: 'Chat completion response. + + + ' + name: ChatCompletionResponse +- description: 'Chat completion response event. + + + ' + name: ChatCompletionResponseEvent +- description: + name: ChatCompletionResponseEventType +- description: 'SSE-stream of these events. + + + ' + name: ChatCompletionResponseStreamChunk +- description: 'Checkpoint created during training runs + + + ' + name: Checkpoint +- description: + name: CodeInterpreterToolDefinition +- description: + name: CompletionMessage - description: name: CompletionRequest +- description: 'Completion response. + + + ' + name: CompletionResponse +- description: 'streamed completion response. + + + ' + name: CompletionResponseStreamChunk - description: name: CreateAgentRequest @@ -14984,6 +4929,9 @@ tags: - description: name: CreateAgentTurnRequest +- description: + name: DPOAlignmentConfig - description: name: Dataset - name: DatasetIO @@ -14994,6 +4942,9 @@ tags: - description: name: DeleteAgentsSessionRequest +- description: + name: DoraFinetuningConfig - description: name: EmbeddingsRequest @@ -15010,12 +4961,28 @@ tags: - description: name: EvaluateRowsRequest +- description: + name: FinetuningAlgorithm +- description: + name: FunctionCallToolDefinition - description: name: GetAgentsSessionRequest +- description: + name: GraphMemoryBank +- description: + name: GraphMemoryBankParams - description: name: HealthInfo +- description: + name: ImageMedia - name: Inference +- description: + name: InferenceStep - description: name: InsertDocumentsRequest @@ -15025,17 +4992,58 @@ tags: - description: name: JobCancelRequest +- description: + name: JobStatus +- description: + name: KeyValueMemoryBank +- description: + name: KeyValueMemoryBankParams +- description: + name: KeywordMemoryBank +- description: + name: KeywordMemoryBankParams +- description: + name: LLMAsJudgeScoringFnParams - description: name: LogEventRequest +- description: + name: LogSeverity +- description: + name: LoraFinetuningConfig - name: Memory +- description: + name: MemoryBankDocument - name: MemoryBanks +- description: + name: MemoryRetrievalStep +- description: + name: MemoryToolDefinition +- description: + name: MetricEvent - description: name: Model +- description: + name: ModelCandidate - name: Models +- description: + name: OptimizerConfig - description: name: PaginatedRowsResult +- description: + name: PhotogenToolDefinition - name: PostTraining - description: @@ -15051,6 +5059,9 @@ tags: ' name: PostTrainingJobLogStream +- description: + name: PostTrainingJobStatus - description: 'Status of a finetuning job. @@ -15060,12 +5071,22 @@ tags: - description: name: PreferenceOptimizeRequest +- description: + name: ProviderInfo +- description: + name: QLoraFinetuningConfig - description: name: QueryDocumentsRequest - description: name: QueryDocumentsResponse +- description: + name: RLHFAlgorithm +- description: + name: RegexParserScoringFnParams - description: name: RegisterDatasetRequest @@ -15084,6 +5105,13 @@ tags: - description: name: RegisterShieldRequest +- description: + name: RestAPIExecutionConfig +- description: + name: RestAPIMethod +- description: + name: RouteInfo - description: name: RunEvalRequest - description: name: RunShieldResponse - name: Safety +- description: + name: SafetyViolation +- description: + name: SamplingParams +- description: + name: SamplingStrategy - description: name: ScoreBatchRequest @@ -15107,6 +5143,11 @@ tags: - description: name: ScoringFn - name: ScoringFunctions +- description: + name: ScoringResult +- description: + name: SearchToolDefinition - description: 'A single session of an interaction with an Agentic System. @@ -15117,7 +5158,21 @@ tags: ' name: Shield +- description: + name: ShieldCallStep - name: Shields +- description: + name: SpanEndPayload +- description: + name: SpanStartPayload +- description: + name: SpanStatus +- description: + name: StopReason +- description: + name: StructuredLogEvent - description: name: SupervisedFineTuneRequest @@ -15132,20 +5187,77 @@ tags: ' name: SyntheticDataGenerationResponse +- description: + name: SystemMessage - name: Telemetry +- description: + name: TokenLogProbs +- description: + name: ToolCall +- description: + name: ToolCallDelta +- description: + name: ToolCallParseStatus +- description: + name: ToolChoice +- description: + name: ToolDefinition +- description: + name: ToolExecutionStep +- description: + name: ToolParamDefinition +- description: "This Enum refers to the prompt format for calling custom / zero shot\ + \ tools\n\n`json` --\n Refers to the json format for calling tools.\n The\ + \ json format takes the form like\n {\n \"type\": \"function\",\n \ + \ \"function\" : {\n \"name\": \"function_name\",\n \ + \ \"description\": \"function_description\",\n \"parameters\": {...}\n\ + \ }\n }\n\n`function_tag` --\n This is an example of how you could\ + \ define\n your own user defined format for making tool calls.\n The function_tag\ + \ format looks like this,\n (parameters)\n\ + \nThe detailed prompts for each of these formats are added to llama cli\n\n" + name: ToolPromptFormat +- description: + name: ToolResponse +- description: + name: ToolResponseMessage - description: name: Trace +- description: + name: TrainingConfig - description: 'A single turn in an interaction with an Agentic System. ' name: Turn +- description: + name: URL - description: name: UnregisterMemoryBankRequest - description: name: UnregisterModelRequest +- description: + name: UnstructuredLogEvent +- description: + name: UserMessage +- description: + name: VectorMemoryBank +- description: + name: VectorMemoryBankParams +- description: + name: ViolationLevel +- description: + name: WolframAlphaToolDefinition x-tagGroups: - name: Operations tags: @@ -15169,62 +5281,146 @@ x-tagGroups: - Telemetry - name: Types tags: + - AgentCandidate + - AgentConfig - AgentCreateResponse - AgentSessionCreateResponse - AgentStepResponse + - AgentTurnResponseEvent + - AgentTurnResponseStepCompletePayload + - AgentTurnResponseStepProgressPayload + - AgentTurnResponseStepStartPayload + - AgentTurnResponseStreamChunk + - AgentTurnResponseTurnCompletePayload + - AgentTurnResponseTurnStartPayload + - AppEvalTaskConfig + - Attachment - BatchChatCompletionRequest - BatchChatCompletionResponse - BatchCompletionRequest - BatchCompletionResponse + - BenchmarkEvalTaskConfig + - BuiltinTool - CancelTrainingJobRequest - ChatCompletionRequest + - ChatCompletionResponse + - ChatCompletionResponseEvent + - ChatCompletionResponseEventType + - ChatCompletionResponseStreamChunk + - Checkpoint + - CodeInterpreterToolDefinition + - CompletionMessage - CompletionRequest + - CompletionResponse + - CompletionResponseStreamChunk - CreateAgentRequest - CreateAgentSessionRequest - CreateAgentTurnRequest + - DPOAlignmentConfig - Dataset - DeleteAgentsRequest - DeleteAgentsSessionRequest + - DoraFinetuningConfig - EmbeddingsRequest - EmbeddingsResponse - EvalTask - EvaluateResponse - EvaluateRowsRequest + - FinetuningAlgorithm + - FunctionCallToolDefinition - GetAgentsSessionRequest + - GraphMemoryBank + - GraphMemoryBankParams - HealthInfo + - ImageMedia + - InferenceStep - InsertDocumentsRequest - Job - JobCancelRequest + - JobStatus + - KeyValueMemoryBank + - KeyValueMemoryBankParams + - KeywordMemoryBank + - KeywordMemoryBankParams + - LLMAsJudgeScoringFnParams - LogEventRequest + - LogSeverity + - LoraFinetuningConfig + - MemoryBankDocument + - MemoryRetrievalStep + - MemoryToolDefinition + - MetricEvent - Model + - ModelCandidate + - OptimizerConfig - PaginatedRowsResult + - PhotogenToolDefinition - PostTrainingJob - PostTrainingJobArtifactsResponse - PostTrainingJobLogStream + - PostTrainingJobStatus - PostTrainingJobStatusResponse - PreferenceOptimizeRequest + - ProviderInfo + - QLoraFinetuningConfig - QueryDocumentsRequest - QueryDocumentsResponse + - RLHFAlgorithm + - RegexParserScoringFnParams - RegisterDatasetRequest - RegisterEvalTaskRequest - RegisterMemoryBankRequest - RegisterModelRequest - RegisterScoringFunctionRequest - RegisterShieldRequest + - RestAPIExecutionConfig + - RestAPIMethod + - RouteInfo - RunEvalRequest - RunShieldRequest - RunShieldResponse + - SafetyViolation + - SamplingParams + - SamplingStrategy - ScoreBatchRequest - ScoreBatchResponse - ScoreRequest - ScoreResponse - ScoringFn + - ScoringResult + - SearchToolDefinition - Session - Shield + - ShieldCallStep + - SpanEndPayload + - SpanStartPayload + - SpanStatus + - StopReason + - StructuredLogEvent - SupervisedFineTuneRequest - SyntheticDataGenerateRequest - SyntheticDataGenerationResponse + - SystemMessage + - TokenLogProbs + - ToolCall + - ToolCallDelta + - ToolCallParseStatus + - ToolChoice + - ToolDefinition + - ToolExecutionStep + - ToolParamDefinition + - ToolPromptFormat + - ToolResponse + - ToolResponseMessage - Trace + - TrainingConfig - Turn + - URL - UnregisterMemoryBankRequest - UnregisterModelRequest + - UnstructuredLogEvent + - UserMessage + - VectorMemoryBank + - VectorMemoryBankParams + - ViolationLevel + - WolframAlphaToolDefinition diff --git a/llama_stack/apis/version.py b/llama_stack/apis/version.py new file mode 100644 index 000000000..f178712ba --- /dev/null +++ b/llama_stack/apis/version.py @@ -0,0 +1,7 @@ +# Copyright (c) Meta Platforms, Inc. and affiliates. +# All rights reserved. +# +# This source code is licensed under the terms described in the LICENSE file in +# the root directory of this source tree. + +LLAMA_STACK_API_VERSION = "alpha"