mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 12:07:34 +00:00
28bbbcf2c1
Some checks failed
SqlStore Integration Tests / test-postgres (3.12) (push) Failing after 1s
Integration Auth Tests / test-matrix (oauth2_token) (push) Failing after 1s
Test External Providers Installed via Module / test-external-providers-from-module (venv) (push) Has been skipped
Integration Tests (Replay) / Integration Tests (, , , client=, ) (push) Failing after 2s
Python Package Build Test / build (3.13) (push) Failing after 2s
Python Package Build Test / build (3.12) (push) Failing after 3s
SqlStore Integration Tests / test-postgres (3.13) (push) Failing after 6s
Vector IO Integration Tests / test-matrix (push) Failing after 4s
API Conformance Tests / check-schema-compatibility (push) Successful in 8s
Test External API and Providers / test-external (venv) (push) Failing after 5s
Unit Tests / unit-tests (3.12) (push) Failing after 5s
Unit Tests / unit-tests (3.13) (push) Failing after 4s
UI Tests / ui-tests (22) (push) Successful in 45s
Pre-commit / pre-commit (push) Successful in 1m27s
# What does this PR do? Adds supplementary static content to root API spec pages. This is useful for giving context behind a specific API group, adding information on supported features or work in progress, etc. This PR introduces supplementary information for Agents (experimental, deprecated) and Responses (stable) APIs. <!-- Provide a short summary of what this PR does and why. Link to relevant issues if applicable. --> <!-- If resolving an issue, uncomment and update the line below --> <!-- Closes #[issue-number] --> ## Test Plan Documentation server renders rich static content for the Agents API group:  <!-- Describe the tests you ran to verify your changes with result summaries. *Provide clear instructions so the plan can be easily re-executed.* -->
40 lines
No EOL
1.5 KiB
Markdown
40 lines
No EOL
1.5 KiB
Markdown
## Responses API
|
|
|
|
The Responses API provides OpenAI-compatible functionality with enhanced capabilities for dynamic, stateful interactions.
|
|
|
|
> **✅ STABLE**: This API is production-ready with backward compatibility guarantees. Recommended for production applications.
|
|
|
|
### ✅ Supported Tools
|
|
|
|
The Responses API supports the following tool types:
|
|
|
|
- **`web_search`**: Search the web for current information and real-time data
|
|
- **`file_search`**: Search through uploaded files and vector stores
|
|
- Supports dynamic `vector_store_ids` per call
|
|
- Compatible with OpenAI file search patterns
|
|
- **`function`**: Call custom functions with JSON schema validation
|
|
- **`mcp_tool`**: Model Context Protocol integration
|
|
|
|
### ✅ Supported Fields & Features
|
|
|
|
**Core Capabilities:**
|
|
- **Dynamic Configuration**: Switch models, vector stores, and tools per request without pre-configuration
|
|
- **Conversation Branching**: Use `previous_response_id` to branch conversations and explore different paths
|
|
- **Rich Annotations**: Automatic file citations, URL citations, and container file citations
|
|
- **Status Tracking**: Monitor tool call execution status and handle failures gracefully
|
|
|
|
### 🚧 Work in Progress
|
|
|
|
- Full real-time response streaming support
|
|
- `tool_choice` parameter
|
|
- `max_tool_calls` parameter
|
|
- Built-in tools (code interpreter, containers API)
|
|
- Safety & guardrails
|
|
- `reasoning` capabilities
|
|
- `service_tier`
|
|
- `logprobs`
|
|
- `max_output_tokens`
|
|
- `metadata` handling
|
|
- `instructions`
|
|
- `incomplete_details`
|
|
- `background` |