openai
__all__ = ['OpenAiEmbeddingDriver', 'AzureOpenAiEmbeddingDriver']
module-attribute
AzureOpenAiEmbeddingDriver
Bases: OpenAiEmbeddingDriver
Azure OpenAi Embedding Driver.
Attributes:
Name | Type | Description |
---|---|---|
azure_deployment |
str
|
An optional Azure OpenAi deployment id. Defaults to the model name. |
azure_endpoint |
str
|
An Azure OpenAi endpoint. |
azure_ad_token |
Optional[str]
|
An optional Azure Active Directory token. |
azure_ad_token_provider |
Optional[Callable[[], str]]
|
An optional Azure Active Directory token provider. |
api_version |
str
|
An Azure OpenAi API version. |
tokenizer |
OpenAiTokenizer
|
An |
client |
AzureOpenAI
|
An |
Source code in griptape/drivers/embedding/azure_openai_embedding_driver.py
api_version: str = field(default='2024-10-21', kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
azure_ad_token: Optional[str] = field(kw_only=True, default=None, metadata={'serializable': False})
class-attribute
instance-attribute
azure_ad_token_provider: Optional[Callable[[], str]] = field(kw_only=True, default=None, metadata={'serializable': False})
class-attribute
instance-attribute
azure_deployment: str = field(kw_only=True, default=Factory(lambda self: self.model, takes_self=True), metadata={'serializable': True})
class-attribute
instance-attribute
azure_endpoint: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
tokenizer: OpenAiTokenizer = field(default=Factory(lambda self: OpenAiTokenizer(model=self.model), takes_self=True), kw_only=True)
class-attribute
instance-attribute
client()
Source code in griptape/drivers/embedding/azure_openai_embedding_driver.py
OpenAiEmbeddingDriver
Bases: BaseEmbeddingDriver
OpenAI Embedding Driver.
Attributes:
Name | Type | Description |
---|---|---|
model |
str
|
OpenAI embedding model name. Defaults to |
base_url |
Optional[str]
|
API URL. Defaults to OpenAI's v1 API URL. |
api_key |
Optional[str]
|
API key to pass directly. Defaults to |
organization |
Optional[str]
|
OpenAI organization. Defaults to 'OPENAI_ORGANIZATION' environment variable. |
tokenizer |
OpenAiTokenizer
|
Optionally provide custom |
client |
OpenAI
|
Optionally provide custom |
azure_deployment |
OpenAI
|
An Azure OpenAi deployment id. |
azure_endpoint |
OpenAI
|
An Azure OpenAi endpoint. |
azure_ad_token |
OpenAI
|
An optional Azure Active Directory token. |
azure_ad_token_provider |
OpenAI
|
An optional Azure Active Directory token provider. |
api_version |
OpenAI
|
An Azure OpenAi API version. |