diff --git a/docs/_static/llama-stack-spec.html b/docs/_static/llama-stack-spec.html index 516a0174d..8e8b8804f 100644 --- a/docs/_static/llama-stack-spec.html +++ b/docs/_static/llama-stack-spec.html @@ -2319,7 +2319,7 @@ "post": { "responses": { "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": { "application/json": { "schema": { @@ -2337,11 +2337,12 @@ "tags": [ "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": [ { "name": "agent_id", "in": "path", + "description": "The ID of the agent to resume.", "required": true, "schema": { "type": "string" @@ -2350,6 +2351,7 @@ { "name": "session_id", "in": "path", + "description": "The ID of the session to resume.", "required": true, "schema": { "type": "string" @@ -2358,6 +2360,7 @@ { "name": "turn_id", "in": "path", + "description": "The ID of the turn to resume.", "required": true, "schema": { "type": "string" @@ -8109,10 +8112,12 @@ "type": "array", "items": { "$ref": "#/components/schemas/ToolResponseMessage" - } + }, + "description": "The tool call responses to resume the turn with." }, "stream": { - "type": "boolean" + "type": "boolean", + "description": "Whether to stream the response." } }, "additionalProperties": false, diff --git a/docs/_static/llama-stack-spec.yaml b/docs/_static/llama-stack-spec.yaml index c7f439982..c14ae3d3a 100644 --- a/docs/_static/llama-stack-spec.yaml +++ b/docs/_static/llama-stack-spec.yaml @@ -1406,8 +1406,8 @@ paths: responses: '200': description: >- - A single turn in an interaction with an Agentic System. **OR** streamed - agent turn completion response. + A Turn object if stream is False, otherwise an AsyncIterator of AgentTurnResponseStreamChunk + objects. content: application/json: schema: @@ -1417,20 +1417,28 @@ paths: $ref: '#/components/schemas/AgentTurnResponseStreamChunk' tags: - 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: - name: agent_id in: path + description: The ID of the agent to resume. required: true schema: type: string - name: session_id in: path + description: The ID of the session to resume. required: true schema: type: string - name: turn_id in: path + description: The ID of the turn to resume. required: true schema: type: string @@ -5244,8 +5252,11 @@ components: type: array items: $ref: '#/components/schemas/ToolResponseMessage' + description: >- + The tool call responses to resume the turn with. stream: type: boolean + description: Whether to stream the response. additionalProperties: false required: - tool_responses