AzureSearch

class langchain_community.vectorstores.azuresearch.AzureSearch(azure_search_endpoint: str, azure_search_key: str | None, index_name: str, embedding_function: Callable | Embeddings, search_type: str = 'hybrid', semantic_configuration_name: str | None = None, fields: List[SearchField] | None = None, vector_search: VectorSearch | None = None, semantic_configurations: SemanticConfiguration | List[SemanticConfiguration] | None = None, scoring_profiles: List[ScoringProfile] | None = None, default_scoring_profile: str | None = None, cors_options: CorsOptions | None = None, *, vector_search_dimensions: int | None = None, additional_search_client_options: Dict[str, Any] | None = None, azure_ad_access_token: str | None = None, azure_credential: TokenCredential | None = None, azure_async_credential: AsyncTokenCredential | None = None, **kwargs: Any)

Azure Cognitive Search 向量存储。

属性

embeddings

如果可用，访问查询嵌入对象。

方法

__init__(azure_search_endpoint, ...[, ...])
aadd_documents(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
aadd_embeddings(text_embeddings[, ...])	将嵌入添加到现有索引中。
aadd_texts(texts[, metadatas, keys])	异步运行更多文本通过嵌入并添加到向量存储中。
add_documents(documents, **kwargs)	在向量存储中添加或更新文档。
add_embeddings(text_embeddings[, metadatas, ...])	将嵌入添加到现有索引中。
add_texts(texts[, metadatas, keys])	将文本数据添加到现有索引中。
adelete([ids])	通过向量ID删除。
afrom_documents(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的VectorStore。
afrom_embeddings(text_embeddings, embedding)
afrom_texts(texts, embedding[, metadatas, ...])	异步返回从文本和嵌入初始化的VectorStore。
aget_by_ids(ids, /)	通过ID异步获取文档。
ahybrid_max_marginal_relevance_search_with_score(query)	返回与查询最相似的文档，使用混合查询
ahybrid_search(query[, k])	返回与查询文本最相似的索引文档。
ahybrid_search_with_relevance_scores(query)
ahybrid_search_with_score(query[, k, filters])	返回与查询最相似的文档，使用混合查询。
amax_marginal_relevance_search(query[, k, ...])	异步返回使用最大边际相关性选择的文档。
amax_marginal_relevance_search_by_vector(...)	异步返回使用最大边际相关性选择的文档。
amax_marginal_relevance_search_with_score(query)	执行搜索并返回按MMR重新排序的结果。
as_retriever(**kwargs)	返回从此VectorStore初始化的AzureSearchVectorStoreRetriever。
asearch(query, search_type, **kwargs)	异步返回与查询最相似的文档，使用指定的搜索类型。
asemantic_hybrid_search(query[, k])	返回与查询文本最相似的索引文档。
asemantic_hybrid_search_with_score(query[, ...])	返回与查询文本最相似的索引文档。
asemantic_hybrid_search_with_score_and_rerank(query)	返回与查询最相似的文档，使用混合查询。
asimilarity_search(query[, k, search_type])	异步返回与查询最相似的文档。
asimilarity_search_by_vector(embedding[, k])	异步返回与嵌入向量最相似的文档。
asimilarity_search_with_relevance_scores(query)	异步返回文档和相关分数，范围在[0, 1]之间。
asimilarity_search_with_score(query, *[, k])	运行带距离的相似性搜索。
avector_search(query[, k, filters])	返回与查询文本最相似的索引文档。
avector_search_with_score(query[, k, filters])	返回与查询最相似的文档。
delete([ids])	通过向量ID删除。
from_documents(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
from_embeddings(text_embeddings, embedding)
from_texts(texts, embedding[, metadatas, ...])	返回从文本和嵌入初始化的VectorStore。
get_by_ids(ids, /)	通过ID获取文档。
hybrid_max_marginal_relevance_search_with_score(query)	返回与查询最相似的文档，使用混合查询
hybrid_search(query[, k])	返回与查询文本最相似的索引文档。
hybrid_search_with_relevance_scores(query[, ...])
hybrid_search_with_score(query[, k, filters])	返回与查询最相似的文档，使用混合查询。
max_marginal_relevance_search(query[, k, ...])	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_by_vector(...)	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_with_score(query)	执行搜索并返回按MMR重新排序的结果。
search(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
semantic_hybrid_search(query[, k])	返回与查询文本最相似的索引文档。
semantic_hybrid_search_with_score(query[, ...])	返回与查询文本最相似的索引文档。
semantic_hybrid_search_with_score_and_rerank(query)	返回与查询最相似的文档，使用混合查询。
similarity_search(query[, k, search_type])	返回与查询最相似的文档。
similarity_search_by_vector(embedding[, k])	返回与嵌入向量最相似的文档。
similarity_search_with_relevance_scores(query)	返回文档和相关度分数，范围在[0, 1]之间。
similarity_search_with_score(query, *[, k])	运行带有距离的相似性搜索。
vector_search(query[, k, filters])	返回与查询文本最相似的索引文档。
vector_search_with_score(query[, k, filters])	返回与查询最相似的文档。

Parameters:

• azure_search_endpoint (str)

• azure_search_key (可选[str])

• index_name (str)

• embedding_function (Union[Callable, Embeddings])

• search_type (str)

• semantic_configuration_name (可选[str])

• fields (可选[列表[SearchField]])

• vector_search (可选[VectorSearch])

• semantic_configurations (可选[联合[SemanticConfiguration, 列表[SemanticConfiguration]]])

• scoring_profiles (可选[列表[ScoringProfile]])

• default_scoring_profile (可选[str])

• cors_options (可选[CorsOptions])

• vector_search_dimensions (可选[int])

• additional_search_client_options (可选[字典[字符串, 任意类型]])

• azure_ad_access_token (可选[str])

• azure_credential (可选[TokenCredential])

• azure_async_credential (可选[AsyncTokenCredential])

• kwargs (Any)

__init__(azure_search_endpoint: str, azure_search_key: str | None, index_name: str, embedding_function: Callable | Embeddings, search_type: str = 'hybrid', semantic_configuration_name: str | None = None, fields: List[SearchField] | None = None, vector_search: VectorSearch | None = None, semantic_configurations: SemanticConfiguration | List[SemanticConfiguration] | None = None, scoring_profiles: List[ScoringProfile] | None = None, default_scoring_profile: str | None = None, cors_options: CorsOptions | None = None, *, vector_search_dimensions: int | None = None, additional_search_client_options: Dict[str, Any] | None = None, azure_ad_access_token: str | None = None, azure_credential: TokenCredential | None = None, azure_async_credential: AsyncTokenCredential | None = None, **kwargs: Any)

Parameters:

• azure_search_endpoint (str)

• azure_search_key (可选[str])

• index_name (str)

• embedding_function (Union[Callable, Embeddings])

• search_type (str)

• semantic_configuration_name (可选[str])

• fields (可选[列表[SearchField]])

• vector_search (可选[VectorSearch])

• semantic_configurations (可选[联合[SemanticConfiguration, 列表[SemanticConfiguration]]])

• scoring_profiles (可选[列表[ScoringProfile]])

• default_scoring_profile (可选[str])

• cors_options (可选[CorsOptions])

• vector_search_dimensions (可选[int])

• additional_search_client_options (可选[字典[字符串, 任意类型]])

• azure_ad_access_token (可选[str])

• azure_credential (可选[TokenCredential])

• azure_async_credential (可选[AsyncTokenCredential])

• kwargs (Any)

async aadd_documents(documents: list[Document], **kwargs: Any) → list[str]

通过嵌入异步运行更多文档并将其添加到向量存储中。

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档。

• kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果ID的数量与文档的数量不匹配。

Return type:

列表[字符串]

async aadd_embeddings(text_embeddings: Iterable[Tuple[str, List[float]]], metadatas: List[dict] | None = None, *, keys: List[str] | None = None) → List[str]

向现有索引添加嵌入。

Parameters:

• text_embeddings (可迭代[元组[字符串, 列表[浮点数]]])

• metadatas (列表[字典] | 无)

• keys (列表[字符串] | 无)

Return type:

列表[str]

async aadd_texts(texts: Iterable[str], metadatas: List[dict] | None = None, *, keys: List[str] | None = None, **kwargs: Any) → List[str]

异步运行更多文本通过嵌入并添加到向量存储中。

Parameters:

• texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。

• metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。

• ids – 可选列表

• **kwargs (Any) – 向量存储特定参数。

• keys (列表[字符串] | 无)

• **kwargs

Returns:

将文本添加到向量存储中后的ID列表。

Raises:

• ValueError – 如果元数据的数量与文本的数量不匹配。

• ValueError – 如果id的数量与文本的数量不匹配。

Return type:

列表[str]

add_documents(documents: list[Document], **kwargs: Any) → list[str]

在向量存储中添加或更新文档。

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档。

• kwargs (Any) – 额外的关键字参数。 如果 kwargs 包含 ids 并且 documents 也包含 ids， kwargs 中的 ids 将优先。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果id的数量与文档的数量不匹配。

Return type:

列表[字符串]

add_embeddings(text_embeddings: Iterable[Tuple[str, List[float]]], metadatas: List[dict] | None = None, *, keys: List[str] | None = None) → List[str]

向现有索引添加嵌入。

Parameters:

• text_embeddings (可迭代[元组[字符串, 列表[浮点数]]])

• metadatas (列表[字典] | 无)

• keys (列表[字符串] | 无)

Return type:

列表[str]

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, *, keys: List[str] | None = None, **kwargs: Any) → List[str]

将文本数据添加到现有索引中。

Parameters:

• texts (可迭代对象[字符串])

• metadatas (列表[字典] | 无)

• keys (列表[字符串] | 无)

• kwargs (Any)

Return type:

列表[str]

async adelete(ids: List[str] | None = None, **kwargs: Any) → bool

按向量ID删除。

Parameters:

• ids (List[str] | None) – 要删除的ID列表。

• kwargs (Any)

Returns:

如果删除成功则为真，否则为假。

Return type:

布尔

async classmethod afrom_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) → VST

异步返回从文档和嵌入初始化的VectorStore。

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档列表。

• embedding (Embeddings) – 使用的嵌入函数。

• kwargs (Any) – 额外的关键字参数。

Returns:

从文档和嵌入初始化的VectorStore。

Return type:

VectorStore

async classmethod afrom_embeddings(text_embeddings: Iterable[Tuple[str, List[float]]], embedding: Embeddings, metadatas: List[dict] | None = None, *, azure_search_endpoint: str = '', azure_search_key: str = '', index_name: str = 'langchain-index', fields: List[SearchField] | None = None, **kwargs: Any) → AzureSearch

Parameters:

• text_embeddings (可迭代[元组[字符串, 列表[浮点数]]])

• embedding (Embeddings)

• metadatas (可选[列表[字典]])

• azure_search_endpoint (str)

• azure_search_key (str)

• index_name (str)

• fields (可选[列表[SearchField]])

• kwargs (Any)

Return type:

AzureSearch

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, azure_search_endpoint: str = '', azure_search_key: str = '', azure_ad_access_token: str | None = None, index_name: str = 'langchain-index', fields: List[SearchField] | None = None, **kwargs: Any) → AzureSearch

异步返回从文本和嵌入初始化的VectorStore。

Parameters:

• texts (List[str]) – 要添加到向量存储中的文本。

• embedding (Embeddings) – 使用的嵌入函数。

• metadatas (Optional[List[dict]]) – 可选的与文本关联的元数据列表。 默认值为 None。

• ids – 与文本关联的可选ID列表。

• kwargs (Any) – 额外的关键字参数。

• azure_search_endpoint (str)

• azure_search_key (str)

• azure_ad_access_token (可选[str])

• index_name (str)

• fields (可选[列表[SearchField]])

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

async aget_by_ids(ids: Sequence[str], /) → list[Document]

通过ID异步获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

async ahybrid_max_marginal_relevance_search_with_score(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, *, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float]]

