langchain_community.vectorstores.azuresearch.AzureSearch

class langchain_community.vectorstores.azuresearch.AzureSearch(azure_search_endpoint: str, azure_search_key: str, index_name: str, embedding_function: Union[Callable, Embeddings], search_type: str = 'hybrid', semantic_configuration_name: Optional[str] = None, fields: Optional[List[SearchField]] = None, vector_search: Optional[VectorSearch] = None, semantic_configurations: Optional[Union[SemanticConfiguration, List[SemanticConfiguration]]] = None, scoring_profiles: Optional[List[ScoringProfile]] = None, default_scoring_profile: Optional[str] = None, cors_options: Optional[CorsOptions] = None, **kwargs: Any)[source]

Azure Cognitive Search 向量存储。

Attributes

embeddings

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

Methods

__init__(azure_search_endpoint, ...[, ...])

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas])

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

adelete([ids])

根据向量ID或其他条件进行删除。

afrom_documents(documents, embedding, **kwargs)

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

afrom_texts(texts, embedding[, metadatas])

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

amax_marginal_relevance_search(query[, k, ...])

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

amax_marginal_relevance_search_by_vector(...)

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

as_retriever(**kwargs)

返回从此VectorStore初始化的AzureSearchVectorStoreRetriever。

asearch(query, search_type, **kwargs)

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

asimilarity_search(query[, k])

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

asimilarity_search_by_vector(embedding[, k])

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

asimilarity_search_with_relevance_scores(query)

返回文档和相关性分数在范围[0, 1]内，异步执行。

asimilarity_search_with_score(*args, **kwargs)

使用异步方式运行相似性搜索与距离。

delete([ids])

根据向量ID删除。

from_documents(documents, embedding, **kwargs)

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

from_texts(texts, embedding[, metadatas, ...])

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

hybrid_search(query[, k])

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

hybrid_search_with_relevance_scores(query[, k])

hybrid_search_with_score(query[, k, filters])

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

max_marginal_relevance_search(query[, k, ...])

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

max_marginal_relevance_search_by_vector(...)

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

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])

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

similarity_search_by_vector(embedding[, k])

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

similarity_search_with_relevance_scores(query)

返回文档和相关性得分在[0, 1]范围内。

similarity_search_with_score(*args, **kwargs)

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

vector_search(query[, k])

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

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 (Optional[str]) –

  • fields (Optional[List[SearchField]]) –

  • vector_search (Optional[VectorSearch]) –

  • semantic_configurations (Optional[Union[SemanticConfiguration, List[SemanticConfiguration]]]) –

  • scoring_profiles (Optional[List[ScoringProfile]]) –

  • default_scoring_profile (Optional[str]) –

  • cors_options (Optional[CorsOptions]) –

  • kwargs (Any) –

__init__(azure_search_endpoint: str, azure_search_key: str, index_name: str, embedding_function: Union[Callable, Embeddings], search_type: str = 'hybrid', semantic_configuration_name: Optional[str] = None, fields: Optional[List[SearchField]] = None, vector_search: Optional[VectorSearch] = None, semantic_configurations: Optional[Union[SemanticConfiguration, List[SemanticConfiguration]]] = None, scoring_profiles: Optional[List[ScoringProfile]] = None, default_scoring_profile: Optional[str] = None, cors_options: Optional[CorsOptions] = None, **kwargs: Any)[source]
Parameters

  • azure_search_endpoint (str) –

  • azure_search_key (str) –

  • index_name (str) –

  • embedding_function (Union[Callable, Embeddings]) –

  • search_type (str) –

  • semantic_configuration_name (Optional[str]) –

  • fields (Optional[List[SearchField]]) –

  • vector_search (Optional[VectorSearch]) –

  • semantic_configurations (Optional[Union[SemanticConfiguration, List[SemanticConfiguration]]]) –

  • scoring_profiles (Optional[List[ScoringProfile]]) –

  • default_scoring_profile (Optional[str]) –

  • cors_options (Optional[CorsOptions]) –

  • kwargs (Any) –

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

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

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

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

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

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

List[str]

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

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

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

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

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

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

List[str]

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

根据向量ID或其他条件进行删除。

参数：

ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。

返回：

Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

  • ids (Optional[List[str]]) –

  • kwargs (Any) –

Return type

Optional[bool]

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

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

Parameters
Return type

VST

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST

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

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

VST

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

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[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) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

as_retriever(**kwargs: Any) → AzureSearchVectorStoreRetriever[source]

返回从此VectorStore初始化的AzureSearchVectorStoreRetriever。

参数:
search_type (Optional[str]): 定义Retriever应执行的搜索类型。

可以是”similarity”（默认值）, “hybrid”, 或 “semantic_hybrid”。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。可以包括:

k: 返回的文档数量（默认值: 4） score_threshold: 相似性分数阈值的最小相关性阈值 fetch_k: 传递给MMR算法的文档数量（默认值: 20） lambda_mult: MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值: 0.5） filter: 根据文档元数据进行过滤

返回:

AzureSearchVectorStoreRetriever: 用于VectorStore的Retriever类。

Parameters

kwargs (Any) –

Return type

AzureSearchVectorStoreRetriever

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

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

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

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

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

返回文档和相关性分数在范围[0, 1]内，异步执行。

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

参数：

query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]

使用异步方式运行相似性搜索与距离。

Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

根据向量ID删除。

参数：

ids：要删除的ID列表。

返回：

bool：如果删除成功则为True，否则为False。

Parameters

  • ids (Optional[List[str]]) –

  • kwargs (Any) –

Return type

bool

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

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

Parameters
Return type

VST

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

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

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[dict]]) –

  • azure_search_endpoint (str) –

  • azure_search_key (str) –

  • index_name (str) –

  • fields (Optional[List[SearchField]]) –

  • kwargs (Any) –

Return type

AzureSearch

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

参数：

query（str）：要查找相似文档的查询文本。 k（int）：要返回的文档数量。默认为4。

返回：

List[Document]：与查询文本最相似的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

hybrid_search_with_score(query: str, k: int = 4, filters: Optional[str] = None) → List[Tuple[Document, float]][source]

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

参数：

query：要查找与之相似的文档的文本。 k：要返回的文档数量。默认为4。

返回：

返回与查询最相似的文档列表，以及每个文档的得分。

Parameters

  • query (str) –

  • k (int) –

  • filters (Optional[str]) –

Return type

List[Tuple[Document, float]]

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

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[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]

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

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

参数：

embedding：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

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

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

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

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

参数：

query（str）：要查找相似文档的查询文本。 k（int）：要返回的文档数量。默认为4。

返回：

List[Document]：与查询文本最相似的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

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

参数：

query（str）：要查找相似文档的查询文本。 k（int）：要返回的文档数量。默认为4。 score_type：必须是“score”或“reranker_score”之一。

默认为“score”。

返回：

List[Tuple[Document, float]]：文档及其相应分数的列表。

Parameters

  • query (str) –

  • k (int) –

  • score_type (Literal['score', 'reranker_score']) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

semantic_hybrid_search_with_score_and_rerank(query: str, k: int = 4, filters: Optional[str] = None) → List[Tuple[Document, float, float]][source]

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

参数：

query：要查找与之相似的文档的文本。 k：要返回的文档数量。默认为4。

返回：

返回与查询最相似的文档列表，以及每个文档的得分。

Parameters

  • query (str) –

  • k (int) –

  • filters (Optional[str]) –

Return type

List[Tuple[Document, float, float]]

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

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

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

参数：

embedding：要查找与之相似的文档的嵌入。 k：要返回的文档数量。默认为4。

返回：

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

返回文档和相关性得分在[0, 1]范围内。

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

参数：

query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集

返回：

元组列表（doc，相似性得分）

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]

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

Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

参数：

query（str）：要查找相似文档的查询文本。 k（int）：要返回的文档数量。默认为4。

返回：

List[Document]：与查询文本最相似的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

vector_search_with_score(query: str, k: int = 4, filters: Optional[str] = None) → List[Tuple[Document, float]][source]

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。

返回：

与查询最相似的文档列表，以及每个文档的分数。

Parameters

  • query (str) –

  • k (int) –

  • filters (Optional[str]) –

Return type

List[Tuple[Document, float]]

Examples using AzureSearch