你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SearchIndexerClient 类

用于与 Azure 搜索服务索引器交互的客户端。

继承

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexerClient

构造函数

SearchIndexerClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

参数

endpoint

str

必需

Azure 搜索服务的 URL 终结点

credential

AzureKeyCredential 或 TokenCredential

必需

用于授权搜索客户端请求的凭据

api_version

str

用于请求的搜索 API 版本。

audience

str

设置用于 Azure Active Directory 身份验证的受众 (AAD) 。 使用共享密钥时，不考虑受众。 如果未提供受众，则假定为公有云受众。

方法

close	SearchIndexerClient关闭会话。
create_data_source_connection	创建新的数据源连接。
create_indexer	创建新的 SearchIndexer。
create_or_update_data_source_connection	创建新的数据源连接或更新数据源连接（如果已存在）。 :p aram data_source_connection：要创建或更新的数据源连接的定义。 ：type data_source_connection：~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection ：关键字 (keyword) match_condition：在 etag :p aramtype match_condition上使用的匹配条件：~azure.core.MatchConditions ：return：创建的 SearchIndexerDataSourceConnection：rtype： ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_or_update_indexer	创建新的索引器或更新索引器（如果已存在）。
create_or_update_skillset	在 Azure 搜索服务中创建新的 SearchIndexerSkillset，或更新现有搜索集。
create_skillset	在 Azure 搜索服务中创建新的 SearchIndexerSkillset
delete_data_source_connection	删除数据源连接。 若要使用访问条件，必须提供 SearchIndexerDataSourceConnection 模型，而不是名称。 提供数据源连接的名称即可无条件删除
delete_indexer	删除索引器。 若要使用访问条件，必须提供 SearchIndexer 模型而不是名称。 提供索引器的名称即可无条件删除。
delete_skillset	在 Azure 搜索服务中删除名为 SearchIndexerSkillset。 若要使用访问条件，必须提供 SearchIndexerSkillset 模型而不是名称。 足以提供技能组的名称来无条件删除
get_data_source_connection	检索数据源连接定义。
get_data_source_connection_names	列出可用于搜索服务的所有数据源连接名称。
get_data_source_connections	列出可用于搜索服务的所有数据源连接。
get_indexer	检索索引器定义。
get_indexer_names	列出可用于搜索服务的所有索引器名称。
get_indexer_status	获取索引器的状态。
get_indexers	列出可用于搜索服务的所有索引器。
get_skillset	在 Azure 搜索服务中检索名为 SearchIndexerSkillset
get_skillset_names	列出 Azure 搜索服务中的 SearchIndexerSkillset 名称。
get_skillsets	列出 Azure 搜索服务中的 SearchIndexerSkillsets。
reset_indexer	重置与索引器关联的更改跟踪状态。
run_indexer	运行索引器。

close

SearchIndexerClient关闭会话。

close() -> None

create_data_source_connection

创建新的数据源连接。

create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> SearchIndexerDataSourceConnection

参数

data_source_connection

SearchIndexerDataSourceConnection

必需

要创建的数据源连接的定义。

返回

创建的 SearchIndexerDataSourceConnection

返回类型

SearchIndexerDataSourceConnection

示例

创建数据源

   container = SearchIndexerDataContainer(name="searchcontainer")
   data_source_connection = SearchIndexerDataSourceConnection(
       name="sample-data-source-connection", type="azureblob", connection_string=connection_string, container=container
   )
   result = client.create_data_source_connection(data_source_connection)
   print(result)
   print("Create new Data Source Connection - sample-data-source-connection")

create_indexer

创建新的 SearchIndexer。

create_indexer(indexer: SearchIndexer, **kwargs: Any) -> SearchIndexer

参数

indexer

SearchIndexer

必需

要创建的索引器的定义。

返回

创建的 SearchIndexer

返回类型

SearchIndexer

create_or_update_data_source_connection

创建新的数据源连接或更新数据源连接（如果已存在）。 :p aram data_source_connection：要创建或更新的数据源连接的定义。 ：type data_source_connection：~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection ：关键字 (keyword) match_condition：在 etag :p aramtype match_condition上使用的匹配条件：~azure.core.MatchConditions ：return：创建的 SearchIndexerDataSourceConnection：rtype： ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

create_or_update_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerDataSourceConnection

create_or_update_indexer

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

create_or_update_indexer(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer

参数

indexer

SearchIndexer

必需

要创建或更新的索引器的定义。

match_condition

MatchConditions

在 etag 上使用的匹配条件

返回

创建的 SearchIndexer

返回类型

SearchIndexer

create_or_update_skillset

在 Azure 搜索服务中创建新的 SearchIndexerSkillset，或更新现有搜索集。

create_or_update_skillset(skillset: SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerSkillset

参数

skillset

SearchIndexerSkillset

必需

要创建或更新的 SearchIndexerSkillset 对象

match_condition

MatchConditions

在 etag 上使用的匹配条件

返回

创建或更新的 SearchIndexerSkillset

返回类型

SearchIndexerSkillset

create_skillset

在 Azure 搜索服务中创建新的 SearchIndexerSkillset

create_skillset(skillset: SearchIndexerSkillset, **kwargs: Any) -> SearchIndexerSkillset

参数

skillset

SearchIndexerSkillset

必需

要创建的 SearchIndexerSkillset 对象

返回

创建的 SearchIndexerSkillset

返回类型

SearchIndexerSkillset

delete_data_source_connection

删除数据源连接。 若要使用访问条件，必须提供 SearchIndexerDataSourceConnection 模型，而不是名称。 提供数据源连接的名称即可无条件删除

delete_data_source_connection(data_source_connection: str | SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

参数

data_source_connection

str 或 SearchIndexerDataSourceConnection

必需

要删除的数据源连接。

match_condition

MatchConditions

在 etag 上使用的匹配条件

返回

无

返回类型

None

示例

删除 SearchIndexerDataSourceConnection

   client.delete_data_source_connection("sample-data-source-connection")
   print("Data Source Connection 'sample-data-source-connection' successfully deleted")

delete_indexer

删除索引器。 若要使用访问条件，必须提供 SearchIndexer 模型而不是名称。 提供索引器的名称即可无条件删除。

delete_indexer(indexer: str | SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

参数

indexer

str 或 SearchIndexer

必需

要删除的索引器。

match_condition

MatchConditions

在 etag 上使用的匹配条件

返回

无

返回类型

None

delete_skillset

在 Azure 搜索服务中删除名为 SearchIndexerSkillset。 若要使用访问条件，必须提供 SearchIndexerSkillset 模型而不是名称。 足以提供技能组的名称来无条件删除

delete_skillset(skillset: str | SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

参数

skillset

str 或 SearchIndexerSkillset

必需

要删除的 SearchIndexerSkillset

match_condition

MatchConditions

在 etag 上使用的匹配条件

get_data_source_connection

检索数据源连接定义。

get_data_source_connection(name: str, **kwargs: Any) -> SearchIndexerDataSourceConnection

参数

name

str

必需

要检索的数据源连接的名称。

返回

提取的 SearchIndexerDataSourceConnection。

返回类型

SearchIndexerDataSourceConnection

示例

检索 SearchIndexerDataSourceConnection

   result = client.get_data_source_connection("sample-data-source-connection")
   print("Retrived Data Source Connection 'sample-data-source-connection'")

get_data_source_connection_names

列出可用于搜索服务的所有数据源连接名称。

get_data_source_connection_names(**kwargs: Any) -> Sequence[str]

返回

所有数据源连接名称的列表。

返回类型

list[str]

get_data_source_connections

列出可用于搜索服务的所有数据源连接。

get_data_source_connections(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]

参数

select

list[str]

选择要检索的技能集的顶级属性。 指定为 JSON 属性名称列表，或为所有属性指定“*”。 默认值为所有属性。

返回

所有数据源连接的列表。

返回类型

list[SearchIndexerDataSourceConnection]

示例

列出所有 SearchIndexerDataSourceConnections

   result = client.get_data_source_connections()
   names = [ds.name for ds in result]
   print("Found {} Data Source Connections in the service: {}".format(len(result), ", ".join(names)))

get_indexer

检索索引器定义。

get_indexer(name: str, **kwargs: Any) -> SearchIndexer

参数

name

str

必需

要检索的索引器的名称。

返回

提取的 SearchIndexer。

返回类型

SearchIndexer

get_indexer_names

列出可用于搜索服务的所有索引器名称。

get_indexer_names(**kwargs: Any) -> Sequence[str]

返回

所有 SearchIndexers 的列表。

返回类型

list[str]

get_indexer_status

获取索引器的状态。

get_indexer_status(name: str, **kwargs: Any) -> SearchIndexerStatus

参数

name

str

必需

要获取状态的索引器的名称。

返回

SearchIndexerStatus

返回类型

SearchIndexerStatus

get_indexers

列出可用于搜索服务的所有索引器。

get_indexers(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexer]

参数

select

list[str]

选择要检索的技能集的顶级属性。 指定为 JSON 属性名称列表，或为所有属性指定“*”。 默认值为所有属性。

返回

所有 SearchIndexers 的列表。

返回类型

list[SearchIndexer]

get_skillset

在 Azure 搜索服务中检索名为 SearchIndexerSkillset

get_skillset(name: str, **kwargs: Any) -> SearchIndexerSkillset

参数

name

str

必需

要获取的 SearchIndexerSkillset 的名称

返回

检索到的 SearchIndexerSkillset

返回类型

SearchIndexerSkillset

例外

ResourceNotFoundError

get_skillset_names

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

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

返回

SearchIndexerSkillset 名称列表

返回类型

list[str]

例外

HttpResponseError

get_skillsets

列出 Azure 搜索服务中的 SearchIndexerSkillsets。

get_skillsets(*, select: List[str] | None = None, **kwargs: Any) -> List[SearchIndexerSkillset]

参数

select

list[str]

选择要检索的技能集的顶级属性。 指定为 JSON 属性名称列表，或为所有属性指定“*”。 默认值为所有属性。

返回

SearchIndexerSkillsets 列表

返回类型

list[SearchIndexerSkillset]

例外

HttpResponseError

reset_indexer

重置与索引器关联的更改跟踪状态。

reset_indexer(name: str, **kwargs: Any) -> None

参数

name

str

必需

要重置的索引器的名称。

返回

无

返回类型

None

run_indexer

运行索引器。

run_indexer(name: str, **kwargs: Any) -> None

参数

name

str

必需

要运行的索引器的名称。

返回

无

返回类型

None