mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 04:04:14 +00:00
docs: adding supplementary markdown content to API specs (#3632)
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
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.* -->
This commit is contained in:
parent
b6a5bccadf
commit
28bbbcf2c1
10 changed files with 381 additions and 29 deletions
49
docs/static/experimental-llama-stack-spec.yaml
vendored
49
docs/static/experimental-llama-stack-spec.yaml
vendored
|
@ -4777,15 +4777,64 @@ tags:
|
|||
- name: Agents
|
||||
description: >-
|
||||
APIs for creating and interacting with agentic systems.
|
||||
|
||||
|
||||
## Agents API (Experimental)
|
||||
|
||||
|
||||
> **🧪 EXPERIMENTAL**: This API is in preview and may change based on user feedback.
|
||||
Great for exploring new capabilities and providing feedback to influence the
|
||||
final design.
|
||||
|
||||
|
||||
Main functionalities provided by this API:
|
||||
|
||||
|
||||
- Create agents with specific instructions and ability to use tools.
|
||||
|
||||
- Interactions with agents are grouped into sessions ("threads"), and each interaction
|
||||
is called a "turn".
|
||||
|
||||
- Agents can be provided with various tools (see the ToolGroups and ToolRuntime
|
||||
APIs for more details).
|
||||
|
||||
- Agents can be provided with various shields (see the Safety API for more details).
|
||||
|
||||
- Agents can also use Memory to retrieve information from knowledge bases. See
|
||||
the RAG Tool and Vector IO APIs for more details.
|
||||
|
||||
|
||||
### 🧪 Feedback Welcome
|
||||
|
||||
|
||||
This API is actively being developed. We welcome feedback on:
|
||||
|
||||
- API design and usability
|
||||
|
||||
- Performance characteristics
|
||||
|
||||
- Missing features or capabilities
|
||||
|
||||
- Integration patterns
|
||||
|
||||
|
||||
**Provide Feedback**: [GitHub Discussions](https://github.com/llamastack/llama-stack/discussions)
|
||||
or [GitHub Issues](https://github.com/llamastack/llama-stack/issues)
|
||||
x-displayName: Agents
|
||||
- name: Benchmarks
|
||||
description: ''
|
||||
- name: DatasetIO
|
||||
description: ''
|
||||
- name: Datasets
|
||||
description: ''
|
||||
- name: Eval
|
||||
description: ''
|
||||
x-displayName: >-
|
||||
Llama Stack Evaluation API for running evaluations on model and agent candidates.
|
||||
- name: PostTraining (Coming Soon)
|
||||
description: ''
|
||||
- name: Telemetry
|
||||
description: ''
|
||||
x-tagGroups:
|
||||
- name: Operations
|
||||
tags:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue