mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-07-06 14:00:42 +00:00
docs: auto generated documentation for providers (#2543)
# What does this PR do? Simple approach to get some provider pages in the docs. Add or update description fields in the provider configuration class using Pydantic’s Field, ensuring these descriptions are clear and complete, as they will be used to auto-generate provider documentation via ./scripts/distro_codegen.py instead of editing the docs manually. Signed-off-by: Sébastien Han <seb@redhat.com>
This commit is contained in:
parent
8d8e90d78e
commit
c9a49a80e8
96 changed files with 2562 additions and 65 deletions
10
docs/source/providers/tool_runtime/index.md
Normal file
10
docs/source/providers/tool_runtime/index.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
# Tool_Runtime Providers
|
||||
|
||||
This section contains documentation for all available providers for the **tool_runtime** API.
|
||||
|
||||
- [inline::rag-runtime](inline_rag-runtime.md)
|
||||
- [remote::bing-search](remote_bing-search.md)
|
||||
- [remote::brave-search](remote_brave-search.md)
|
||||
- [remote::model-context-protocol](remote_model-context-protocol.md)
|
||||
- [remote::tavily-search](remote_tavily-search.md)
|
||||
- [remote::wolfram-alpha](remote_wolfram-alpha.md)
|
13
docs/source/providers/tool_runtime/inline_rag-runtime.md
Normal file
13
docs/source/providers/tool_runtime/inline_rag-runtime.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
# inline::rag-runtime
|
||||
|
||||
## Description
|
||||
|
||||
RAG (Retrieval-Augmented Generation) tool runtime for document ingestion, chunking, and semantic search.
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
{}
|
||||
|
||||
```
|
||||
|
20
docs/source/providers/tool_runtime/remote_bing-search.md
Normal file
20
docs/source/providers/tool_runtime/remote_bing-search.md
Normal file
|
@ -0,0 +1,20 @@
|
|||
# remote::bing-search
|
||||
|
||||
## Description
|
||||
|
||||
Bing Search tool for web search capabilities using Microsoft's search engine.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `api_key` | `str \| None` | No | | |
|
||||
| `top_k` | `<class 'int'>` | No | 3 | |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
api_key: ${env.BING_API_KEY:}
|
||||
|
||||
```
|
||||
|
21
docs/source/providers/tool_runtime/remote_brave-search.md
Normal file
21
docs/source/providers/tool_runtime/remote_brave-search.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
# remote::brave-search
|
||||
|
||||
## Description
|
||||
|
||||
Brave Search tool for web search capabilities with privacy-focused results.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `api_key` | `str \| None` | No | | The Brave Search API Key |
|
||||
| `max_results` | `<class 'int'>` | No | 3 | The maximum number of results to return |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
api_key: ${env.BRAVE_SEARCH_API_KEY:+}
|
||||
max_results: 3
|
||||
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# remote::model-context-protocol
|
||||
|
||||
## Description
|
||||
|
||||
Model Context Protocol (MCP) tool for standardized tool calling and context management.
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
{}
|
||||
|
||||
```
|
||||
|
21
docs/source/providers/tool_runtime/remote_tavily-search.md
Normal file
21
docs/source/providers/tool_runtime/remote_tavily-search.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
# remote::tavily-search
|
||||
|
||||
## Description
|
||||
|
||||
Tavily Search tool for AI-optimized web search with structured results.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `api_key` | `str \| None` | No | | The Tavily Search API Key |
|
||||
| `max_results` | `<class 'int'>` | No | 3 | The maximum number of results to return |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
api_key: ${env.TAVILY_SEARCH_API_KEY:+}
|
||||
max_results: 3
|
||||
|
||||
```
|
||||
|
19
docs/source/providers/tool_runtime/remote_wolfram-alpha.md
Normal file
19
docs/source/providers/tool_runtime/remote_wolfram-alpha.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# remote::wolfram-alpha
|
||||
|
||||
## Description
|
||||
|
||||
Wolfram Alpha tool for computational knowledge and mathematical calculations.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `api_key` | `str \| None` | No | | |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
api_key: ${env.WOLFRAM_ALPHA_API_KEY:+}
|
||||
|
||||
```
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue