SearchIndexClient 类

显示分析器如何将文本分解为标记。

analyze_text(index_name: str, analyze_request: AnalyzeTextOptions, **kwargs: Any) -> AnalyzeResult

参数

返回

AnalyzeResult

返回类型

例外

示例

分析文本

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.indexes import SearchIndexClient
   from azure.search.documents.indexes.models import AnalyzeTextOptions

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))

   analyze_request = AnalyzeTextOptions(text="One's <two/>", analyzer_name="standard.lucene")

   result = client.analyze_text(index_name, analyze_request)
   print(result.as_dict())

SearchIndexClient关闭会话。

close() -> None

例外

创建新的搜索索引。

create_index(index: SearchIndex, **kwargs: Any) -> SearchIndex

参数

返回

创建的索引

返回类型

例外

示例

创建新索引。

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   fields = [
       SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
       SimpleField(name="baseRate", type=SearchFieldDataType.Double),
       SearchableField(name="description", type=SearchFieldDataType.String, collection=True),
       ComplexField(
           name="address",
           fields=[
               SimpleField(name="streetAddress", type=SearchFieldDataType.String),
               SimpleField(name="city", type=SearchFieldDataType.String),
           ],
           collection=True,
       ),
   ]
   cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
   scoring_profiles: List[ScoringProfile] = []
   index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)

   result = client.create_index(index)

创建新的搜索索引或更新索引（如果已存在）。

create_or_update_index(index: SearchIndex, allow_index_downtime: bool | None = None, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndex

参数

返回

创建或更新的索引

返回类型

例外

示例

更新索引。

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   fields = [
       SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
       SimpleField(name="baseRate", type=SearchFieldDataType.Double),
       SearchableField(name="description", type=SearchFieldDataType.String, collection=True),
       SearchableField(name="hotelName", type=SearchFieldDataType.String),
       ComplexField(
           name="address",
           fields=[
               SimpleField(name="streetAddress", type=SearchFieldDataType.String),
               SimpleField(name="city", type=SearchFieldDataType.String),
               SimpleField(name="state", type=SearchFieldDataType.String),
           ],
           collection=True,
       ),
   ]
   cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
   scoring_profile = ScoringProfile(name="MyProfile")
   scoring_profiles = []
   scoring_profiles.append(scoring_profile)
   index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)

   result = client.create_or_update_index(index=index)

在 Azure 搜索服务中创建新的同义词映射，或更新现有的同义词映射。

create_or_update_synonym_map(synonym_map: SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SynonymMap

参数

返回

创建或更新的同义词映射

返回类型

例外

在 Azure 搜索服务中创建新的同义词映射

create_synonym_map(synonym_map: SynonymMap, **kwargs: Any) -> SynonymMap

参数

返回

创建的同义词映射

返回类型

例外

示例

创建同义词映射

   synonyms = [
       "USA, United States, United States of America",
       "Washington, Wash. => WA",
   ]
   synonym_map = SynonymMap(name="test-syn-map", synonyms=synonyms)
   result = client.create_synonym_map(synonym_map)
   print("Create new Synonym Map 'test-syn-map succeeded")

删除搜索索引及其包含的所有文档。 必须提供模型而不是名称才能使用访问条件。

delete_index(index: str | SearchIndex, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

参数

例外

示例

删除索引。

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   client.delete_index(name)

删除 Azure 搜索服务中的命名同义词映射。 若要使用访问条件，必须提供 SynonymMap 模型而不是名称。 足以提供无条件删除同义词映射的名称。

delete_synonym_map(synonym_map: str | SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

参数

返回

无

返回类型

例外

示例

删除同义词映射

   client.delete_synonym_map("test-syn-map")
   print("Synonym Map 'test-syn-map' deleted")

get_index(name: str, **kwargs: Any) -> SearchIndex

参数

返回

SearchIndex 对象

返回类型

例外

示例

获取索引。

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   result = client.get_index(name)

返回给定索引的统计信息，包括文档计数和存储使用情况。

get_index_statistics(index_name: str, **kwargs: Any) -> MutableMapping[str, Any]

参数

返回

给定索引的统计信息，包括文档计数和存储使用情况。

返回类型

例外

返回客户端以对搜索执行操作

get_search_client(index_name: str, **kwargs: Any) -> SearchClient

参数

返回

SearchClient 对象

返回类型

例外

获取搜索服务的服务级别统计信息。

get_service_statistics(**kwargs: Any) -> MutableMapping[str, Any]

返回

服务统计信息结果。

返回类型

例外

在 Azure 搜索服务中检索命名的同义词映射

get_synonym_map(name: str, **kwargs: Any) -> SynonymMap

参数

返回

检索到的同义词映射

返回类型

例外

示例

获取同义词映射

   result = client.get_synonym_map("test-syn-map")
   print("Retrived Synonym Map 'test-syn-map' with synonyms")
   for syn in result.synonyms:
       print("    {}".format(syn))

列出 Azure 搜索服务中的同义词映射名称。

get_synonym_map_names(**kwargs: Any) -> List[str]

返回

同义词映射列表

返回类型

例外

列出 Azure 搜索服务中的同义词映射。

get_synonym_maps(*, select: List[str] | None = None, **kwargs) -> List[SynonymMap]

参数

返回

同义词映射列表

返回类型

例外

示例

列出同义词映射

   result = client.get_synonym_maps()
   names = [x.name for x in result]
   print("Found {} Synonym Maps in the service: {}".format(len(result), ", ".join(names)))

列出 Azure 搜索服务中的索引名称。

list_index_names(**kwargs: Any) -> ItemPaged[str]

返回

索引名称列表

返回类型

例外

列出 Azure 搜索服务中的索引。

list_indexes(*, select: List[str] | None = None, **kwargs: Any) -> ItemPaged[SearchIndex]

参数

返回

索引列表

返回类型

例外