diff --git a/docs/community/model-providers/fireworksai.md b/docs/community/model-providers/fireworksai.md new file mode 100644 index 00000000..040bccdb --- /dev/null +++ b/docs/community/model-providers/fireworksai.md @@ -0,0 +1,80 @@ +# FireworksAI + +{{ community_contribution_banner }} + +[Fireworks AI](https://fireworks.ai) provides blazing fast inference for open-source language models. Fireworks AI is accessible through OpenAI's SDK via full API compatibility, allowing easy and portable integration with the Strands Agents SDK using the familiar OpenAI interface. + +## Installation + +The Strands Agents SDK provides access to Fireworks AI models through the OpenAI compatibility layer, configured as an optional dependency. To install, run: + +```bash +pip install 'strands-agents[openai]' strands-agents-tools +``` + +## Usage + +After installing the `openai` package, you can import and initialize the Strands Agents' OpenAI-compatible provider for Fireworks AI models as follows: + +```python +from strands import Agent +from strands.models.openai import OpenAIModel +from strands_tools import calculator + +model = OpenAIModel( + client_args={ + "api_key": "", + "base_url": "https://api.fireworks.ai/inference/v1", + }, + model_id="accounts/fireworks/models/deepseek-v3p1-terminus", # or see https://fireworks.ai/models + params={ + "max_tokens": 5000, + "temperature": 0.1 + } +) + +agent = Agent(model=model, tools=[calculator]) +agent("What is 2+2?") +``` + +## Configuration + +### Client Configuration + +The `client_args` configure the underlying OpenAI-compatible client. When using Fireworks AI, you must set: + +* `api_key`: Your Fireworks AI API key. Get one from the [Fireworks AI Console](https://app.fireworks.ai/settings/users/api-keys). +* `base_url`: `https://api.fireworks.ai/inference/v1` + +Refer to [OpenAI Python SDK GitHub](https://github.com/openai/openai-python) for full client options. + +### Model Configuration + +The `model_config` specifies which Fireworks AI model to use and any additional parameters. + +| Parameter | Description | Example | Options | +| ---------- | ------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------ | +| `model_id` | Model name | `accounts/fireworks/models/deepseek-v3p1-terminus` | See [Fireworks Models](https://fireworks.ai/models) | +| `params` | Model-specific parameters | `{"max_tokens": 5000, "temperature": 0.7, "top_p": 0.9}` | [API reference](https://docs.fireworks.ai/api-reference) | + +## Troubleshooting + +### `ModuleNotFoundError: No module named 'openai'` + +You must install the `openai` dependency to use this provider: + +```bash +pip install 'strands-agents[openai]' +``` + +### Unexpected model behavior? + +Ensure you're using a model ID compatible with Fireworks AI (e.g., `accounts/fireworks/models/deepseek-v3p1-terminus`, `accounts/fireworks/models/kimi-k2-instruct-0905`), and your `base_url` is set to `https://api.fireworks.ai/inference/v1`. + +## References + +* [Fireworks AI OpenAI Compatibility Guide](https://fireworks.ai/docs/tools-sdks/openai-compatibility#openai-compatibility) +* [Fireworks AI API Reference](https://docs.fireworks.ai/api-reference) +* [Fireworks AI Models](https://fireworks.ai/models) +* [OpenAI Python SDK](https://github.com/openai/openai-python) +* [Strands Agents API](../../api-reference/models.md) \ No newline at end of file diff --git a/docs/user-guide/concepts/model-providers/fireworksai.md b/docs/user-guide/concepts/model-providers/fireworksai.md new file mode 100644 index 00000000..9f7912fe --- /dev/null +++ b/docs/user-guide/concepts/model-providers/fireworksai.md @@ -0,0 +1,5 @@ + + + +This guide has moved to [community/model-providers/fireworksai](../../../community/model-providers/fireworksai.md). + diff --git a/docs/user-guide/quickstart.md b/docs/user-guide/quickstart.md index 7b3b032d..43caa9b9 100644 --- a/docs/user-guide/quickstart.md +++ b/docs/user-guide/quickstart.md @@ -444,6 +444,7 @@ Strands Agents supports several other model providers beyond Amazon Bedrock: - **[Writer](concepts/model-providers/writer.md)** - Access to Palmyra models - **[Cohere community](../community/model-providers/cohere.md)** - Use Cohere models through an OpenAI compatible interface - **[CLOVA Studio community](../community/model-providers/clova-studio.md)** - Korean-optimized AI models from Naver Cloud Platform +- **[FireworksAI community](../community/model-providers/fireworksai.md)** - Use FireworksAI models through an OpenAI compatible interface - **[Custom Providers](concepts/model-providers/custom_model_provider.md)** - Build your own provider for specialized needs ## Capturing Streamed Data & Events diff --git a/mkdocs.yml b/mkdocs.yml index dcd2f21f..6171bd53 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -103,6 +103,7 @@ nav: - Custom Providers: user-guide/concepts/model-providers/custom_model_provider.md - Cohere community: user-guide/concepts/model-providers/cohere.md # ALWAYS ADD A SPACE BEFORE COMMUNITY - CLOVA Studio community: user-guide/concepts/model-providers/clova-studio.md + - FireworksAI community: user-guide/concepts/model-providers/fireworksai.md - Streaming: - Overview: user-guide/concepts/streaming/overview.md - Async Iterators: user-guide/concepts/streaming/async-iterators.md @@ -153,6 +154,7 @@ nav: - Model Providers: - Cohere: community/model-providers/cohere.md - CLOVA Studio: community/model-providers/clova-studio.md + - Fireworks AI: community/model-providers/fireworksai.md - Contribute ❤️: https://github.com/strands-agents/sdk-python/blob/main/CONTRIBUTING.md - API Reference: