mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-17 16:42:44 +00:00
docs: provider and distro codegen migration (#3531)
# What does this PR do? <!-- 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] --> - Updates provider and distro codegen to handle the new format - Migrates provider and distro files to the new format ## Test Plan - Manual testing <!-- 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
45da31801c
commit
d23865757f
103 changed files with 1796 additions and 423 deletions
19
docs/docs/providers/safety/index.mdx
Normal file
19
docs/docs/providers/safety/index.mdx
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
sidebar_label: Safety
|
||||
title: Safety
|
||||
---
|
||||
|
||||
# Safety
|
||||
|
||||
## Overview
|
||||
|
||||
This section contains documentation for all available providers for the **safety** API.
|
||||
|
||||
## Providers
|
||||
|
||||
- [Code-Scanner](./inline_code-scanner)
|
||||
- [Llama-Guard](./inline_llama-guard)
|
||||
- [Prompt-Guard](./inline_prompt-guard)
|
||||
- [Remote - Bedrock](./remote_bedrock)
|
||||
- [Remote - Nvidia](./remote_nvidia)
|
||||
- [Remote - Sambanova](./remote_sambanova)
|
||||
17
docs/docs/providers/safety/inline_code-scanner.mdx
Normal file
17
docs/docs/providers/safety/inline_code-scanner.mdx
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
description: "Code Scanner safety provider for detecting security vulnerabilities and unsafe code patterns."
|
||||
sidebar_label: Code-Scanner
|
||||
title: inline::code-scanner
|
||||
---
|
||||
|
||||
# inline::code-scanner
|
||||
|
||||
## Description
|
||||
|
||||
Code Scanner safety provider for detecting security vulnerabilities and unsafe code patterns.
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
{}
|
||||
```
|
||||
23
docs/docs/providers/safety/inline_llama-guard.mdx
Normal file
23
docs/docs/providers/safety/inline_llama-guard.mdx
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
description: "Llama Guard safety provider for content moderation and safety filtering using Meta's Llama Guard model."
|
||||
sidebar_label: Llama-Guard
|
||||
title: inline::llama-guard
|
||||
---
|
||||
|
||||
# inline::llama-guard
|
||||
|
||||
## Description
|
||||
|
||||
Llama Guard safety provider for content moderation and safety filtering using Meta's Llama Guard model.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `excluded_categories` | `list[str` | No | [] | |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
excluded_categories: []
|
||||
```
|
||||
23
docs/docs/providers/safety/inline_prompt-guard.mdx
Normal file
23
docs/docs/providers/safety/inline_prompt-guard.mdx
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
description: "Prompt Guard safety provider for detecting and filtering unsafe prompts and content."
|
||||
sidebar_label: Prompt-Guard
|
||||
title: inline::prompt-guard
|
||||
---
|
||||
|
||||
# inline::prompt-guard
|
||||
|
||||
## Description
|
||||
|
||||
Prompt Guard safety provider for detecting and filtering unsafe prompts and content.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `guard_type` | `<class 'str'>` | No | injection | |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
guard_type: injection
|
||||
```
|
||||
32
docs/docs/providers/safety/remote_bedrock.mdx
Normal file
32
docs/docs/providers/safety/remote_bedrock.mdx
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
description: "AWS Bedrock safety provider for content moderation using AWS's safety services."
|
||||
sidebar_label: Remote - Bedrock
|
||||
title: remote::bedrock
|
||||
---
|
||||
|
||||
# remote::bedrock
|
||||
|
||||
## Description
|
||||
|
||||
AWS Bedrock safety provider for content moderation using AWS's safety services.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `aws_access_key_id` | `str \| None` | No | | The AWS access key to use. Default use environment variable: AWS_ACCESS_KEY_ID |
|
||||
| `aws_secret_access_key` | `str \| None` | No | | The AWS secret access key to use. Default use environment variable: AWS_SECRET_ACCESS_KEY |
|
||||
| `aws_session_token` | `str \| None` | No | | The AWS session token to use. Default use environment variable: AWS_SESSION_TOKEN |
|
||||
| `region_name` | `str \| None` | No | | The default AWS Region to use, for example, us-west-1 or us-west-2.Default use environment variable: AWS_DEFAULT_REGION |
|
||||
| `profile_name` | `str \| None` | No | | The profile name that contains credentials to use.Default use environment variable: AWS_PROFILE |
|
||||
| `total_max_attempts` | `int \| None` | No | | An integer representing the maximum number of attempts that will be made for a single request, including the initial attempt. Default use environment variable: AWS_MAX_ATTEMPTS |
|
||||
| `retry_mode` | `str \| None` | No | | A string representing the type of retries Boto3 will perform.Default use environment variable: AWS_RETRY_MODE |
|
||||
| `connect_timeout` | `float \| None` | No | 60.0 | The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. |
|
||||
| `read_timeout` | `float \| None` | No | 60.0 | The time in seconds till a timeout exception is thrown when attempting to read from a connection.The default is 60 seconds. |
|
||||
| `session_ttl` | `int \| None` | No | 3600 | The time in seconds till a session expires. The default is 3600 seconds (1 hour). |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
{}
|
||||
```
|
||||
25
docs/docs/providers/safety/remote_nvidia.mdx
Normal file
25
docs/docs/providers/safety/remote_nvidia.mdx
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
description: "NVIDIA's safety provider for content moderation and safety filtering."
|
||||
sidebar_label: Remote - Nvidia
|
||||
title: remote::nvidia
|
||||
---
|
||||
|
||||
# remote::nvidia
|
||||
|
||||
## Description
|
||||
|
||||
NVIDIA's safety provider for content moderation and safety filtering.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `guardrails_service_url` | `<class 'str'>` | No | http://0.0.0.0:7331 | The url for accessing the Guardrails service |
|
||||
| `config_id` | `str \| None` | No | self-check | Guardrails configuration ID to use from the Guardrails configuration store |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
guardrails_service_url: ${env.GUARDRAILS_SERVICE_URL:=http://localhost:7331}
|
||||
config_id: ${env.NVIDIA_GUARDRAILS_CONFIG_ID:=self-check}
|
||||
```
|
||||
25
docs/docs/providers/safety/remote_sambanova.mdx
Normal file
25
docs/docs/providers/safety/remote_sambanova.mdx
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
description: "SambaNova's safety provider for content moderation and safety filtering."
|
||||
sidebar_label: Remote - Sambanova
|
||||
title: remote::sambanova
|
||||
---
|
||||
|
||||
# remote::sambanova
|
||||
|
||||
## Description
|
||||
|
||||
SambaNova's safety provider for content moderation and safety filtering.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `url` | `<class 'str'>` | No | https://api.sambanova.ai/v1 | The URL for the SambaNova AI server |
|
||||
| `api_key` | `pydantic.types.SecretStr \| None` | No | | The SambaNova cloud API Key |
|
||||
|
||||
## Sample Configuration
|
||||
|
||||
```yaml
|
||||
url: https://api.sambanova.ai/v1
|
||||
api_key: ${env.SAMBANOVA_API_KEY:=}
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue