Skip to content

feat(adapters): Add support for extra headers to more backend providers #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
planetf1 merged 1 commit into from
Mar 26, 2025
Merged

feat(adapters): Add support for extra headers to more backend providers #661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions python/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ BEEAI_LOG_LEVEL=INFO
########################

# OPENAI_API_KEY=your-openai-api-key
# OPENAI_API_HEADERS="secret-header=1234"

########################
### watsonx specific configuration
Expand Down Expand Up @@ -47,30 +48,38 @@ BEEAI_LOG_LEVEL=INFO
########################

# GOOGLE_VERTEX_CHAT_MODEL=gemini-2.0-flash-lite-001
# GOOGLE_VERTEX_PROJECT=""
# GOOGLE_VERTEX_LOCATION=""
# GOOGLE_VERTEX_PROJECT=your-vertexai-project
# GOOGLE_VERTEX_LOCATION=your-vertexai-location
# GOOGLE_VERTEX_API_HEADERS="secret-header=1234"


########################
### Amazon Bedrock specific configuration
########################

# AWS_ACCESS_KEY_ID=
# AWS_SECRET_ACCESS_KEY=
# AWS_REGION=
# AWS_CHAT_MODEL=
# AWS_ACCESS_KEY_ID=your-aws-access-key
# AWS_SECRET_ACCESS_KEY=your-secret-access-key
# AWS_REGION=your-aws-region
# AWS_CHAT_MODEL=llama-3.1-8b-instant
# AWS_API_HEADERS="secret-header=1234"


########################
### Anthropic specific configuration
########################

# ANTHROPIC_API_KEY=your-anthropic-api-key
# ANTHROPIC_CHAT_MODEL=claude-3-haiku-20240307"
# ANTHROPIC_API_HEADERS="secret-header=1234"


########################
### Azure OpenAI specific configuration
########################

# AZURE_OPENAI_API_KEY=
# AZURE_OPENAI_API_BASE=
# AZURE_OPENAI_API_VERSION=
# AZURE_OPENAI_CHAT_MODEL=
# AZURE_OPENAI_API_KEY=your-azure-api-key
# AZURE_OPENAI_API_BASE=your-base-url
# AZURE_OPENAI_API_VERSION=2024-10-21
# AZURE_OPENAI_CHAT_MODEL=gpt-4o-mini
# AZURE_OPENAI_API_HEADERS="secret-header=1234"

4 changes: 4 additions & 0 deletions python/beeai_framework/adapters/amazon_bedrock/backend/chat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import os
from typing import Any

from beeai_framework.adapters.litellm import utils
from beeai_framework.adapters.litellm.chat import LiteLLMChatModel
from beeai_framework.backend.constants import ProviderName
from beeai_framework.logger import Logger
Expand Down Expand Up @@ -68,3 +69,6 @@ def __init__(self, model_id: str | None = None, settings: dict[str, Any] | None
"aws_region_name": aws_region_name,
},
)
self._settings["extra_headers"] = utils.parse_extra_headers(
self._settings.get("extra_headers"), os.getenv("AWS_API_HEADERS")
)
4 changes: 4 additions & 0 deletions python/beeai_framework/adapters/anthropic/backend/chat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

from dotenv import load_dotenv

from beeai_framework.adapters.litellm import utils
from beeai_framework.adapters.litellm.chat import LiteLLMChatModel
from beeai_framework.backend.constants import ProviderName
from beeai_framework.logger import Logger
Expand Down Expand Up @@ -45,3 +46,6 @@ def __init__(self, model_id: str | None = None, settings: dict[str, Any] | None
provider_id="anthropic",
settings=_settings | {"api_key": api_key},
)
self._settings["extra_headers"] = utils.parse_extra_headers(
self._settings.get("extra_headers"), os.getenv("ANTHROPIC_API_HEADERS")
)
4 changes: 4 additions & 0 deletions python/beeai_framework/adapters/azure_openai/backend/chat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

from dotenv import load_dotenv

from beeai_framework.adapters.litellm import utils
from beeai_framework.adapters.litellm.chat import LiteLLMChatModel
from beeai_framework.backend.constants import ProviderName
from beeai_framework.logger import Logger
Expand Down Expand Up @@ -123,3 +124,6 @@ def __init__(self, model_id: str | None = None, settings: dict[str, Any] | None
provider_id="azure", # LiteLLM uses 'azure' for Azure OpenAI
settings=config,
)
self._settings["extra_headers"] = utils.parse_extra_headers(
self._settings.get("extra_headers"), os.getenv("AZURE_OPENAI_API_HEADERS")
)
6 changes: 5 additions & 1 deletion python/beeai_framework/adapters/vertexai/backend/chat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import os
from typing import Any

from beeai_framework.adapters.litellm import utils
from beeai_framework.adapters.litellm.chat import LiteLLMChatModel
from beeai_framework.backend.constants import ProviderName
from beeai_framework.logger import Logger
Expand Down Expand Up @@ -44,11 +45,14 @@ def __init__(self, model_id: str | None = None, settings: dict[str, Any] | None
# Set GOOGLE_APPLICATION_CREDENTIALS / GOOGLE_CREDENTIALS / GOOGLE_APPLICATION_CREDENTIALS_JSON

super().__init__(
model_id if model_id else os.getenv("VERTEXAI_CHAT_MODEL", "geminid-2.0-flash-lite-001"),
model_id if model_id else os.getenv("GOOGLE_VERTEX_CHAT_MODEL", "gemini-2.0-flash-lite-001"),
provider_id="vertex_ai",
settings=_settings
| {
"vertex_project": vertexai_project,
"vertex_location": vertexai_location,
},
)
self._settings["extra_headers"] = utils.parse_extra_headers(
self._settings.get("extra_headers"), os.getenv("GOOGLE_VERTEX_API_HEADERS")
)
8 changes: 4 additions & 4 deletions python/docs/backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ The following table depicts supported providers. Each provider requires specific
| `OpenAI` | ✅ | | `openai` | OPENAI_CHAT_MODEL<br/>OPENAI_API_BASE<br/>OPENAI_API_KEY<br/>OPENAI_ORGANIZATION<br>OPENAI_API_HEADERS |
| `Watsonx` | ✅ | | `@ibm-cloud/watsonx-ai` | WATSONX_CHAT_MODEL<br>WATSONX_API_KEY<br>WATSONX_PROJECT_ID<br>WATSONX_SPACE_ID<br>WATSONX_TOKEN<br>WATSONX_ZENAPIKEY<br>WATSONX_URL<br>WATSONX_REGION |
| `Groq` | ✅ | | | GROQ_CHAT_MODEL<br>GROQ_API_KEY |
| `Amazon Bedrock` | ✅ | | `boto3`| AWS_CHAT_MODEL<br>AWS_ACCESS_KEY_ID<br>AWS_SECRET_ACCESS_KEY<br>AWS_REGION |
| `Google Vertex` | ✅ | | | VERTEXAI_CHAT_MODEL<br>GOOGLE_VERTEX_PROJECT<br>GOOGLE_APPLICATION_CREDENTIALS<br>GOOGLE_APPLICATION_CREDENTIALS_JSON<br>GOOGLE_CREDENTIALS |
| `Azure OpenAI` | ✅ | | | AZURE_OPENAI_CHAT_MODEL<br>AZURE_OPENAI_API_KEY<br>AZURE_OPENAI_API_BASE<br>AZURE_OPENAI_API_VERSION<br>AZURE_AD_TOKEN<br>AZURE_API_TYPE |
| `Anthropic` | ✅ | | | ANTHROPIC_CHAT_MODEL<br>ANTHROPIC_API_KEY |
| `Amazon Bedrock` | ✅ | | `boto3`| AWS_CHAT_MODEL<br>AWS_ACCESS_KEY_ID<br>AWS_SECRET_ACCESS_KEY<br>AWS_REGION<br>AWS_API_HEADERS |
| `Google Vertex` | ✅ | | | GOOGLE_VERTEX_CHAT_MODEL<br>GOOGLE_VERTEX_PROJECT<br>GOOGLE_APPLICATION_CREDENTIALS<br>GOOGLE_APPLICATION_CREDENTIALS_JSON<br>GOOGLE_CREDENTIALS<br>GOOGLE_VERTEX_API_HEADERS |
| `Azure OpenAI` | ✅ | | | AZURE_OPENAI_CHAT_MODEL<br>AZURE_OPENAI_API_KEY<br>AZURE_OPENAI_API_BASE<br>AZURE_OPENAI_API_VERSION<br>AZURE_AD_TOKEN<br>AZURE_API_TYPE<br>AZURE_API_HEADERS |
| `Anthropic` | ✅ | | | ANTHROPIC_CHAT_MODEL<br>ANTHROPIC_API_KEY<br>ANTHROPIC_API_HEADERS |
| `xAI` | ✅ | | | XAI_CHAT_MODEL<br>XAI_API_KEY |

> [!TIP]
Expand Down