mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-08-13 21:29:57 +00:00
add doc
This commit is contained in:
parent
db764e7ed6
commit
4f2427c6c8
2 changed files with 23 additions and 7 deletions
13
docs/_static/llama-stack-spec.html
vendored
13
docs/_static/llama-stack-spec.html
vendored
|
@ -2319,7 +2319,7 @@
|
||||||
"post": {
|
"post": {
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": "A single turn in an interaction with an Agentic System. **OR** streamed agent turn completion response.",
|
"description": "A Turn object if stream is False, otherwise an AsyncIterator of AgentTurnResponseStreamChunk objects.",
|
||||||
"content": {
|
"content": {
|
||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
|
@ -2337,11 +2337,12 @@
|
||||||
"tags": [
|
"tags": [
|
||||||
"Agents"
|
"Agents"
|
||||||
],
|
],
|
||||||
"description": "",
|
"description": "Resume an agent turn with executed tool call responses.\nWhen a Turn has the status `awaiting_input` due to pending input from client side tool calls, this endpoint can be used to submit the outputs from the tool calls once they are ready.",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"name": "agent_id",
|
"name": "agent_id",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
|
"description": "The ID of the agent to resume.",
|
||||||
"required": true,
|
"required": true,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
|
@ -2350,6 +2351,7 @@
|
||||||
{
|
{
|
||||||
"name": "session_id",
|
"name": "session_id",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
|
"description": "The ID of the session to resume.",
|
||||||
"required": true,
|
"required": true,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
|
@ -2358,6 +2360,7 @@
|
||||||
{
|
{
|
||||||
"name": "turn_id",
|
"name": "turn_id",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
|
"description": "The ID of the turn to resume.",
|
||||||
"required": true,
|
"required": true,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
|
@ -8109,10 +8112,12 @@
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/components/schemas/ToolResponseMessage"
|
"$ref": "#/components/schemas/ToolResponseMessage"
|
||||||
}
|
},
|
||||||
|
"description": "The tool call responses to resume the turn with."
|
||||||
},
|
},
|
||||||
"stream": {
|
"stream": {
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"description": "Whether to stream the response."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
|
|
17
docs/_static/llama-stack-spec.yaml
vendored
17
docs/_static/llama-stack-spec.yaml
vendored
|
@ -1406,8 +1406,8 @@ paths:
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: >-
|
description: >-
|
||||||
A single turn in an interaction with an Agentic System. **OR** streamed
|
A Turn object if stream is False, otherwise an AsyncIterator of AgentTurnResponseStreamChunk
|
||||||
agent turn completion response.
|
objects.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
@ -1417,20 +1417,28 @@ paths:
|
||||||
$ref: '#/components/schemas/AgentTurnResponseStreamChunk'
|
$ref: '#/components/schemas/AgentTurnResponseStreamChunk'
|
||||||
tags:
|
tags:
|
||||||
- Agents
|
- Agents
|
||||||
description: ''
|
description: >-
|
||||||
|
Resume an agent turn with executed tool call responses.
|
||||||
|
|
||||||
|
When a Turn has the status `awaiting_input` due to pending input from client
|
||||||
|
side tool calls, this endpoint can be used to submit the outputs from the
|
||||||
|
tool calls once they are ready.
|
||||||
parameters:
|
parameters:
|
||||||
- name: agent_id
|
- name: agent_id
|
||||||
in: path
|
in: path
|
||||||
|
description: The ID of the agent to resume.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: session_id
|
- name: session_id
|
||||||
in: path
|
in: path
|
||||||
|
description: The ID of the session to resume.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: turn_id
|
- name: turn_id
|
||||||
in: path
|
in: path
|
||||||
|
description: The ID of the turn to resume.
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
|
@ -5244,8 +5252,11 @@ components:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/ToolResponseMessage'
|
$ref: '#/components/schemas/ToolResponseMessage'
|
||||||
|
description: >-
|
||||||
|
The tool call responses to resume the turn with.
|
||||||
stream:
|
stream:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
description: Whether to stream the response.
|
||||||
additionalProperties: false
|
additionalProperties: false
|
||||||
required:
|
required:
|
||||||
- tool_responses
|
- tool_responses
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue