类class
agentscope.embeddingOpenAIEmbeddingModel
class OpenAIEmbeddingModel(EmbeddingModelBase[str | TextBlock])源码Source
agentscope/embedding/_openai/_model.py:16–185OpenAI 向量化模型，与模型服务通信并返回生成或向量化结果。位于 agentscope.embedding 包，继承自 EmbeddingModelBase[str | TextBlock]。
Supports text-embedding-3-small, text-embedding-3-large,
and other OpenAI-compatible embedding models. Inherits batching
and retry logic from :class:EmbeddingModelBase. TextBlock
items in the input list are unpacked to their .text field by
the base class before _call_api runs, so this subclass only
has to handle plain str.
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
def __init__(credential: CredentialBase, model: str, dimensions: int | None, parameters: 'OpenAIEmbeddingModel.Paramete… | 初始化 `OpenAIEmbeddingModel` 实例。 Initialize the OpenAI embedding model. |
构造器详情Constructor Detail
OpenAIEmbeddingModel
def __init__(credential: CredentialBase, model: str, dimensions: int | None, parameters: 'OpenAIEmbeddingModel.Parameters | None' = None, pass_dimensions: bool = True, embedding_cache: EmbeddingCacheBase | None = None, context_size: int = 8191, max_retries: int = 3, retry_delay: float = 1.0) -> None初始化 OpenAIEmbeddingModel 实例。
Initialize the OpenAI embedding model.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
credential | CredentialBase | 凭证对象（类型 `CredentialBase`）。An :class:`~agentscope.credential.OpenAICredential` instance providing the API key and optional base URL / organization. |
model | str | 模型实例（类型 `str`）。The embedding model name (e.g. `"text-embedding-3-small"`). |
dimensions | int | None | 向量维度（类型 `int | None`）。The output embedding vector dimensions. Required at the contract level — see :class:`EmbeddingModelBase` for the rationale. `None` is accepted only for backward compatibility with legacy configs that persisted `dimensions` inside `parameters`. |
parameters默认default None | 'OpenAIEmbeddingModel.Parameters | None' | 参数（类型 `'OpenAIEmbeddingModel.Parameters | None'`）。Provider-specific non-dimensional parameters. Currently empty for OpenAI. |
pass_dimensions默认default True | bool | pass 维度（类型 `bool`）。Whether to pass the `dimensions` parameter to the API. Some OpenAI-compatible providers do not support it. |
embedding_cache默认default None | EmbeddingCacheBase | None | 向量化缓存（类型 `EmbeddingCacheBase | None`）。Optional embedding cache. |
context_size默认default 8191 | int | 上下文大小（类型 `int`）。Maximum input tokens per text. |
max_retries默认default 3 | int | 最大重试次数（类型 `int`）。Number of retries on transient failures. |
retry_delay默认default 1.0 | float | 重试延迟（类型 `float`）。Seconds between retry attempts. |
源码Source
agentscope/embedding/_openai/_model.py:32–101