andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-01-26 16:48:13 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

'added docs for config based on agent review'

Browse Source
This commit is contained in:
Nick Fujita
2025-02-20 18:11:16 +09:00
parent 276f661e6c
commit 6f849c0e6d
1 changed files with 47 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
src/crewai/utilities/embedding_configurator.py
View File

@@ -7,22 +7,61 @@ from pydantic import BaseModel
class EmbeddingProviderConfig(BaseModel): class EmbeddingProviderConfig(BaseModel):
"""Configuration model for embedding providers.
Attributes:
# Core Model Configuration
model (str | None): The model identifier for embeddings, used across multiple providers
like OpenAI, Azure, Watson, etc.
embedder (str | Callable | None): Custom embedding function or callable for custom
embedding implementations.
# API Authentication & Configuration
api_key (str | None): Authentication key for various providers (OpenAI, VertexAI,
Google, Cohere, VoyageAI, Watson).
api_base (str | None): Base API URL override for OpenAI and Azure services.
api_type (str | None): API type specification, particularly used for Azure configuration.
api_version (str | None): API version for OpenAI and Azure services.
api_url (str | None): API endpoint URL, used by HuggingFace and Watson services.
url (str | None): Base URL for the embedding service, primarily used for Ollama and
HuggingFace endpoints.
# Service-Specific Configuration
project_id (str | None): Project identifier used by VertexAI and Watson services.
organization_id (str | None): Organization identifier for OpenAI and Azure services.
deployment_id (str | None): Deployment identifier for OpenAI and Azure services.
region (str | None): Geographic region for VertexAI services.
session (str | None): Session configuration for Amazon Bedrock embeddings.
# Request Configuration
task_type (str | None): Specifies the task type for Google Generative AI embeddings.
default_headers (str | None): Custom headers for OpenAI and Azure API requests.
dimensions (str | None): Output dimensions specification for OpenAI and Azure embeddings.
"""
# Core Model Configuration
model: str | None = None model: str | None = None
url: str | None = None
project_id: str | None = None
region: str | None = None
task_type: str | None = None
session: str | None = None
api_url: str | None = None
embedder: str | Callable | None = None embedder: str | Callable | None = None
# API Authentication & Configuration
api_key: str | None = None api_key: str | None = None
api_base: str | None = None api_base: str | None = None
api_type: str | None = None api_type: str | None = None
api_version: str | None = None api_version: str | None = None
api_url: str | None = None
url: str | None = None
# Service-Specific Configuration
project_id: str | None = None
organization_id: str | None = None
deployment_id: str | None = None
region: str | None = None
session: str | None = None
# Request Configuration
task_type: str | None = None
default_headers: str | None = None default_headers: str | None = None
dimensions: str | None = None dimensions: str | None = None
deployment_id: str | None = None
organization_id: str | None = None
class EmbeddingConfig(BaseModel): class EmbeddingConfig(BaseModel):