Return docs most similar to query with a hybrid query

并按MMR重新排序结果。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int, optional) – 返回的文档数量。默认为4。

• fetch_k (int, optional) – 从总结果中选择k个。默认为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5

• filters (str, optional) – 过滤表达式。默认为 None。

• kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[文档, 浮点数]]

async ahybrid_search(query: str, k: int = 4, **kwargs: Any) → List[Document]

返回与查询文本最相似的索引文档。

Parameters:

• query (str) – 用于查找相似文档的查询文本。

• k (int) – 返回的文档数量。默认值为4。

• kwargs (Any)

Returns:

与查询文本最相似的文档列表。

Return type:

列表[Document]

async ahybrid_search_with_relevance_scores(query: str, k: int = 4, *, score_threshold: float | None = None, **kwargs: Any) → List[Tuple[Document, float]]

Parameters:

• query (str)

• k (整数)

• score_threshold (float | None)

• kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]

async ahybrid_search_with_score(query: str, k: int = 4, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float]]

返回与混合查询最相似的文档。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int) – 返回的文档数量。默认为4。

• filters (str | None)

• kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[文档, 浮点数]]

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]

异步返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int) – 返回的文档数量。默认为4。

• fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• kwargs (Any)

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

async amax_marginal_relevance_search_by_vector(embedding: list[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]

异步返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

• embedding (list[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

async amax_marginal_relevance_search_with_score(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, *, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float]]

执行搜索并返回按MMR重新排序的结果。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int, optional) – 返回多少个结果。默认为4。

• fetch_k (int, optional) – 从总结果中选择k个。默认为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5

• filters (str, optional) – 过滤表达式。默认为 None。

• kwargs (Any)

Returns:

最相似的文档列表

查询及其对应的分数

Return type:

列表[元组[Document, 浮点数]]

as_retriever(**kwargs: Any) → AzureSearchVectorStoreRetriever

返回从此VectorStore初始化的AzureSearchVectorStoreRetriever。

Parameters:

• search_type (Optional[str]) – 覆盖检索器应执行的搜索类型。默认为 self.search_type。可以是“similarity”（相似性）、“hybrid”（混合）或“semantic_hybrid”（语义混合）。

• search_kwargs (Optional[Dict]) –

  传递给搜索函数的关键字参数。可以包括以下内容：

  score_threshold: 最小相关性阈值

  用于similarity_score_threshold

  fetch_k: 传递给MMR算法的文档数量（默认：20） lambda_mult: MMR返回结果的多样性；

  1表示最小多样性，0表示最大多样性。（默认：0.5）

  filter: 按文档元数据进行过滤

• kwargs (Any)

Returns:

VectorStore的检索器类。

Return type:

AzureSearchVectorStoreRetriever

async asearch(query: str, search_type: str, **kwargs: Any) → list[Document]

异步返回与查询最相似的文档，使用指定的搜索类型。

Parameters:

• query (str) – 输入文本。

• search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

async asemantic_hybrid_search(query: str, k: int = 4, **kwargs: Any) → List[Document]

返回与查询文本最相似的索引文档。

Parameters:

• query (str) – 用于查找相似文档的查询文本。

• k (int) – 返回的文档数量。默认值为4。

• filters – 过滤表达式。

• kwargs (Any)

Returns:

与查询文本最相似的文档列表。

Return type:

列表[Document]

async asemantic_hybrid_search_with_score(query: str, k: int = 4, score_type: Literal['score', 'reranker_score'] = 'score', *, score_threshold: float | None = None, **kwargs: Any) → List[Tuple[Document, float]]

返回与查询文本最相似的索引文档。

Parameters:

• query (str) – 用于查找相似文档的查询文本。

• k (int) – 返回的文档数量。默认值为4。

• score_type (Literal['score', 'reranker_score']) – 必须是“score”或“reranker_score”。 默认为“score”。

• filters – 过滤表达式。

• score_threshold (float | None)

• kwargs (Any)

Returns:

文档列表及其

对应的分数。

Return type:

列表[元组[Document, 浮点数]]

async asemantic_hybrid_search_with_score_and_rerank(query: str, k: int = 4, *, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float, float]]

返回与混合查询最相似的文档。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int) – 返回的文档数量。默认为4。

• filters (str | None) – 过滤表达式。

• kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[文档, 浮点数, 浮点数]]

async asimilarity_search(query: str, k: int = 4, *, search_type: str | None = None, **kwargs: Any) → List[Document]

异步返回与查询最相似的文档。

Parameters:

• query (str) – 输入文本。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) – 传递给搜索方法的参数。

• search_type (str | None)

• **kwargs

Returns:

与查询最相似的文档列表。

Return type:

列表[文档]

async asimilarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) → list[Document]

异步返回与嵌入向量最相似的文档。

Parameters:

• embedding (list[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询向量最相似的文档列表。

Return type:

列表[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, *, score_threshold: float | None = None, **kwargs: Any) → List[Tuple[Document, float]]

异步返回文档和相关度分数，范围在[0, 1]之间。

0 表示不相似，1 表示最相似。

Parameters:

• query (str) – 输入文本。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) –

  传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

  过滤检索到的文档集

• score_threshold (float | None)

• **kwargs

Returns:

（文档，相似度分数）的元组列表

Return type:

列表[元组[文档, 浮点数]]

async asimilarity_search_with_score(query: str, *, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

使用距离运行相似性搜索。

Parameters:

• query (str)

• k (整数)

• kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]

async avector_search(query: str, k: int = 4, *, filters: str | None = None, **kwargs: Any) → List[Document]

返回与查询文本最相似的索引文档。

Parameters:

• query (str) – 用于查找相似文档的查询文本。

• k (int) – 返回的文档数量。默认值为4。

• filters (str | None)

• kwargs (Any)

Returns:

与查询文本最相似的文档列表。

Return type:

列表[Document]

async avector_search_with_score(query: str, k: int = 4, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float]]

返回与查询最相似的文档。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int, optional) – 返回的文档数量。默认为4。

• filters (str, optional) – 过滤表达式。默认为 None。

• kwargs (Any)

Returns:

最相似的文档列表

查询及其对应的分数

Return type:

列表[元组[Document, 浮点数]]

delete(ids: List[str] | None = None, **kwargs: Any) → bool

按向量ID删除。

Parameters:

• ids (List[str] | None) – 要删除的ID列表。

• kwargs (Any)

Returns:

如果删除成功则为真，否则为假。

Return type:

布尔

classmethod from_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) → VST

返回从文档和嵌入初始化的VectorStore。

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档列表。

• embedding (Embeddings) – 使用的嵌入函数。

• kwargs (Any) – 额外的关键字参数。

Returns:

从文档和嵌入初始化的VectorStore。

Return type:

VectorStore

classmethod from_embeddings(text_embeddings: Iterable[Tuple[str, List[float]]], embedding: Embeddings, metadatas: List[dict] | None = None, *, azure_search_endpoint: str = '', azure_search_key: str = '', index_name: str = 'langchain-index', fields: List[SearchField] | None = None, **kwargs: Any) → AzureSearch

Parameters:

• text_embeddings (可迭代[元组[字符串, 列表[浮点数]]])

• embedding (Embeddings)

• metadatas (可选[列表[字典]])

• azure_search_endpoint (str)

• azure_search_key (str)

• index_name (str)

• fields (可选[列表[SearchField]])

• kwargs (Any)

Return type:

AzureSearch

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, azure_search_endpoint: str = '', azure_search_key: str = '', azure_ad_access_token: str | None = None, index_name: str = 'langchain-index', fields: List[SearchField] | None = None, **kwargs: Any) → AzureSearch

返回从文本和嵌入初始化的VectorStore。

Parameters:

• texts (List[str]) – 要添加到向量存储中的文本。

• embedding (Embeddings) – 使用的嵌入函数。

• metadatas (Optional[List[dict]]) – 可选的与文本关联的元数据列表。 默认值为 None。

• ids – 与文本关联的可选ID列表。

• kwargs (Any) – 额外的关键字参数。

• azure_search_endpoint (str)

• azure_search_key (str)

• azure_ad_access_token (可选[str])

• index_name (str)

• fields (可选[列表[SearchField]])

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

get_by_ids(ids: Sequence[str], /) → list[Document]

通过ID获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

hybrid_max_marginal_relevance_search_with_score(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, *, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float]]

Return docs most similar to query with a hybrid query

并按MMR重新排序结果。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int, optional) – 返回的文档数量。默认为4。

• fetch_k (int, optional) – 从总结果中选择k个。默认为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5

• filters (str, optional) – 过滤表达式。默认为 None。

• kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[文档, 浮点数]]

hybrid_search(query: str, k: int = 4, **kwargs: Any) → List[Document]

返回与查询文本最相似的索引文档。

Parameters:

• query (str) – 用于查找相似文档的查询文本。

• k (int) – 返回的文档数量。默认值为4。

• kwargs (Any)

Returns:

与查询文本最相似的文档列表。

Return type:

列表[Document]

hybrid_search_with_relevance_scores(query: str, k: int = 4, *, score_threshold: float | None = None, **kwargs: Any) → List[Tuple[Document, float]]

Parameters:

• query (str)

• k (整数)

• score_threshold (float | None)

• kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]

