langchain_community.embeddings.anyscale.AnyscaleEmbeddings

class langchain_community.embeddings.anyscale.AnyscaleEmbeddings[源代码]

继承自: OpenAIEmbeddings

Anyscale Embeddings API。

通过解析和验证输入参数中的数据来创建一个新的模型。

如果输入数据无法解析成有效的模型,将引发 ValidationError。

参数 allowed_special: Union[Literal['all'], Set[str]] = {}
参数 anyscale_api_base : str = 'https://api.endpoints.anyscale.com/v1'

API请求的基础URL路径。

参数 anyscale_api_key : SecretStr = None

Anyscale端点API密钥。

约束
  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

参数 chunk_size : int = 1000

每批嵌入的最大文本数量

参数 default_headers : Union[Mapping[str, str], None] = None
param default_query: Union[Mapping[str, object], None] = None
param deployment: Optional[str] = 'text-embedding-ada-002'
param disallowed_special: Union[Literal['all'], Set[str], Sequence[str]] = 'all'
param embedding_ctx_length: int = 500

每次嵌入的令牌最大数量。

param headers: Any = None
param http_client: Union[Any, None] = None

可选的httpx.Client。

param max_retries: int = 2

生成时最大重试次数。

参数 model: str = 'thenlper/gte-large'

要使用的模型名称。

参数 model_kwargs: Dict[str, Any] [可选]

保存所有有效的模型参数,用于 create 调用,但没有明确指定。

参数 openai_api_base: Optional[str] = None (别名 'base_url')

API请求的基本URL路径,如果不使用代理或服务模拟器,则留空。

参数 openai_api_key: Optional[str] = None (别名 'api_key')

如果未提供,将自动从环境变量 OPENAI_API_KEY 中推断。

参数 openai_api_type: Optional[str] = None
参数 openai_api_version: Optional[str] = None (别名 'api_version')

如果未提供,将自动从环境变量 OPENAI_API_VERSION 中推断。

参数 openai_organization: Optional[str] = None (别名 'organization')

如果未提供,将自动从环境变量 OPENAI_ORG_ID 中推断。

参数 openai_proxy: Optional[str] = None
参数 request_timeout: Optional[Union[float, Tuple[float, float], Any]] = None (别名'timeout')

请求OpenAI完成API的超时时间。可以是浮点数、httpx.Timeout或None。

参数 retry_max_seconds: int = 20

重试之间的最大等待秒数

参数 retry_min_seconds: int = 4

重试之间的最小等待秒数

参数 show_progress_bar: bool = False

在嵌入时是否显示进度条

参数 skip_empty: bool = False

在嵌入时是否跳过空字符串或引发错误。默认情况下不跳过。

参数 tiktoken_enabled: bool = False

对于非OpenAI实现的嵌入API,请将此设置为False

参数 tiktoken_model_name: Optional[str] = None

在使用该类时,传递给Tiktoken的模式名称。Tiktoken用于统计文档中的令牌数量,以将它们限制在一定限制内。默认情况下,当设置为None时,这与嵌入模型的名称相同。但是,在某些情况下,您可能希望使用此嵌入类与不支持Tiktoken的模式名称。这可能包括在使用Azure嵌入或使用许多公开类似OpenAI API但使用不同模型的一个模型提供者时。在这些情况下,为了避免在调用Tiktoken时出错,您可以在此处指定要使用的模型名称。

async aembed_documents(texts: List[str], chunk_size: Optional[int] = 0) List[List[float]]

异步调用OpenAI的嵌入端点进行嵌入搜索文档。

参数
  • texts (List[str]) – 要嵌入的文本列表。

  • chunk_size (Optional[int]) – 嵌入的块大小。如果为None,将使用类指定的块大小。

返回

嵌入列表,每个文本一个。

返回类型

List[List[float]]

async aembed_query(text: str) List[float]

异步调用OpenAI的嵌入端点进行嵌入查询文本。

参数

text (str) – 要嵌入的文本。

返回

文本的嵌入。

返回类型

List[float]

embed_documents(texts: List[str], chunk_size: Optional[int] = 0) List[List[float]]

调用OpenAI的嵌入端点以嵌入搜索文档。

参数
  • texts (List[str]) – 要嵌入的文本列表。

  • chunk_size (Optional[int]) – 嵌入的块大小。如果为None,将使用类指定的块大小。

返回

嵌入列表,每个文本一个。

返回类型

List[List[float]]

embed_query(text: str) List[float]

调用OpenAI的嵌入端点以嵌入查询文本。

参数

text (str) – 要嵌入的文本。

返回

文本的嵌入。

返回类型

List[float]

使用AnyscaleEmbeddings的示例