mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-06-28 02:53:30 +00:00
0850ad656a
The semantics of an Update on resources is very tricky to reason about especially for memory banks and models. The best way to go forward here is for the user to unregister and register a new resource. We don't have a compelling reason to support update APIs. Tests: pytest -v -s llama_stack/providers/tests/memory/test_memory.py -m "chroma" --env CHROMA_HOST=localhost --env CHROMA_PORT=8000 pytest -v -s llama_stack/providers/tests/memory/test_memory.py -m "pgvector" --env PGVECTOR_DB=postgres --env PGVECTOR_USER=postgres --env PGVECTOR_PASSWORD=mysecretpassword --env PGVECTOR_HOST=0.0.0.0 $CONDA_PREFIX/bin/pytest -v -s -m "ollama" llama_stack/providers/tests/inference/test_model_registration.py --------- Co-authored-by: Dinesh Yeduguru <dineshyv@fb.com>
5426 lines
144 KiB
YAML
5426 lines
144 KiB
YAML
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:
|
|
agent_id:
|
|
type: string
|
|
required:
|
|
- agent_id
|
|
type: object
|
|
AgentSessionCreateResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
session_id:
|
|
type: string
|
|
required:
|
|
- session_id
|
|
type: object
|
|
AgentStepResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
step:
|
|
oneOf:
|
|
- $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:
|
|
logprobs:
|
|
additionalProperties: false
|
|
properties:
|
|
top_k:
|
|
default: 0
|
|
type: integer
|
|
type: object
|
|
messages_batch:
|
|
items:
|
|
items:
|
|
oneOf:
|
|
- $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:
|
|
$ref: '#/components/schemas/SamplingParams'
|
|
tool_choice:
|
|
$ref: '#/components/schemas/ToolChoice'
|
|
tool_prompt_format:
|
|
$ref: '#/components/schemas/ToolPromptFormat'
|
|
tools:
|
|
items:
|
|
$ref: '#/components/schemas/ToolDefinition'
|
|
type: array
|
|
required:
|
|
- model
|
|
- messages_batch
|
|
type: object
|
|
BatchChatCompletionResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
completion_message_batch:
|
|
items:
|
|
$ref: '#/components/schemas/CompletionMessage'
|
|
type: array
|
|
required:
|
|
- completion_message_batch
|
|
type: object
|
|
BatchCompletionRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
content_batch:
|
|
items:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
- items:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
type: array
|
|
type: array
|
|
logprobs:
|
|
additionalProperties: false
|
|
properties:
|
|
top_k:
|
|
default: 0
|
|
type: integer
|
|
type: object
|
|
model:
|
|
type: string
|
|
sampling_params:
|
|
$ref: '#/components/schemas/SamplingParams'
|
|
required:
|
|
- model
|
|
- content_batch
|
|
type: object
|
|
BatchCompletionResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
completion_message_batch:
|
|
items:
|
|
$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:
|
|
job_uuid:
|
|
type: string
|
|
required:
|
|
- job_uuid
|
|
type: object
|
|
ChatCompletionRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
logprobs:
|
|
additionalProperties: false
|
|
properties:
|
|
top_k:
|
|
default: 0
|
|
type: integer
|
|
type: object
|
|
messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/UserMessage'
|
|
- $ref: '#/components/schemas/SystemMessage'
|
|
- $ref: '#/components/schemas/ToolResponseMessage'
|
|
- $ref: '#/components/schemas/CompletionMessage'
|
|
type: array
|
|
model_id:
|
|
type: string
|
|
response_format:
|
|
oneOf:
|
|
- additionalProperties: false
|
|
properties:
|
|
json_schema:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type:
|
|
const: json_schema
|
|
default: json_schema
|
|
type: string
|
|
required:
|
|
- type
|
|
- json_schema
|
|
type: object
|
|
- additionalProperties: false
|
|
properties:
|
|
bnf:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type:
|
|
const: grammar
|
|
default: grammar
|
|
type: string
|
|
required:
|
|
- type
|
|
- bnf
|
|
type: object
|
|
sampling_params:
|
|
$ref: '#/components/schemas/SamplingParams'
|
|
stream:
|
|
type: boolean
|
|
tool_choice:
|
|
$ref: '#/components/schemas/ToolChoice'
|
|
tool_prompt_format:
|
|
$ref: '#/components/schemas/ToolPromptFormat'
|
|
tools:
|
|
items:
|
|
$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
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
- items:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
type: array
|
|
logprobs:
|
|
additionalProperties: false
|
|
properties:
|
|
top_k:
|
|
default: 0
|
|
type: integer
|
|
type: object
|
|
model_id:
|
|
type: string
|
|
response_format:
|
|
oneOf:
|
|
- additionalProperties: false
|
|
properties:
|
|
json_schema:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type:
|
|
const: json_schema
|
|
default: json_schema
|
|
type: string
|
|
required:
|
|
- type
|
|
- json_schema
|
|
type: object
|
|
- additionalProperties: false
|
|
properties:
|
|
bnf:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type:
|
|
const: grammar
|
|
default: grammar
|
|
type: string
|
|
required:
|
|
- type
|
|
- bnf
|
|
type: object
|
|
sampling_params:
|
|
$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:
|
|
$ref: '#/components/schemas/AgentConfig'
|
|
required:
|
|
- agent_config
|
|
type: object
|
|
CreateAgentSessionRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
agent_id:
|
|
type: string
|
|
session_name:
|
|
type: string
|
|
required:
|
|
- agent_id
|
|
- session_name
|
|
type: object
|
|
CreateAgentTurnRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
agent_id:
|
|
type: string
|
|
attachments:
|
|
items:
|
|
$ref: '#/components/schemas/Attachment'
|
|
type: array
|
|
messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/UserMessage'
|
|
- $ref: '#/components/schemas/ToolResponseMessage'
|
|
type: array
|
|
session_id:
|
|
type: string
|
|
stream:
|
|
type: boolean
|
|
required:
|
|
- agent_id
|
|
- 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:
|
|
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:
|
|
$ref: '#/components/schemas/URL'
|
|
required:
|
|
- identifier
|
|
- provider_resource_id
|
|
- provider_id
|
|
- type
|
|
- dataset_schema
|
|
- url
|
|
- metadata
|
|
type: object
|
|
DeleteAgentsRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
agent_id:
|
|
type: string
|
|
required:
|
|
- agent_id
|
|
type: object
|
|
DeleteAgentsSessionRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
agent_id:
|
|
type: string
|
|
session_id:
|
|
type: string
|
|
required:
|
|
- 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:
|
|
contents:
|
|
items:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
- items:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
type: array
|
|
type: array
|
|
model_id:
|
|
type: string
|
|
required:
|
|
- model_id
|
|
- contents
|
|
type: object
|
|
EmbeddingsResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
embeddings:
|
|
items:
|
|
items:
|
|
type: number
|
|
type: array
|
|
type: array
|
|
required:
|
|
- embeddings
|
|
type: object
|
|
EvalTask:
|
|
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
|
|
EvaluateResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
generations:
|
|
items:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type: array
|
|
scores:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ScoringResult'
|
|
type: object
|
|
required:
|
|
- generations
|
|
- scores
|
|
type: object
|
|
EvaluateRowsRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
input_rows:
|
|
items:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type: array
|
|
scoring_functions:
|
|
items:
|
|
type: string
|
|
type: array
|
|
task_config:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/BenchmarkEvalTaskConfig'
|
|
- $ref: '#/components/schemas/AppEvalTaskConfig'
|
|
task_id:
|
|
type: string
|
|
required:
|
|
- task_id
|
|
- input_rows
|
|
- 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:
|
|
turn_ids:
|
|
items:
|
|
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:
|
|
status:
|
|
type: string
|
|
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:
|
|
bank_id:
|
|
type: string
|
|
documents:
|
|
items:
|
|
$ref: '#/components/schemas/MemoryBankDocument'
|
|
type: array
|
|
ttl_seconds:
|
|
type: integer
|
|
required:
|
|
- bank_id
|
|
- documents
|
|
type: object
|
|
Job:
|
|
additionalProperties: false
|
|
properties:
|
|
job_id:
|
|
type: string
|
|
required:
|
|
- job_id
|
|
type: object
|
|
JobCancelRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
job_id:
|
|
type: string
|
|
task_id:
|
|
type: string
|
|
required:
|
|
- 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:
|
|
- $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:
|
|
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
|
|
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:
|
|
next_page_token:
|
|
type: string
|
|
rows:
|
|
items:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type: array
|
|
total_count:
|
|
type: integer
|
|
required:
|
|
- 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:
|
|
job_uuid:
|
|
type: string
|
|
required:
|
|
- job_uuid
|
|
type: object
|
|
PostTrainingJobArtifactsResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
checkpoints:
|
|
items:
|
|
$ref: '#/components/schemas/Checkpoint'
|
|
type: array
|
|
job_uuid:
|
|
type: string
|
|
required:
|
|
- job_uuid
|
|
- checkpoints
|
|
title: Artifacts of a finetuning job.
|
|
type: object
|
|
PostTrainingJobLogStream:
|
|
additionalProperties: false
|
|
properties:
|
|
job_uuid:
|
|
type: string
|
|
log_lines:
|
|
items:
|
|
type: string
|
|
type: array
|
|
required:
|
|
- job_uuid
|
|
- 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:
|
|
$ref: '#/components/schemas/Checkpoint'
|
|
type: array
|
|
completed_at:
|
|
format: date-time
|
|
type: string
|
|
job_uuid:
|
|
type: string
|
|
resources_allocated:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
scheduled_at:
|
|
format: date-time
|
|
type: string
|
|
started_at:
|
|
format: date-time
|
|
type: string
|
|
status:
|
|
$ref: '#/components/schemas/PostTrainingJobStatus'
|
|
required:
|
|
- job_uuid
|
|
- status
|
|
- checkpoints
|
|
title: Status of a finetuning job.
|
|
type: object
|
|
PreferenceOptimizeRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
algorithm:
|
|
$ref: '#/components/schemas/RLHFAlgorithm'
|
|
algorithm_config:
|
|
$ref: '#/components/schemas/DPOAlignmentConfig'
|
|
dataset_id:
|
|
type: string
|
|
finetuned_model:
|
|
$ref: '#/components/schemas/URL'
|
|
hyperparam_search_config:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
job_uuid:
|
|
type: string
|
|
logger_config:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
optimizer_config:
|
|
$ref: '#/components/schemas/OptimizerConfig'
|
|
training_config:
|
|
$ref: '#/components/schemas/TrainingConfig'
|
|
validation_dataset_id:
|
|
type: string
|
|
required:
|
|
- job_uuid
|
|
- finetuned_model
|
|
- dataset_id
|
|
- validation_dataset_id
|
|
- algorithm
|
|
- algorithm_config
|
|
- optimizer_config
|
|
- training_config
|
|
- 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:
|
|
bank_id:
|
|
type: string
|
|
params:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
query:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
- items:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
type: array
|
|
required:
|
|
- bank_id
|
|
- query
|
|
type: object
|
|
QueryDocumentsResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
chunks:
|
|
items:
|
|
additionalProperties: false
|
|
properties:
|
|
content:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
- items:
|
|
oneOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ImageMedia'
|
|
type: array
|
|
document_id:
|
|
type: string
|
|
token_count:
|
|
type: integer
|
|
required:
|
|
- content
|
|
- token_count
|
|
- document_id
|
|
type: object
|
|
type: array
|
|
scores:
|
|
items:
|
|
type: number
|
|
type: array
|
|
required:
|
|
- 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:
|
|
dataset_id:
|
|
type: string
|
|
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
|
|
metadata:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
provider_dataset_id:
|
|
type: string
|
|
provider_id:
|
|
type: string
|
|
url:
|
|
$ref: '#/components/schemas/URL'
|
|
required:
|
|
- dataset_id
|
|
- dataset_schema
|
|
- url
|
|
type: object
|
|
RegisterEvalTaskRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
dataset_id:
|
|
type: string
|
|
eval_task_id:
|
|
type: string
|
|
metadata:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
provider_eval_task_id:
|
|
type: string
|
|
provider_id:
|
|
type: string
|
|
scoring_functions:
|
|
items:
|
|
type: string
|
|
type: array
|
|
required:
|
|
- eval_task_id
|
|
- dataset_id
|
|
- scoring_functions
|
|
type: object
|
|
RegisterMemoryBankRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
memory_bank_id:
|
|
type: string
|
|
params:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/VectorMemoryBankParams'
|
|
- $ref: '#/components/schemas/KeyValueMemoryBankParams'
|
|
- $ref: '#/components/schemas/KeywordMemoryBankParams'
|
|
- $ref: '#/components/schemas/GraphMemoryBankParams'
|
|
provider_id:
|
|
type: string
|
|
provider_memory_bank_id:
|
|
type: string
|
|
required:
|
|
- memory_bank_id
|
|
- params
|
|
type: object
|
|
RegisterModelRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
metadata:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
model_id:
|
|
type: string
|
|
provider_id:
|
|
type: string
|
|
provider_model_id:
|
|
type: string
|
|
required:
|
|
- model_id
|
|
type: object
|
|
RegisterScoringFunctionRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
description:
|
|
type: string
|
|
params:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
provider_id:
|
|
type: string
|
|
provider_scoring_fn_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
|
|
scoring_fn_id:
|
|
type: string
|
|
required:
|
|
- scoring_fn_id
|
|
- description
|
|
- return_type
|
|
type: object
|
|
RegisterShieldRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
params:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
provider_id:
|
|
type: string
|
|
provider_shield_id:
|
|
type: string
|
|
shield_id:
|
|
type: string
|
|
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:
|
|
- $ref: '#/components/schemas/BenchmarkEvalTaskConfig'
|
|
- $ref: '#/components/schemas/AppEvalTaskConfig'
|
|
task_id:
|
|
type: string
|
|
required:
|
|
- task_id
|
|
- task_config
|
|
type: object
|
|
RunShieldRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/UserMessage'
|
|
- $ref: '#/components/schemas/SystemMessage'
|
|
- $ref: '#/components/schemas/ToolResponseMessage'
|
|
- $ref: '#/components/schemas/CompletionMessage'
|
|
type: array
|
|
params:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
shield_id:
|
|
type: string
|
|
required:
|
|
- shield_id
|
|
- messages
|
|
- params
|
|
type: object
|
|
RunShieldResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
violation:
|
|
$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:
|
|
dataset_id:
|
|
type: string
|
|
save_results_dataset:
|
|
type: boolean
|
|
scoring_functions:
|
|
additionalProperties:
|
|
oneOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- dataset_id
|
|
- scoring_functions
|
|
- save_results_dataset
|
|
type: object
|
|
ScoreBatchResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
dataset_id:
|
|
type: string
|
|
results:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ScoringResult'
|
|
type: object
|
|
required:
|
|
- results
|
|
type: object
|
|
ScoreRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
input_rows:
|
|
items:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type: array
|
|
scoring_functions:
|
|
additionalProperties:
|
|
oneOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- input_rows
|
|
- scoring_functions
|
|
type: object
|
|
ScoreResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
results:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ScoringResult'
|
|
type: object
|
|
required:
|
|
- results
|
|
type: object
|
|
ScoringFn:
|
|
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:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
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
|
|
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:
|
|
- $ref: '#/components/schemas/VectorMemoryBank'
|
|
- $ref: '#/components/schemas/KeyValueMemoryBank'
|
|
- $ref: '#/components/schemas/KeywordMemoryBank'
|
|
- $ref: '#/components/schemas/GraphMemoryBank'
|
|
session_id:
|
|
type: string
|
|
session_name:
|
|
type: string
|
|
started_at:
|
|
format: date-time
|
|
type: string
|
|
turns:
|
|
items:
|
|
$ref: '#/components/schemas/Turn'
|
|
type: array
|
|
required:
|
|
- session_id
|
|
- session_name
|
|
- turns
|
|
- started_at
|
|
title: A single session of an interaction with an Agentic System.
|
|
type: object
|
|
Shield:
|
|
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
|
|
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:
|
|
$ref: '#/components/schemas/FinetuningAlgorithm'
|
|
algorithm_config:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/LoraFinetuningConfig'
|
|
- $ref: '#/components/schemas/QLoraFinetuningConfig'
|
|
- $ref: '#/components/schemas/DoraFinetuningConfig'
|
|
dataset_id:
|
|
type: string
|
|
hyperparam_search_config:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
job_uuid:
|
|
type: string
|
|
logger_config:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
model:
|
|
type: string
|
|
optimizer_config:
|
|
$ref: '#/components/schemas/OptimizerConfig'
|
|
training_config:
|
|
$ref: '#/components/schemas/TrainingConfig'
|
|
validation_dataset_id:
|
|
type: string
|
|
required:
|
|
- job_uuid
|
|
- model
|
|
- dataset_id
|
|
- validation_dataset_id
|
|
- algorithm
|
|
- algorithm_config
|
|
- optimizer_config
|
|
- training_config
|
|
- hyperparam_search_config
|
|
- logger_config
|
|
type: object
|
|
SyntheticDataGenerateRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
dialogs:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/UserMessage'
|
|
- $ref: '#/components/schemas/SystemMessage'
|
|
- $ref: '#/components/schemas/ToolResponseMessage'
|
|
- $ref: '#/components/schemas/CompletionMessage'
|
|
type: array
|
|
filtering_function:
|
|
enum:
|
|
- none
|
|
- random
|
|
- top_k
|
|
- top_p
|
|
- top_k_top_p
|
|
- sigmoid
|
|
title: The type of filtering function.
|
|
type: string
|
|
model:
|
|
type: string
|
|
required:
|
|
- dialogs
|
|
- filtering_function
|
|
type: object
|
|
SyntheticDataGenerationResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
statistics:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
synthetic_data:
|
|
items:
|
|
additionalProperties:
|
|
oneOf:
|
|
- type: 'null'
|
|
- type: boolean
|
|
- type: number
|
|
- type: string
|
|
- type: array
|
|
- type: object
|
|
type: object
|
|
type: array
|
|
required:
|
|
- synthetic_data
|
|
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 <function=function_name>(parameters)</function>\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:
|
|
end_time:
|
|
format: date-time
|
|
type: string
|
|
root_span_id:
|
|
type: string
|
|
start_time:
|
|
format: date-time
|
|
type: string
|
|
trace_id:
|
|
type: string
|
|
required:
|
|
- trace_id
|
|
- 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:
|
|
completed_at:
|
|
format: date-time
|
|
type: string
|
|
input_messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/UserMessage'
|
|
- $ref: '#/components/schemas/ToolResponseMessage'
|
|
type: array
|
|
output_attachments:
|
|
items:
|
|
$ref: '#/components/schemas/Attachment'
|
|
type: array
|
|
output_message:
|
|
$ref: '#/components/schemas/CompletionMessage'
|
|
session_id:
|
|
type: string
|
|
started_at:
|
|
format: date-time
|
|
type: string
|
|
steps:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/InferenceStep'
|
|
- $ref: '#/components/schemas/ToolExecutionStep'
|
|
- $ref: '#/components/schemas/ShieldCallStep'
|
|
- $ref: '#/components/schemas/MemoryRetrievalStep'
|
|
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
|
|
URL:
|
|
format: uri
|
|
pattern: ^(https?://|file://|data:)
|
|
type: string
|
|
UnregisterMemoryBankRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
memory_bank_id:
|
|
type: string
|
|
required:
|
|
- memory_bank_id
|
|
type: object
|
|
UnregisterModelRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
model_id:
|
|
type: string
|
|
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-14 17:04:24.301559"
|
|
title: '[DRAFT] Llama Stack Specification'
|
|
version: 0.0.1
|
|
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
|
|
openapi: 3.1.0
|
|
paths:
|
|
/agents/create:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateAgentRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AgentCreateResponse'
|
|
description: OK
|
|
tags:
|
|
- Agents
|
|
/agents/delete:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DeleteAgentsRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- Agents
|
|
/agents/session/create:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateAgentSessionRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AgentSessionCreateResponse'
|
|
description: OK
|
|
tags:
|
|
- Agents
|
|
/agents/session/delete:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DeleteAgentsSessionRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- Agents
|
|
/agents/session/get:
|
|
post:
|
|
parameters:
|
|
- in: query
|
|
name: agent_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: session_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetAgentsSessionRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Session'
|
|
description: OK
|
|
tags:
|
|
- Agents
|
|
/agents/step/get:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: agent_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: session_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: turn_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: step_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AgentStepResponse'
|
|
description: OK
|
|
tags:
|
|
- Agents
|
|
/agents/turn/create:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateAgentTurnRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
text/event-stream:
|
|
schema:
|
|
oneOf:
|
|
- $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:
|
|
- Agents
|
|
/agents/turn/get:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: agent_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: session_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: turn_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Turn'
|
|
description: OK
|
|
tags:
|
|
- Agents
|
|
/batch_inference/chat_completion:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/BatchChatCompletionRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/BatchChatCompletionResponse'
|
|
description: OK
|
|
tags:
|
|
- BatchInference
|
|
/batch_inference/completion:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/BatchCompletionRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/BatchCompletionResponse'
|
|
description: OK
|
|
tags:
|
|
- BatchInference
|
|
/datasetio/get_rows_paginated:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: dataset_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: rows_in_page
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: page_token
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: filter_condition
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedRowsResult'
|
|
description: OK
|
|
tags:
|
|
- DatasetIO
|
|
/datasets/get:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: dataset_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/Dataset'
|
|
- type: 'null'
|
|
description: OK
|
|
tags:
|
|
- Datasets
|
|
/datasets/list:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/jsonl:
|
|
schema:
|
|
$ref: '#/components/schemas/Dataset'
|
|
description: OK
|
|
tags:
|
|
- Datasets
|
|
/datasets/register:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterDatasetRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- Datasets
|
|
/eval/evaluate_rows:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EvaluateRowsRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EvaluateResponse'
|
|
description: OK
|
|
tags:
|
|
- Eval
|
|
/eval/job/cancel:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/JobCancelRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- Eval
|
|
/eval/job/result:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: task_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: job_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EvaluateResponse'
|
|
description: OK
|
|
tags:
|
|
- Eval
|
|
/eval/job/status:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: task_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: job_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/JobStatus'
|
|
- type: 'null'
|
|
description: OK
|
|
tags:
|
|
- Eval
|
|
/eval/run_eval:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RunEvalRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Job'
|
|
description: OK
|
|
tags:
|
|
- Eval
|
|
/eval_tasks/get:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/EvalTask'
|
|
- type: 'null'
|
|
description: OK
|
|
tags:
|
|
- EvalTasks
|
|
/eval_tasks/list:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/jsonl:
|
|
schema:
|
|
$ref: '#/components/schemas/EvalTask'
|
|
description: OK
|
|
tags:
|
|
- EvalTasks
|
|
/eval_tasks/register:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterEvalTaskRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- EvalTasks
|
|
/health:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HealthInfo'
|
|
description: OK
|
|
tags:
|
|
- Inspect
|
|
/inference/chat_completion:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ChatCompletionRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
text/event-stream:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ChatCompletionResponse'
|
|
- $ref: '#/components/schemas/ChatCompletionResponseStreamChunk'
|
|
description: Chat completion response. **OR** SSE-stream of these events.
|
|
tags:
|
|
- Inference
|
|
/inference/completion:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CompletionRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
text/event-stream:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/CompletionResponse'
|
|
- $ref: '#/components/schemas/CompletionResponseStreamChunk'
|
|
description: Completion response. **OR** streamed completion response.
|
|
tags:
|
|
- Inference
|
|
/inference/embeddings:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EmbeddingsRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EmbeddingsResponse'
|
|
description: OK
|
|
tags:
|
|
- Inference
|
|
/memory/insert:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/InsertDocumentsRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- Memory
|
|
/memory/query:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/QueryDocumentsRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/QueryDocumentsResponse'
|
|
description: OK
|
|
tags:
|
|
- Memory
|
|
/memory_banks/get:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: memory_bank_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/VectorMemoryBank'
|
|
- $ref: '#/components/schemas/KeyValueMemoryBank'
|
|
- $ref: '#/components/schemas/KeywordMemoryBank'
|
|
- $ref: '#/components/schemas/GraphMemoryBank'
|
|
- type: 'null'
|
|
description: OK
|
|
tags:
|
|
- MemoryBanks
|
|
/memory_banks/list:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/jsonl:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/VectorMemoryBank'
|
|
- $ref: '#/components/schemas/KeyValueMemoryBank'
|
|
- $ref: '#/components/schemas/KeywordMemoryBank'
|
|
- $ref: '#/components/schemas/GraphMemoryBank'
|
|
description: OK
|
|
tags:
|
|
- MemoryBanks
|
|
/memory_banks/register:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterMemoryBankRequest'
|
|
required: true
|
|
responses: {}
|
|
tags:
|
|
- MemoryBanks
|
|
/memory_banks/unregister:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UnregisterMemoryBankRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- MemoryBanks
|
|
/models/get:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: identifier
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/Model'
|
|
- type: 'null'
|
|
description: OK
|
|
tags:
|
|
- Models
|
|
/models/list:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/jsonl:
|
|
schema:
|
|
$ref: '#/components/schemas/Model'
|
|
description: OK
|
|
tags:
|
|
- Models
|
|
/models/register:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterModelRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Model'
|
|
description: OK
|
|
tags:
|
|
- Models
|
|
/models/unregister:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UnregisterModelRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- Models
|
|
/post_training/job/artifacts:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: job_uuid
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PostTrainingJobArtifactsResponse'
|
|
description: OK
|
|
tags:
|
|
- PostTraining
|
|
/post_training/job/cancel:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CancelTrainingJobRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- PostTraining
|
|
/post_training/job/logs:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: job_uuid
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PostTrainingJobLogStream'
|
|
description: OK
|
|
tags:
|
|
- PostTraining
|
|
/post_training/job/status:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: job_uuid
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PostTrainingJobStatusResponse'
|
|
description: OK
|
|
tags:
|
|
- PostTraining
|
|
/post_training/jobs:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/jsonl:
|
|
schema:
|
|
$ref: '#/components/schemas/PostTrainingJob'
|
|
description: OK
|
|
tags:
|
|
- PostTraining
|
|
/post_training/preference_optimize:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PreferenceOptimizeRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PostTrainingJob'
|
|
description: OK
|
|
tags:
|
|
- PostTraining
|
|
/post_training/supervised_fine_tune:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SupervisedFineTuneRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PostTrainingJob'
|
|
description: OK
|
|
tags:
|
|
- PostTraining
|
|
/providers/list:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ProviderInfo'
|
|
type: object
|
|
description: OK
|
|
tags:
|
|
- Inspect
|
|
/routes/list:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
additionalProperties:
|
|
items:
|
|
$ref: '#/components/schemas/RouteInfo'
|
|
type: array
|
|
type: object
|
|
description: OK
|
|
tags:
|
|
- Inspect
|
|
/safety/run_shield:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RunShieldRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RunShieldResponse'
|
|
description: OK
|
|
tags:
|
|
- Safety
|
|
/scoring/score:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoreRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoreResponse'
|
|
description: OK
|
|
tags:
|
|
- Scoring
|
|
/scoring/score_batch:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoreBatchRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoreBatchResponse'
|
|
description: OK
|
|
tags:
|
|
- Scoring
|
|
/scoring_functions/get:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: scoring_fn_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ScoringFn'
|
|
- type: 'null'
|
|
description: OK
|
|
tags:
|
|
- ScoringFunctions
|
|
/scoring_functions/list:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/jsonl:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoringFn'
|
|
description: OK
|
|
tags:
|
|
- ScoringFunctions
|
|
/scoring_functions/register:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterScoringFunctionRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- ScoringFunctions
|
|
/shields/get:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: identifier
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/Shield'
|
|
- type: 'null'
|
|
description: OK
|
|
tags:
|
|
- Shields
|
|
/shields/list:
|
|
get:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/jsonl:
|
|
schema:
|
|
$ref: '#/components/schemas/Shield'
|
|
description: OK
|
|
tags:
|
|
- Shields
|
|
/shields/register:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterShieldRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Shield'
|
|
description: OK
|
|
tags:
|
|
- Shields
|
|
/synthetic_data_generation/generate:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SyntheticDataGenerateRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SyntheticDataGenerationResponse'
|
|
description: OK
|
|
tags:
|
|
- SyntheticDataGeneration
|
|
/telemetry/get_trace:
|
|
get:
|
|
parameters:
|
|
- in: query
|
|
name: trace_id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Trace'
|
|
description: OK
|
|
tags:
|
|
- Telemetry
|
|
/telemetry/log_event:
|
|
post:
|
|
parameters:
|
|
- description: JSON-encoded provider data which will be made available to the
|
|
adapter servicing the API
|
|
in: header
|
|
name: X-LlamaStack-ProviderData
|
|
required: false
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/LogEventRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
tags:
|
|
- Telemetry
|
|
security:
|
|
- Default: []
|
|
servers:
|
|
- url: http://any-hosted-llama-stack.com
|
|
tags:
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentCandidate" />
|
|
name: AgentCandidate
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentConfig" />
|
|
name: AgentConfig
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentCreateResponse"
|
|
/>
|
|
name: AgentCreateResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentSessionCreateResponse"
|
|
/>
|
|
name: AgentSessionCreateResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentStepResponse"
|
|
/>
|
|
name: AgentStepResponse
|
|
- description: 'Streamed agent execution response.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseEvent" />'
|
|
name: AgentTurnResponseEvent
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseStepCompletePayload"
|
|
/>
|
|
name: AgentTurnResponseStepCompletePayload
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseStepProgressPayload"
|
|
/>
|
|
name: AgentTurnResponseStepProgressPayload
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseStepStartPayload"
|
|
/>
|
|
name: AgentTurnResponseStepStartPayload
|
|
- description: 'streamed agent turn completion response.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseStreamChunk"
|
|
/>'
|
|
name: AgentTurnResponseStreamChunk
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseTurnCompletePayload"
|
|
/>
|
|
name: AgentTurnResponseTurnCompletePayload
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentTurnResponseTurnStartPayload"
|
|
/>
|
|
name: AgentTurnResponseTurnStartPayload
|
|
- name: Agents
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/AppEvalTaskConfig"
|
|
/>
|
|
name: AppEvalTaskConfig
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/Attachment" />
|
|
name: Attachment
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionRequest"
|
|
/>
|
|
name: BatchChatCompletionRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionResponse"
|
|
/>
|
|
name: BatchChatCompletionResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionRequest"
|
|
/>
|
|
name: BatchCompletionRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionResponse"
|
|
/>
|
|
name: BatchCompletionResponse
|
|
- name: BatchInference
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/BenchmarkEvalTaskConfig"
|
|
/>
|
|
name: BenchmarkEvalTaskConfig
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/BuiltinTool" />
|
|
name: BuiltinTool
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/CancelTrainingJobRequest"
|
|
/>
|
|
name: CancelTrainingJobRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionRequest"
|
|
/>
|
|
name: ChatCompletionRequest
|
|
- description: 'Chat completion response.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponse" />'
|
|
name: ChatCompletionResponse
|
|
- description: 'Chat completion response event.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseEvent"
|
|
/>'
|
|
name: ChatCompletionResponseEvent
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseEventType"
|
|
/>
|
|
name: ChatCompletionResponseEventType
|
|
- description: 'SSE-stream of these events.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/ChatCompletionResponseStreamChunk"
|
|
/>'
|
|
name: ChatCompletionResponseStreamChunk
|
|
- description: 'Checkpoint created during training runs
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/Checkpoint" />'
|
|
name: Checkpoint
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/CodeInterpreterToolDefinition"
|
|
/>
|
|
name: CodeInterpreterToolDefinition
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionMessage"
|
|
/>
|
|
name: CompletionMessage
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionRequest"
|
|
/>
|
|
name: CompletionRequest
|
|
- description: 'Completion response.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/CompletionResponse" />'
|
|
name: CompletionResponse
|
|
- description: 'streamed completion response.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/CompletionResponseStreamChunk"
|
|
/>'
|
|
name: CompletionResponseStreamChunk
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentRequest"
|
|
/>
|
|
name: CreateAgentRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentSessionRequest"
|
|
/>
|
|
name: CreateAgentSessionRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgentTurnRequest"
|
|
/>
|
|
name: CreateAgentTurnRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig"
|
|
/>
|
|
name: DPOAlignmentConfig
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/Dataset" />
|
|
name: Dataset
|
|
- name: DatasetIO
|
|
- name: Datasets
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgentsRequest"
|
|
/>
|
|
name: DeleteAgentsRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgentsSessionRequest"
|
|
/>
|
|
name: DeleteAgentsSessionRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/DoraFinetuningConfig"
|
|
/>
|
|
name: DoraFinetuningConfig
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/EmbeddingsRequest"
|
|
/>
|
|
name: EmbeddingsRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/EmbeddingsResponse"
|
|
/>
|
|
name: EmbeddingsResponse
|
|
- name: Eval
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/EvalTask" />
|
|
name: EvalTask
|
|
- name: EvalTasks
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateResponse"
|
|
/>
|
|
name: EvaluateResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateRowsRequest"
|
|
/>
|
|
name: EvaluateRowsRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/FinetuningAlgorithm"
|
|
/>
|
|
name: FinetuningAlgorithm
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/FunctionCallToolDefinition"
|
|
/>
|
|
name: FunctionCallToolDefinition
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/GetAgentsSessionRequest"
|
|
/>
|
|
name: GetAgentsSessionRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/GraphMemoryBank"
|
|
/>
|
|
name: GraphMemoryBank
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/GraphMemoryBankParams"
|
|
/>
|
|
name: GraphMemoryBankParams
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/HealthInfo" />
|
|
name: HealthInfo
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ImageMedia" />
|
|
name: ImageMedia
|
|
- name: Inference
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/InferenceStep" />
|
|
name: InferenceStep
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/InsertDocumentsRequest"
|
|
/>
|
|
name: InsertDocumentsRequest
|
|
- name: Inspect
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/Job" />
|
|
name: Job
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/JobCancelRequest"
|
|
/>
|
|
name: JobCancelRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/JobStatus" />
|
|
name: JobStatus
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/KeyValueMemoryBank"
|
|
/>
|
|
name: KeyValueMemoryBank
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/KeyValueMemoryBankParams"
|
|
/>
|
|
name: KeyValueMemoryBankParams
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/KeywordMemoryBank"
|
|
/>
|
|
name: KeywordMemoryBank
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/KeywordMemoryBankParams"
|
|
/>
|
|
name: KeywordMemoryBankParams
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/LLMAsJudgeScoringFnParams"
|
|
/>
|
|
name: LLMAsJudgeScoringFnParams
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/LogEventRequest"
|
|
/>
|
|
name: LogEventRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/LogSeverity" />
|
|
name: LogSeverity
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/LoraFinetuningConfig"
|
|
/>
|
|
name: LoraFinetuningConfig
|
|
- name: Memory
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryBankDocument"
|
|
/>
|
|
name: MemoryBankDocument
|
|
- name: MemoryBanks
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryRetrievalStep"
|
|
/>
|
|
name: MemoryRetrievalStep
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/MemoryToolDefinition"
|
|
/>
|
|
name: MemoryToolDefinition
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/MetricEvent" />
|
|
name: MetricEvent
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/Model" />
|
|
name: Model
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ModelCandidate" />
|
|
name: ModelCandidate
|
|
- name: Models
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/OptimizerConfig"
|
|
/>
|
|
name: OptimizerConfig
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/PaginatedRowsResult"
|
|
/>
|
|
name: PaginatedRowsResult
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/PhotogenToolDefinition"
|
|
/>
|
|
name: PhotogenToolDefinition
|
|
- name: PostTraining
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/PostTrainingJob"
|
|
/>
|
|
name: PostTrainingJob
|
|
- description: 'Artifacts of a finetuning job.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/PostTrainingJobArtifactsResponse"
|
|
/>'
|
|
name: PostTrainingJobArtifactsResponse
|
|
- description: 'Stream of logs from a finetuning job.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/PostTrainingJobLogStream" />'
|
|
name: PostTrainingJobLogStream
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/PostTrainingJobStatus"
|
|
/>
|
|
name: PostTrainingJobStatus
|
|
- description: 'Status of a finetuning job.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/PostTrainingJobStatusResponse"
|
|
/>'
|
|
name: PostTrainingJobStatusResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/PreferenceOptimizeRequest"
|
|
/>
|
|
name: PreferenceOptimizeRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ProviderInfo" />
|
|
name: ProviderInfo
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/QLoraFinetuningConfig"
|
|
/>
|
|
name: QLoraFinetuningConfig
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/QueryDocumentsRequest"
|
|
/>
|
|
name: QueryDocumentsRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/QueryDocumentsResponse"
|
|
/>
|
|
name: QueryDocumentsResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RLHFAlgorithm" />
|
|
name: RLHFAlgorithm
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RegexParserScoringFnParams"
|
|
/>
|
|
name: RegexParserScoringFnParams
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterDatasetRequest"
|
|
/>
|
|
name: RegisterDatasetRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterEvalTaskRequest"
|
|
/>
|
|
name: RegisterEvalTaskRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterMemoryBankRequest"
|
|
/>
|
|
name: RegisterMemoryBankRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterModelRequest"
|
|
/>
|
|
name: RegisterModelRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterScoringFunctionRequest"
|
|
/>
|
|
name: RegisterScoringFunctionRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RegisterShieldRequest"
|
|
/>
|
|
name: RegisterShieldRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RestAPIExecutionConfig"
|
|
/>
|
|
name: RestAPIExecutionConfig
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RestAPIMethod" />
|
|
name: RestAPIMethod
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RouteInfo" />
|
|
name: RouteInfo
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RunEvalRequest" />
|
|
name: RunEvalRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RunShieldRequest"
|
|
/>
|
|
name: RunShieldRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/RunShieldResponse"
|
|
/>
|
|
name: RunShieldResponse
|
|
- name: Safety
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SafetyViolation"
|
|
/>
|
|
name: SafetyViolation
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SamplingParams" />
|
|
name: SamplingParams
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SamplingStrategy"
|
|
/>
|
|
name: SamplingStrategy
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreBatchRequest"
|
|
/>
|
|
name: ScoreBatchRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreBatchResponse"
|
|
/>
|
|
name: ScoreBatchResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreRequest" />
|
|
name: ScoreRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoreResponse" />
|
|
name: ScoreResponse
|
|
- name: Scoring
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoringFn" />
|
|
name: ScoringFn
|
|
- name: ScoringFunctions
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ScoringResult" />
|
|
name: ScoringResult
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SearchToolDefinition"
|
|
/>
|
|
name: SearchToolDefinition
|
|
- description: 'A single session of an interaction with an Agentic System.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/Session" />'
|
|
name: Session
|
|
- description: 'A safety shield resource that can be used to check content
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/Shield" />'
|
|
name: Shield
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ShieldCallStep" />
|
|
name: ShieldCallStep
|
|
- name: Shields
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SpanEndPayload" />
|
|
name: SpanEndPayload
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SpanStartPayload"
|
|
/>
|
|
name: SpanStartPayload
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SpanStatus" />
|
|
name: SpanStatus
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/StopReason" />
|
|
name: StopReason
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/StructuredLogEvent"
|
|
/>
|
|
name: StructuredLogEvent
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SupervisedFineTuneRequest"
|
|
/>
|
|
name: SupervisedFineTuneRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerateRequest"
|
|
/>
|
|
name: SyntheticDataGenerateRequest
|
|
- name: SyntheticDataGeneration
|
|
- description: 'Response from the synthetic data generation. Batch of (prompt, response,
|
|
score) tuples that pass the threshold.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerationResponse"
|
|
/>'
|
|
name: SyntheticDataGenerationResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/SystemMessage" />
|
|
name: SystemMessage
|
|
- name: Telemetry
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/TokenLogProbs" />
|
|
name: TokenLogProbs
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCall" />
|
|
name: ToolCall
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCallDelta" />
|
|
name: ToolCallDelta
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolCallParseStatus"
|
|
/>
|
|
name: ToolCallParseStatus
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolChoice" />
|
|
name: ToolChoice
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolDefinition" />
|
|
name: ToolDefinition
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolExecutionStep"
|
|
/>
|
|
name: ToolExecutionStep
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolParamDefinition"
|
|
/>
|
|
name: ToolParamDefinition
|
|
- description: "This Enum refers to the prompt format for calling custom / zero shot\
|
|
\ tools\n\n`json` --\n Refers to the json format for calling tools.\n The\
|
|
\ json format takes the form like\n {\n \"type\": \"function\",\n \
|
|
\ \"function\" : {\n \"name\": \"function_name\",\n \
|
|
\ \"description\": \"function_description\",\n \"parameters\": {...}\n\
|
|
\ }\n }\n\n`function_tag` --\n This is an example of how you could\
|
|
\ define\n your own user defined format for making tool calls.\n The function_tag\
|
|
\ format looks like this,\n <function=function_name>(parameters)</function>\n\
|
|
\nThe detailed prompts for each of these formats are added to llama cli\n\n<SchemaDefinition\
|
|
\ schemaRef=\"#/components/schemas/ToolPromptFormat\" />"
|
|
name: ToolPromptFormat
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolResponse" />
|
|
name: ToolResponse
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ToolResponseMessage"
|
|
/>
|
|
name: ToolResponseMessage
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/Trace" />
|
|
name: Trace
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/TrainingConfig" />
|
|
name: TrainingConfig
|
|
- description: 'A single turn in an interaction with an Agentic System.
|
|
|
|
|
|
<SchemaDefinition schemaRef="#/components/schemas/Turn" />'
|
|
name: Turn
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/URL" />
|
|
name: URL
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/UnregisterMemoryBankRequest"
|
|
/>
|
|
name: UnregisterMemoryBankRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/UnregisterModelRequest"
|
|
/>
|
|
name: UnregisterModelRequest
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/UnstructuredLogEvent"
|
|
/>
|
|
name: UnstructuredLogEvent
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/UserMessage" />
|
|
name: UserMessage
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/VectorMemoryBank"
|
|
/>
|
|
name: VectorMemoryBank
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/VectorMemoryBankParams"
|
|
/>
|
|
name: VectorMemoryBankParams
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/ViolationLevel" />
|
|
name: ViolationLevel
|
|
- description: <SchemaDefinition schemaRef="#/components/schemas/WolframAlphaToolDefinition"
|
|
/>
|
|
name: WolframAlphaToolDefinition
|
|
x-tagGroups:
|
|
- name: Operations
|
|
tags:
|
|
- Agents
|
|
- BatchInference
|
|
- DatasetIO
|
|
- Datasets
|
|
- Eval
|
|
- EvalTasks
|
|
- Inference
|
|
- Inspect
|
|
- Memory
|
|
- MemoryBanks
|
|
- Models
|
|
- PostTraining
|
|
- Safety
|
|
- Scoring
|
|
- ScoringFunctions
|
|
- Shields
|
|
- SyntheticDataGeneration
|
|
- 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
|