hybrid_search_with_score(query: str, k: int = 4, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float]]

返回与混合查询最相似的文档。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int) – 返回的文档数量。默认为4。

• filters (str | None)

• kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[文档, 浮点数]]

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int) – 返回的文档数量。默认为4。

• fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

max_marginal_relevance_search_by_vector(embedding: list[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

• embedding (list[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

max_marginal_relevance_search_with_score(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, *, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float]]

执行搜索并返回按MMR重新排序的结果。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int, optional) – 返回多少个结果。默认为4。

• fetch_k (int, optional) – 从总结果中选择k个。默认为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5

• filters (str, optional) – 过滤表达式。默认为 None。

• kwargs (Any)

Returns:

最相似的文档列表

查询及其对应的分数

Return type:

列表[元组[Document, 浮点数]]

search(query: str, search_type: str, **kwargs: Any) → list[Document]

使用指定的搜索类型返回与查询最相似的文档。

Parameters:

• query (str) – 输入文本

• search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

semantic_hybrid_search(query: str, k: int = 4, **kwargs: Any) → List[Document]

返回与查询文本最相似的索引文档。

Parameters:

• query (str) – 用于查找相似文档的查询文本。

• k (int) – 返回的文档数量。默认值为4。

• filters – 过滤表达式。

• kwargs (Any)

Returns:

与查询文本最相似的文档列表。

Return type:

列表[Document]

semantic_hybrid_search_with_score(query: str, k: int = 4, score_type: Literal['score', 'reranker_score'] = 'score', *, score_threshold: float | None = None, **kwargs: Any) → List[Tuple[Document, float]]

返回与查询文本最相似的索引文档。

Parameters:

• query (str) – 用于查找相似文档的查询文本。

• k (int) – 返回的文档数量。默认值为4。

• score_type (Literal['score', 'reranker_score']) – 必须是“score”或“reranker_score”。 默认为“score”。

• filters – 过滤表达式。

• score_threshold (float | None)

• kwargs (Any)

Returns:

文档列表及其

对应的分数。

Return type:

列表[元组[Document, 浮点数]]

semantic_hybrid_search_with_score_and_rerank(query: str, k: int = 4, *, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float, float]]

返回与混合查询最相似的文档。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int) – 返回的文档数量。默认为4。

• filters (str | None) – 过滤表达式。

• kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[文档, 浮点数, 浮点数]]

similarity_search(query: str, k: int = 4, *, search_type: str | None = None, **kwargs: Any) → List[Document]

返回与查询最相似的文档。

Parameters:

• query (str) – 输入文本。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) – 传递给搜索方法的参数。

• search_type (str | None)

• **kwargs

Returns:

与查询最相似的文档列表。

Return type:

列表[文档]

similarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) → list[Document]

返回与嵌入向量最相似的文档。

Parameters:

• embedding (list[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询向量最相似的文档列表。

Return type:

列表[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, *, score_threshold: float | None = None, **kwargs: Any) → List[Tuple[Document, float]]

返回文档和相关度分数，范围在[0, 1]之间。

0 表示不相似，1 表示最相似。

Parameters:

• query (str) – 输入文本。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) –

  传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

  用于过滤检索到的文档集。

• score_threshold (float | None)

• **kwargs

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[文档, 浮点数]]

similarity_search_with_score(query: str, *, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

使用距离运行相似性搜索。

Parameters:

• query (str)

• k (整数)

• kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]

vector_search(query: str, k: int = 4, *, filters: str | None = None, **kwargs: Any) → List[Document]

返回与查询文本最相似的索引文档。

Parameters:

• query (str) – 用于查找相似文档的查询文本。

• k (int) – 返回的文档数量。默认值为4。

• filters (str | None)

• kwargs (Any)

Returns:

与查询文本最相似的文档列表。

Return type:

列表[Document]

vector_search_with_score(query: str, k: int = 4, filters: str | None = None, **kwargs: Any) → List[Tuple[Document, float]]

返回与查询最相似的文档。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int, optional) – 返回的文档数量。默认为4。

• filters (str, optional) – 过滤表达式。默认为 None。

• kwargs (Any)

Returns:

最相似的文档列表

查询及其对应的分数

Return type:

列表[元组[Document, 浮点数]]

使用 AzureSearch 的示例

• Azure AI Search

• AzureAISearchRetriever