diff --git a/docs/openapi_generator/generate.py b/docs/openapi_generator/generate.py
index 5c102105d..c00d2dc16 100644
--- a/docs/openapi_generator/generate.py
+++ b/docs/openapi_generator/generate.py
@@ -64,6 +64,9 @@ def main(output_dir: str):
y = yaml.YAML()
y.default_flow_style = False
y.block_seq_indent = 2
+ y.map_indent = 2
+ y.sequence_indent = 4
+ y.sequence_dash_offset = 2
y.dump(
spec.get_json(),
fp,
diff --git a/docs/resources/llama-stack-spec.yaml b/docs/resources/llama-stack-spec.yaml
index 4f9585f2c..02463291c 100644
--- a/docs/resources/llama-stack-spec.yaml
+++ b/docs/resources/llama-stack-spec.yaml
@@ -21,39 +21,39 @@ paths:
- DatasetIO
parameters:
- name: dataset_id
- in: query
- required: true
- schema:
- type: string
+ in: query
+ required: true
+ schema:
+ type: string
- name: rows_in_page
- in: query
- required: true
- schema:
- type: integer
+ in: query
+ required: true
+ schema:
+ type: integer
- name: page_token
- in: query
- required: false
- schema:
- type: string
+ in: query
+ required: false
+ schema:
+ type: string
- name: filter_condition
- in: query
- required: false
- schema:
- type: string
+ in: query
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
post:
responses:
'200':
@@ -62,19 +62,19 @@ paths:
- DatasetIO
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -94,19 +94,19 @@ paths:
- BatchInference (Coming Soon)
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -126,19 +126,19 @@ paths:
- BatchInference (Coming Soon)
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -154,19 +154,19 @@ paths:
- PostTraining (Coming Soon)
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -188,19 +188,19 @@ paths:
- Inference
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -222,19 +222,19 @@ paths:
- Inference
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -254,19 +254,19 @@ paths:
- Agents
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -286,24 +286,24 @@ paths:
- Agents
parameters:
- name: agent_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -326,29 +326,29 @@ paths:
- Agents
parameters:
- name: agent_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: session_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -364,24 +364,24 @@ paths:
- Agents
parameters:
- name: agent_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/agents/{agent_id}/session/{session_id}:
get:
responses:
@@ -395,36 +395,36 @@ paths:
- Agents
parameters:
- name: session_id
- in: path
- required: true
- schema:
- type: string
- - name: agent_id
- in: path
- required: true
- schema:
- type: string
- - name: turn_ids
- in: query
- required: false
- schema:
- type: array
- items:
+ in: path
+ required: true
+ schema:
type: string
+ - name: agent_id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: turn_ids
+ in: query
+ required: false
+ schema:
+ type: array
+ items:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
delete:
responses:
'200':
@@ -433,29 +433,29 @@ paths:
- Agents
parameters:
- name: session_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: agent_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/inference/embeddings:
post:
responses:
@@ -469,19 +469,19 @@ paths:
- Inference
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -501,24 +501,24 @@ paths:
- Eval
parameters:
- name: task_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -538,39 +538,39 @@ paths:
- Agents
parameters:
- name: agent_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: session_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: turn_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: step_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/agents/{agent_id}/session/{session_id}/turn/{turn_id}:
get:
responses:
@@ -584,34 +584,34 @@ paths:
- Agents
parameters:
- name: agent_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: session_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: turn_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/datasets/{dataset_id}:
get:
responses:
@@ -627,24 +627,24 @@ paths:
- Datasets
parameters:
- name: dataset_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
delete:
responses:
'200':
@@ -653,24 +653,24 @@ paths:
- Datasets
parameters:
- name: dataset_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/eval-tasks/{eval_task_id}:
get:
responses:
@@ -686,24 +686,24 @@ paths:
- EvalTasks
parameters:
- name: eval_task_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/models/{model_id}:
get:
responses:
@@ -719,24 +719,24 @@ paths:
- Models
parameters:
- name: model_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
delete:
responses:
'200':
@@ -745,24 +745,24 @@ paths:
- Models
parameters:
- name: model_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/scoring-functions/{scoring_fn_id}:
get:
responses:
@@ -778,24 +778,24 @@ paths:
- ScoringFunctions
parameters:
- name: scoring_fn_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/shields/{identifier}:
get:
responses:
@@ -811,24 +811,24 @@ paths:
- Shields
parameters:
- name: identifier
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/telemetry/traces/{trace_id}/spans/{span_id}:
get:
responses:
@@ -842,29 +842,29 @@ paths:
- Telemetry
parameters:
- name: trace_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: span_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/telemetry/spans/{span_id}/tree:
get:
responses:
@@ -878,36 +878,36 @@ paths:
- Telemetry
parameters:
- name: span_id
- in: path
- required: true
- schema:
- type: string
- - name: attributes_to_return
- in: query
- required: false
- schema:
- type: array
- items:
+ in: path
+ required: true
+ schema:
type: string
+ - name: attributes_to_return
+ in: query
+ required: false
+ schema:
+ type: array
+ items:
+ type: string
- name: max_depth
- in: query
- required: false
- schema:
- type: integer
+ in: query
+ required: false
+ schema:
+ type: integer
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/tools/{tool_name}:
get:
responses:
@@ -921,24 +921,24 @@ paths:
- ToolGroups
parameters:
- name: tool_name
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/toolgroups/{toolgroup_id}:
get:
responses:
@@ -952,24 +952,24 @@ paths:
- ToolGroups
parameters:
- name: toolgroup_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
delete:
responses:
'200':
@@ -979,24 +979,24 @@ paths:
summary: Unregister a tool group
parameters:
- name: toolgroup_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/telemetry/traces/{trace_id}:
get:
responses:
@@ -1010,24 +1010,24 @@ paths:
- Telemetry
parameters:
- name: trace_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/post-training/job/artifacts:
get:
responses:
@@ -1043,24 +1043,24 @@ paths:
- PostTraining (Coming Soon)
parameters:
- name: job_uuid
- in: query
- required: true
- schema:
- type: string
+ in: query
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/post-training/job/status:
get:
responses:
@@ -1076,24 +1076,24 @@ paths:
- PostTraining (Coming Soon)
parameters:
- name: job_uuid
- in: query
- required: true
- schema:
- type: string
+ in: query
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/post-training/jobs:
get:
responses:
@@ -1107,19 +1107,19 @@ paths:
- PostTraining (Coming Soon)
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/vector-dbs/{vector_db_id}:
get:
responses:
@@ -1135,24 +1135,24 @@ paths:
- VectorDBs
parameters:
- name: vector_db_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
delete:
responses:
'200':
@@ -1161,24 +1161,24 @@ paths:
- VectorDBs
parameters:
- name: vector_db_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/health:
get:
responses:
@@ -1192,19 +1192,19 @@ paths:
- Inspect
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/tool-runtime/rag-tool/insert:
post:
responses:
@@ -1215,19 +1215,19 @@ paths:
summary: Index documents so they can be used by the RAG system
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1243,19 +1243,19 @@ paths:
- VectorIO
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1276,19 +1276,19 @@ paths:
summary: Run a tool with the given arguments
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1310,29 +1310,29 @@ paths:
- Eval
parameters:
- name: task_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: job_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
delete:
responses:
'200':
@@ -1341,29 +1341,29 @@ paths:
- Eval
parameters:
- name: task_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: job_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/eval/tasks/{task_id}/jobs/{job_id}/result:
get:
responses:
@@ -1377,29 +1377,29 @@ paths:
- Eval
parameters:
- name: job_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: task_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/datasets:
get:
responses:
@@ -1413,19 +1413,19 @@ paths:
- Datasets
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
post:
responses:
'200':
@@ -1434,19 +1434,19 @@ paths:
- Datasets
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1466,19 +1466,19 @@ paths:
- EvalTasks
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
post:
responses:
'200':
@@ -1487,19 +1487,19 @@ paths:
- EvalTasks
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1519,19 +1519,19 @@ paths:
- Models
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
post:
responses:
'200':
@@ -1544,19 +1544,19 @@ paths:
- Models
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1576,19 +1576,19 @@ paths:
- Inspect
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/inspect/routes:
get:
responses:
@@ -1602,19 +1602,19 @@ paths:
- Inspect
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/tool-runtime/list-tools:
get:
responses:
@@ -1628,29 +1628,29 @@ paths:
- ToolRuntime
parameters:
- name: tool_group_id
- in: query
- required: false
- schema:
- type: string
+ in: query
+ required: false
+ schema:
+ type: string
- name: mcp_endpoint
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/URL'
+ in: query
+ required: false
+ schema:
+ $ref: '#/components/schemas/URL'
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/scoring-functions:
get:
responses:
@@ -1664,19 +1664,19 @@ paths:
- ScoringFunctions
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
post:
responses:
'200':
@@ -1685,19 +1685,19 @@ paths:
- ScoringFunctions
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1717,19 +1717,19 @@ paths:
- Shields
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
post:
responses:
'200':
@@ -1742,19 +1742,19 @@ paths:
- Shields
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1775,19 +1775,19 @@ paths:
summary: List tool groups with optional provider
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
post:
responses:
'200':
@@ -1797,19 +1797,19 @@ paths:
summary: Register a tool group
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1830,24 +1830,24 @@ paths:
summary: List tools with optional tool group
parameters:
- name: toolgroup_id
- in: query
- required: false
- schema:
- type: string
+ in: query
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/vector-dbs:
get:
responses:
@@ -1861,19 +1861,19 @@ paths:
- VectorDBs
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
post:
responses:
'200':
@@ -1886,19 +1886,19 @@ paths:
- VectorDBs
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1914,19 +1914,19 @@ paths:
- Telemetry
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1946,19 +1946,19 @@ paths:
- PostTraining (Coming Soon)
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -1979,19 +1979,19 @@ paths:
summary: Query the RAG system for context; typically invoked by the agent
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2011,19 +2011,19 @@ paths:
- VectorIO
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2043,38 +2043,38 @@ paths:
- Telemetry
parameters:
- name: attribute_filters
- in: query
- required: true
- schema:
- type: array
- items:
- $ref: '#/components/schemas/QueryCondition'
+ in: query
+ required: true
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/QueryCondition'
- name: attributes_to_return
- in: query
- required: true
- schema:
- type: array
- items:
- type: string
+ in: query
+ required: true
+ schema:
+ type: array
+ items:
+ type: string
- name: max_depth
- in: query
- required: false
- schema:
- type: integer
+ in: query
+ required: false
+ schema:
+ type: integer
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/telemetry/traces:
get:
responses:
@@ -2088,43 +2088,43 @@ paths:
- Telemetry
parameters:
- name: attribute_filters
- in: query
- required: false
- schema:
- type: array
- items:
- $ref: '#/components/schemas/QueryCondition'
+ in: query
+ required: false
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/QueryCondition'
- name: limit
- in: query
- required: false
- schema:
- type: integer
+ in: query
+ required: false
+ schema:
+ type: integer
- name: offset
- in: query
- required: false
- schema:
- type: integer
+ in: query
+ required: false
+ schema:
+ type: integer
- name: order_by
- in: query
- required: false
- schema:
- type: array
- items:
- type: string
+ in: query
+ required: false
+ schema:
+ type: array
+ items:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
/v1/eval/tasks/{task_id}/jobs:
post:
responses:
@@ -2138,24 +2138,24 @@ paths:
- Eval
parameters:
- name: task_id
- in: path
- required: true
- schema:
- type: string
+ in: path
+ required: true
+ schema:
+ type: string
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2175,19 +2175,19 @@ paths:
- Safety
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2203,19 +2203,19 @@ paths:
- Telemetry
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2235,19 +2235,19 @@ paths:
- Scoring
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2267,19 +2267,19 @@ paths:
- Scoring
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2299,19 +2299,19 @@ paths:
- PostTraining (Coming Soon)
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2331,19 +2331,19 @@ paths:
- SyntheticDataGeneration (Coming Soon)
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
requestBody:
content:
application/json:
@@ -2363,19 +2363,19 @@ paths:
- Inspect
parameters:
- name: X-LlamaStack-Provider-Data
- in: header
- description: JSON-encoded provider data which will be made available to the
- adapter servicing the API
- required: false
- schema:
- type: string
+ in: header
+ description: JSON-encoded provider data which will be made available to
+ the adapter servicing the API
+ required: false
+ schema:
+ type: string
- name: X-LlamaStack-Client-Version
- in: header
- description: Version of the client making the request. This is used to ensure
- that the client and server are compatible.
- required: false
- schema:
- type: string
+ in: header
+ description: Version of the client making the request. This is used to ensure
+ that the client and server are compatible.
+ required: false
+ schema:
+ type: string
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
components:
schemas:
@@ -2463,8 +2463,8 @@ components:
- type: string
- $ref: '#/components/schemas/InterleavedContentItem'
- type: array
- items:
- $ref: '#/components/schemas/InterleavedContentItem'
+ items:
+ $ref: '#/components/schemas/InterleavedContentItem'
InterleavedContentItem:
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
@@ -2561,21 +2561,21 @@ components:
- type: boolean
- type: 'null'
- type: array
- items:
- oneOf:
- - type: string
- - type: integer
- - type: number
- - type: boolean
- - type: 'null'
+ items:
+ oneOf:
+ - type: string
+ - type: integer
+ - type: number
+ - type: boolean
+ - type: 'null'
- type: object
- additionalProperties:
- oneOf:
- - type: string
- - type: integer
- - type: number
- - type: boolean
- - type: 'null'
+ additionalProperties:
+ oneOf:
+ - type: string
+ - type: integer
+ - type: number
+ - type: boolean
+ - type: 'null'
additionalProperties: false
required:
- call_id
@@ -3099,23 +3099,23 @@ components:
oneOf:
- type: string
- type: object
- properties:
- name:
- type: string
- args:
- type: object
- additionalProperties:
- oneOf:
- - type: 'null'
- - type: boolean
- - type: number
- - type: string
- - type: array
- - type: object
- additionalProperties: false
- required:
- - name
- - args
+ properties:
+ name:
+ type: string
+ args:
+ type: object
+ additionalProperties:
+ oneOf:
+ - type: 'null'
+ - type: boolean
+ - type: number
+ - type: string
+ - type: array
+ - type: object
+ additionalProperties: false
+ required:
+ - name
+ - args
ToolDef:
type: object
properties:
@@ -3219,8 +3219,8 @@ components:
- type: string
- $ref: '#/components/schemas/InterleavedContentItem'
- type: array
- items:
- $ref: '#/components/schemas/InterleavedContentItem'
+ items:
+ $ref: '#/components/schemas/InterleavedContentItem'
- $ref: '#/components/schemas/URL'
mime_type:
type: string
@@ -3569,8 +3569,8 @@ components:
- type: string
- $ref: '#/components/schemas/InterleavedContentItem'
- type: array
- items:
- $ref: '#/components/schemas/InterleavedContentItem'
+ items:
+ $ref: '#/components/schemas/InterleavedContentItem'
- $ref: '#/components/schemas/URL'
mime_type:
type: string
@@ -4529,8 +4529,8 @@ components:
- type: string
- $ref: '#/components/schemas/InterleavedContentItem'
- type: array
- items:
- $ref: '#/components/schemas/InterleavedContentItem'
+ items:
+ $ref: '#/components/schemas/InterleavedContentItem'
- $ref: '#/components/schemas/URL'
mime_type:
type: string
@@ -5734,743 +5734,769 @@ security:
- Default: []
tags:
- name: AgentCandidate
- description:
+ description:
- name: AgentConfig
- description:
+ description:
- name: AgentCreateResponse
- description:
+ description:
- name: AgentSessionCreateResponse
- description:
+ description:
- name: AgentStepResponse
- description:
+ description:
- name: AgentTool
- description:
+ description:
- name: AgentTurnInputType
- description:
+ description:
- name: AgentTurnResponseEvent
- description:
+ description:
- name: AgentTurnResponseEventPayload
- description:
+ description:
- name: AgentTurnResponseStepCompletePayload
- description:
+ description:
- name: AgentTurnResponseStepProgressPayload
- description:
+ description:
- name: AgentTurnResponseStepStartPayload
- description:
+ description:
- name: AgentTurnResponseStreamChunk
- description: "streamed agent turn completion response.\n\n"
+ description: "streamed agent turn completion response.\n\n"
- name: AgentTurnResponseTurnCompletePayload
- description:
+ description:
- name: AgentTurnResponseTurnStartPayload
- description:
+ description:
- name: Agents
- name: AggregationFunctionType
- description:
+ description:
- name: AlgorithmConfig
- description:
+ description:
- name: AppEvalTaskConfig
- description:
+ description:
- name: AppendRowsRequest
- description:
+ description:
- name: ArrayType
- description:
+ description:
- name: BasicScoringFnParams
- description:
+ description:
- name: BatchChatCompletionRequest
- description:
+ description:
- name: BatchChatCompletionResponse
- description:
+ description:
- name: BatchCompletionRequest
- description:
+ description:
- name: BatchCompletionResponse
- description:
+ description:
- name: BatchInference (Coming Soon)
- name: BenchmarkEvalTaskConfig
- description:
+ description:
- name: BooleanType
- description:
+ description:
- name: BuiltinTool
- description:
+ description:
- name: CancelTrainingJobRequest
- description:
+ description:
- name: ChatCompletionInputType
- description:
+ description:
- name: ChatCompletionRequest
- description:
+ description:
- name: ChatCompletionResponse
- description: "Chat completion response.\n\n"
+ description: "Chat completion response.\n\n"
- name: ChatCompletionResponseEvent
- description: "Chat completion response event.\n\n"
+ description: "Chat completion response event.\n\n"
- name: ChatCompletionResponseEventType
- description:
+ description:
- name: ChatCompletionResponseStreamChunk
- description: "SSE-stream of these events.\n\n"
+ description: "SSE-stream of these events.\n\n"
- name: Checkpoint
- description: "Checkpoint created during training runs\n\n"
+ description: "Checkpoint created during training runs\n\n"
- name: CompletionInputType
- description:
+ description:
- name: CompletionMessage
- description:
+ description:
- name: CompletionRequest
- description:
+ description:
- name: CompletionResponse
- description: "Completion response.\n\n"
+ description: "Completion response.\n\n"
- name: CompletionResponseStreamChunk
- description: "streamed completion response.\n\n"
+ description: "streamed completion response.\n\n"
- name: ContentDelta
- description:
+ description:
- name: CreateAgentRequest
- description:
+ description:
- name: CreateAgentSessionRequest
- description:
+ description:
- name: CreateAgentTurnRequest
- description:
+ description:
- name: DPOAlignmentConfig
- description:
+ description:
- name: DataConfig
- description:
+ description:
- name: Dataset
- description:
+ description:
- name: DatasetFormat
- description:
+ description:
- name: DatasetIO
- name: Datasets
- name: DefaultRAGQueryGeneratorConfig
- description:
+ description:
- name: EfficiencyConfig
- description:
+ description:
- name: EmbeddingsRequest
- description:
+ description:
- name: EmbeddingsResponse
- description:
+ description:
- name: Eval
- name: EvalCandidate
- description:
+ description:
- name: EvalTask
- description:
+ description:
- name: EvalTaskConfig
- description:
+ description:
- name: EvalTasks
- name: EvaluateResponse
- description:
+ description:
- name: EvaluateRowsRequest
- description:
+ description:
- name: Event
- description:
+ description:
- name: GrammarResponseFormat
- description:
+ description:
- name: GreedySamplingStrategy
- description:
+ description:
- name: HealthInfo
- description:
+ description:
- name: ImageContentItem
- description:
+ description:
- name: ImageDelta
- description:
+ description:
- name: Inference
- name: InferenceStep
- description:
+ description:
- name: InsertChunksRequest
- description:
+ description:
- name: InsertRequest
- description:
+ description:
- name: Inspect
- name: InterleavedContent
- description:
+ description:
- name: InterleavedContentItem
- description:
+ description:
- name: InvokeToolRequest
- description:
+ description:
- name: Job
- description:
+ description:
- name: JobStatus
- description:
+ description:
- name: JsonSchemaResponseFormat
- description:
+ description:
- name: JsonType
- description:
+ description:
- name: LLMAsJudgeScoringFnParams
- description:
+ description:
- name: LLMRAGQueryGeneratorConfig
- description:
+ description:
- name: ListDatasetsResponse
- description:
+ description:
- name: ListEvalTasksResponse
- description:
+ description:
- name: ListModelsResponse
- description:
+ description:
- name: ListPostTrainingJobsResponse
- description:
+ description:
- name: ListProvidersResponse
- description:
+ description:
- name: ListRoutesResponse
- description:
+ description:
- name: ListScoringFunctionsResponse
- description:
+ description:
- name: ListShieldsResponse
- description:
+ description:
- name: ListToolGroupsResponse
- description:
+ description:
- name: ListToolsResponse
- description:
+ description:
- name: ListVectorDBsResponse
- description:
+ description:
- name: LogEventRequest
- description:
+ description:
- name: LogSeverity
- description:
+ description:
- name: LoraFinetuningConfig
- description:
+ description:
- name: MemoryRetrievalStep
- description:
+ description:
- name: Message
- description:
+ description:
- name: MetricEvent
- description:
+ description:
- name: Model
- description:
+ description:
- name: ModelCandidate
- description:
+ description:
- name: ModelType
- description:
+ description:
- name: Models
- name: NumberType
- description:
+ description:
- name: ObjectType
- description:
+ description:
- name: OptimizerConfig
- description:
+ description:
- name: OptimizerType
- description:
+ description:
- name: PaginatedRowsResult
- description:
+ description:
- name: ParamType
- description:
+ description:
- name: PostTraining (Coming Soon)
- name: PostTrainingJob
- description:
+ description:
- name: PostTrainingJobArtifactsResponse
- description: "Artifacts of a finetuning job.\n\n"
+ description: "Artifacts of a finetuning job.\n\n"
- name: PostTrainingJobStatusResponse
- description: "Status of a finetuning job.\n\n"
+ description: "Status of a finetuning job.\n\n"
- name: PreferenceOptimizeRequest
- description:
+ description:
- name: ProviderInfo
- description:
+ description:
- name: QATFinetuningConfig
- description:
+ description:
- name: QueryChunksRequest
- description:
+ description:
- name: QueryChunksResponse
- description:
+ description:
- name: QueryCondition
- description:
+ description:
- name: QueryConditionOp
- description:
+ description:
- name: QueryRequest
- description:
+ description:
- name: QuerySpanTreeResponse
- description:
+ description:
- name: QuerySpansResponse
- description:
+ description:
- name: QueryTracesResponse
- description:
+ description:
- name: RAGDocument
- description:
+ description:
- name: RAGQueryConfig
- description:
+ description:
- name: RAGQueryGeneratorConfig
- description:
+ description:
- name: RAGQueryResult
- description:
+ description:
- name: RegexParserScoringFnParams
- description:
+ description:
- name: RegisterDatasetRequest
- description:
+ description:
- name: RegisterEvalTaskRequest
- description:
+ description:
- name: RegisterModelRequest
- description:
+ description:
- name: RegisterScoringFunctionRequest
- description:
+ description:
- name: RegisterShieldRequest
- description:
+ description:
- name: RegisterToolGroupRequest
- description:
+ description:
- name: RegisterVectorDbRequest
- description:
+ description:
- name: ResponseFormat
- description:
+ description:
- name: RouteInfo
- description:
+ description:
- name: RunEvalRequest
- description:
+ description:
- name: RunShieldRequest
- description:
+ description:
- name: RunShieldResponse
- description:
+ description:
- name: Safety
- name: SafetyViolation
- description:
+ description:
- name: SamplingParams
- description:
+ description:
- name: SaveSpansToDatasetRequest
- description:
+ description:
- name: ScoreBatchRequest
- description:
+ description:
- name: ScoreBatchResponse
- description:
+ description:
- name: ScoreRequest
- description:
+ description:
- name: ScoreResponse
- description:
+ description:
- name: Scoring
- name: ScoringFn
- description:
+ description:
- name: ScoringFnParams
- description:
+ description:
- name: ScoringFunctions
- name: ScoringResult
- description:
+ description:
- name: Session
- description: "A single session of an interaction with an Agentic System.\n\n"
+ description: "A single session of an interaction with an Agentic System.\n\n"
- name: Shield
- description: "A safety shield resource that can be used to check content\n\n"
+ description: "A safety shield resource that can be used to check content\n\n"
- name: ShieldCallStep
- description:
+ description:
- name: Shields
- name: Span
- description:
+ description:
- name: SpanEndPayload
- description:
+ description:
- name: SpanStartPayload
- description:
+ description:
- name: SpanStatus
- description:
+ description:
- name: SpanWithStatus
- description:
+ description:
- name: StopReason
- description:
+ description:
- name: StringType
- description:
+ description:
- name: StructuredLogEvent
- description:
+ description:
- name: StructuredLogPayload
- description:
+ description:
- name: SupervisedFineTuneRequest
- description:
+ description:
- name: SyntheticDataGenerateRequest
- description:
+ description:
- name: SyntheticDataGeneration (Coming Soon)
- name: SyntheticDataGenerationResponse
- description: "Response from the synthetic data generation. Batch of (prompt, response,
- score) tuples that pass the threshold.\n\n"
+ description: "Response from the synthetic data generation. Batch of (prompt, response,
+ score) tuples that pass the threshold.\n\n"
- name: SystemMessage
- description:
+ description:
- name: Telemetry
- name: TextContentItem
- description:
+ description:
- name: TextDelta
- description:
+ description:
- name: TokenLogProbs
- description:
+ description:
- name: Tool
- description:
+ description:
- name: ToolCall
- description:
+ description:
- name: ToolCallDelta
- description:
+ description:
- name: ToolCallParseStatus
- description:
+ description:
- name: ToolChoice
- description:
+ description:
- name: ToolDef
- description:
+ description:
- name: ToolDefinition
- description:
+ description:
- name: ToolExecutionStep
- description:
+ description:
- name: ToolGroup
- description:
+ description:
- name: ToolGroups
- name: ToolHost
- description:
+ description:
- name: ToolInvocationResult
- description:
+ description:
- name: ToolParamDefinition
- description:
+ description:
- name: ToolParameter
- description:
+ description:
- name: ToolPromptFormat
- description: "This Enum refers to the prompt format for calling custom / zero shot
- tools\n\n`json` --\n Refers to the json format for calling tools.\n The
- json format takes the form like\n {\n \"type\": \"function\",\n \
- \ \"function\" : {\n \"name\": \"function_name\",\n \"\
- description\": \"function_description\",\n \"parameters\": {...}\n\
- \ }\n }\n\n`function_tag` --\n This is an example of how you could
- define\n your own user defined format for making tool calls.\n The function_tag
- format looks like this,\n (parameters)\n
- \nThe detailed prompts for each of these formats are added to llama cli\n\n"
+ description: "This Enum refers to the prompt format for calling custom / zero
+ shot tools\n\n`json` --\n Refers to the json format for calling tools.\n\
+ \ The json format takes the form like\n {\n \"type\": \"function\"\
+ ,\n \"function\" : {\n \"name\": \"function_name\",\n \
+ \ \"description\": \"function_description\",\n \"parameters\"\
+ : {...}\n }\n }\n\n`function_tag` --\n This is an example of how
+ you could define\n your own user defined format for making tool calls.\n\
+ \ The function_tag format looks like this,\n (parameters)\n
+ \nThe detailed prompts for each of these formats are added to llama cli\n\n
+ "
- name: ToolResponse
- description:
+ description:
- name: ToolResponseMessage
- description:
+ description:
- name: ToolRuntime
- name: TopKSamplingStrategy
- description:
+ description:
- name: TopPSamplingStrategy
- description:
+ description:
- name: Trace
- description:
+ description:
- name: TrainingConfig
- description:
+ description:
- name: Turn
- description: "A single turn in an interaction with an Agentic System.\n\n"
+ description: "A single turn in an interaction with an Agentic System.\n\n"
- name: URL
- description:
+ description:
- name: UnionType
- description:
+ description:
- name: UnstructuredLogEvent
- description:
+ description:
- name: UserMessage
- description:
+ description:
- name: VectorDB
- description:
+ description:
- name: VectorDBs
- name: VectorIO
- name: VersionInfo
- description:
+ description:
- name: ViolationLevel
- description:
+ description:
x-tagGroups:
- name: Operations
- tags:
- - Agents
- - BatchInference (Coming Soon)
- - DatasetIO
- - Datasets
- - Eval
- - EvalTasks
- - Inference
- - Inspect
- - Models
- - PostTraining (Coming Soon)
- - Safety
- - Scoring
- - ScoringFunctions
- - Shields
- - SyntheticDataGeneration (Coming Soon)
- - Telemetry
- - ToolGroups
- - ToolRuntime
- - VectorDBs
- - VectorIO
+ tags:
+ - Agents
+ - BatchInference (Coming Soon)
+ - DatasetIO
+ - Datasets
+ - Eval
+ - EvalTasks
+ - Inference
+ - Inspect
+ - Models
+ - PostTraining (Coming Soon)
+ - Safety
+ - Scoring
+ - ScoringFunctions
+ - Shields
+ - SyntheticDataGeneration (Coming Soon)
+ - Telemetry
+ - ToolGroups
+ - ToolRuntime
+ - VectorDBs
+ - VectorIO
- name: Types
- tags:
- - AgentCandidate
- - AgentConfig
- - AgentCreateResponse
- - AgentSessionCreateResponse
- - AgentStepResponse
- - AgentTool
- - AgentTurnInputType
- - AgentTurnResponseEvent
- - AgentTurnResponseEventPayload
- - AgentTurnResponseStepCompletePayload
- - AgentTurnResponseStepProgressPayload
- - AgentTurnResponseStepStartPayload
- - AgentTurnResponseStreamChunk
- - AgentTurnResponseTurnCompletePayload
- - AgentTurnResponseTurnStartPayload
- - AggregationFunctionType
- - AlgorithmConfig
- - AppEvalTaskConfig
- - AppendRowsRequest
- - ArrayType
- - BasicScoringFnParams
- - BatchChatCompletionRequest
- - BatchChatCompletionResponse
- - BatchCompletionRequest
- - BatchCompletionResponse
- - BenchmarkEvalTaskConfig
- - BooleanType
- - BuiltinTool
- - CancelTrainingJobRequest
- - ChatCompletionInputType
- - ChatCompletionRequest
- - ChatCompletionResponse
- - ChatCompletionResponseEvent
- - ChatCompletionResponseEventType
- - ChatCompletionResponseStreamChunk
- - Checkpoint
- - CompletionInputType
- - CompletionMessage
- - CompletionRequest
- - CompletionResponse
- - CompletionResponseStreamChunk
- - ContentDelta
- - CreateAgentRequest
- - CreateAgentSessionRequest
- - CreateAgentTurnRequest
- - DPOAlignmentConfig
- - DataConfig
- - Dataset
- - DatasetFormat
- - DefaultRAGQueryGeneratorConfig
- - EfficiencyConfig
- - EmbeddingsRequest
- - EmbeddingsResponse
- - EvalCandidate
- - EvalTask
- - EvalTaskConfig
- - EvaluateResponse
- - EvaluateRowsRequest
- - Event
- - GrammarResponseFormat
- - GreedySamplingStrategy
- - HealthInfo
- - ImageContentItem
- - ImageDelta
- - InferenceStep
- - InsertChunksRequest
- - InsertRequest
- - InterleavedContent
- - InterleavedContentItem
- - InvokeToolRequest
- - Job
- - JobStatus
- - JsonSchemaResponseFormat
- - JsonType
- - LLMAsJudgeScoringFnParams
- - LLMRAGQueryGeneratorConfig
- - ListDatasetsResponse
- - ListEvalTasksResponse
- - ListModelsResponse
- - ListPostTrainingJobsResponse
- - ListProvidersResponse
- - ListRoutesResponse
- - ListScoringFunctionsResponse
- - ListShieldsResponse
- - ListToolGroupsResponse
- - ListToolsResponse
- - ListVectorDBsResponse
- - LogEventRequest
- - LogSeverity
- - LoraFinetuningConfig
- - MemoryRetrievalStep
- - Message
- - MetricEvent
- - Model
- - ModelCandidate
- - ModelType
- - NumberType
- - ObjectType
- - OptimizerConfig
- - OptimizerType
- - PaginatedRowsResult
- - ParamType
- - PostTrainingJob
- - PostTrainingJobArtifactsResponse
- - PostTrainingJobStatusResponse
- - PreferenceOptimizeRequest
- - ProviderInfo
- - QATFinetuningConfig
- - QueryChunksRequest
- - QueryChunksResponse
- - QueryCondition
- - QueryConditionOp
- - QueryRequest
- - QuerySpanTreeResponse
- - QuerySpansResponse
- - QueryTracesResponse
- - RAGDocument
- - RAGQueryConfig
- - RAGQueryGeneratorConfig
- - RAGQueryResult
- - RegexParserScoringFnParams
- - RegisterDatasetRequest
- - RegisterEvalTaskRequest
- - RegisterModelRequest
- - RegisterScoringFunctionRequest
- - RegisterShieldRequest
- - RegisterToolGroupRequest
- - RegisterVectorDbRequest
- - ResponseFormat
- - RouteInfo
- - RunEvalRequest
- - RunShieldRequest
- - RunShieldResponse
- - SafetyViolation
- - SamplingParams
- - SaveSpansToDatasetRequest
- - ScoreBatchRequest
- - ScoreBatchResponse
- - ScoreRequest
- - ScoreResponse
- - ScoringFn
- - ScoringFnParams
- - ScoringResult
- - Session
- - Shield
- - ShieldCallStep
- - Span
- - SpanEndPayload
- - SpanStartPayload
- - SpanStatus
- - SpanWithStatus
- - StopReason
- - StringType
- - StructuredLogEvent
- - StructuredLogPayload
- - SupervisedFineTuneRequest
- - SyntheticDataGenerateRequest
- - SyntheticDataGenerationResponse
- - SystemMessage
- - TextContentItem
- - TextDelta
- - TokenLogProbs
- - Tool
- - ToolCall
- - ToolCallDelta
- - ToolCallParseStatus
- - ToolChoice
- - ToolDef
- - ToolDefinition
- - ToolExecutionStep
- - ToolGroup
- - ToolHost
- - ToolInvocationResult
- - ToolParamDefinition
- - ToolParameter
- - ToolPromptFormat
- - ToolResponse
- - ToolResponseMessage
- - TopKSamplingStrategy
- - TopPSamplingStrategy
- - Trace
- - TrainingConfig
- - Turn
- - URL
- - UnionType
- - UnstructuredLogEvent
- - UserMessage
- - VectorDB
- - VersionInfo
- - ViolationLevel
+ tags:
+ - AgentCandidate
+ - AgentConfig
+ - AgentCreateResponse
+ - AgentSessionCreateResponse
+ - AgentStepResponse
+ - AgentTool
+ - AgentTurnInputType
+ - AgentTurnResponseEvent
+ - AgentTurnResponseEventPayload
+ - AgentTurnResponseStepCompletePayload
+ - AgentTurnResponseStepProgressPayload
+ - AgentTurnResponseStepStartPayload
+ - AgentTurnResponseStreamChunk
+ - AgentTurnResponseTurnCompletePayload
+ - AgentTurnResponseTurnStartPayload
+ - AggregationFunctionType
+ - AlgorithmConfig
+ - AppEvalTaskConfig
+ - AppendRowsRequest
+ - ArrayType
+ - BasicScoringFnParams
+ - BatchChatCompletionRequest
+ - BatchChatCompletionResponse
+ - BatchCompletionRequest
+ - BatchCompletionResponse
+ - BenchmarkEvalTaskConfig
+ - BooleanType
+ - BuiltinTool
+ - CancelTrainingJobRequest
+ - ChatCompletionInputType
+ - ChatCompletionRequest
+ - ChatCompletionResponse
+ - ChatCompletionResponseEvent
+ - ChatCompletionResponseEventType
+ - ChatCompletionResponseStreamChunk
+ - Checkpoint
+ - CompletionInputType
+ - CompletionMessage
+ - CompletionRequest
+ - CompletionResponse
+ - CompletionResponseStreamChunk
+ - ContentDelta
+ - CreateAgentRequest
+ - CreateAgentSessionRequest
+ - CreateAgentTurnRequest
+ - DPOAlignmentConfig
+ - DataConfig
+ - Dataset
+ - DatasetFormat
+ - DefaultRAGQueryGeneratorConfig
+ - EfficiencyConfig
+ - EmbeddingsRequest
+ - EmbeddingsResponse
+ - EvalCandidate
+ - EvalTask
+ - EvalTaskConfig
+ - EvaluateResponse
+ - EvaluateRowsRequest
+ - Event
+ - GrammarResponseFormat
+ - GreedySamplingStrategy
+ - HealthInfo
+ - ImageContentItem
+ - ImageDelta
+ - InferenceStep
+ - InsertChunksRequest
+ - InsertRequest
+ - InterleavedContent
+ - InterleavedContentItem
+ - InvokeToolRequest
+ - Job
+ - JobStatus
+ - JsonSchemaResponseFormat
+ - JsonType
+ - LLMAsJudgeScoringFnParams
+ - LLMRAGQueryGeneratorConfig
+ - ListDatasetsResponse
+ - ListEvalTasksResponse
+ - ListModelsResponse
+ - ListPostTrainingJobsResponse
+ - ListProvidersResponse
+ - ListRoutesResponse
+ - ListScoringFunctionsResponse
+ - ListShieldsResponse
+ - ListToolGroupsResponse
+ - ListToolsResponse
+ - ListVectorDBsResponse
+ - LogEventRequest
+ - LogSeverity
+ - LoraFinetuningConfig
+ - MemoryRetrievalStep
+ - Message
+ - MetricEvent
+ - Model
+ - ModelCandidate
+ - ModelType
+ - NumberType
+ - ObjectType
+ - OptimizerConfig
+ - OptimizerType
+ - PaginatedRowsResult
+ - ParamType
+ - PostTrainingJob
+ - PostTrainingJobArtifactsResponse
+ - PostTrainingJobStatusResponse
+ - PreferenceOptimizeRequest
+ - ProviderInfo
+ - QATFinetuningConfig
+ - QueryChunksRequest
+ - QueryChunksResponse
+ - QueryCondition
+ - QueryConditionOp
+ - QueryRequest
+ - QuerySpanTreeResponse
+ - QuerySpansResponse
+ - QueryTracesResponse
+ - RAGDocument
+ - RAGQueryConfig
+ - RAGQueryGeneratorConfig
+ - RAGQueryResult
+ - RegexParserScoringFnParams
+ - RegisterDatasetRequest
+ - RegisterEvalTaskRequest
+ - RegisterModelRequest
+ - RegisterScoringFunctionRequest
+ - RegisterShieldRequest
+ - RegisterToolGroupRequest
+ - RegisterVectorDbRequest
+ - ResponseFormat
+ - RouteInfo
+ - RunEvalRequest
+ - RunShieldRequest
+ - RunShieldResponse
+ - SafetyViolation
+ - SamplingParams
+ - SaveSpansToDatasetRequest
+ - ScoreBatchRequest
+ - ScoreBatchResponse
+ - ScoreRequest
+ - ScoreResponse
+ - ScoringFn
+ - ScoringFnParams
+ - ScoringResult
+ - Session
+ - Shield
+ - ShieldCallStep
+ - Span
+ - SpanEndPayload
+ - SpanStartPayload
+ - SpanStatus
+ - SpanWithStatus
+ - StopReason
+ - StringType
+ - StructuredLogEvent
+ - StructuredLogPayload
+ - SupervisedFineTuneRequest
+ - SyntheticDataGenerateRequest
+ - SyntheticDataGenerationResponse
+ - SystemMessage
+ - TextContentItem
+ - TextDelta
+ - TokenLogProbs
+ - Tool
+ - ToolCall
+ - ToolCallDelta
+ - ToolCallParseStatus
+ - ToolChoice
+ - ToolDef
+ - ToolDefinition
+ - ToolExecutionStep
+ - ToolGroup
+ - ToolHost
+ - ToolInvocationResult
+ - ToolParamDefinition
+ - ToolParameter
+ - ToolPromptFormat
+ - ToolResponse
+ - ToolResponseMessage
+ - TopKSamplingStrategy
+ - TopPSamplingStrategy
+ - Trace
+ - TrainingConfig
+ - Turn
+ - URL
+ - UnionType
+ - UnstructuredLogEvent
+ - UserMessage
+ - VectorDB
+ - VersionInfo
+ - ViolationLevel