SearchIndexerClient クラス

リファレンス

Azure Search Service Indexers と対話するクライアント。

継承: 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

要求に使用する Search 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 Search Serviceに新しい SearchIndexerSkillset を作成するか、既存の SearchIndexerSkillset を更新します。
create_skillset	Azure Search Serviceで新しい SearchIndexerSkillset を作成する
delete_data_source_connection	データソース接続を削除します。アクセス条件を使用するには、名前の代わりに SearchIndexerDataSourceConnection モデルを指定する必要があります。無条件に削除するには、データソース接続の名前を指定するだけで十分です
delete_indexer	インデクサーを削除します。アクセス条件を使用するには、名前の代わりに SearchIndexer モデルを指定する必要があります。無条件に削除するには、インデクサーの名前を指定するだけで十分です。
delete_skillset	Azure Search Serviceで名前付き 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 Search Serviceで名前付き SearchIndexerSkillset を取得する
get_skillset_names	Azure Search Service内の SearchIndexerSkillset 名を一覧表示します。
get_skillsets	Azure Search Serviceで 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 Search Serviceに新しい SearchIndexerSkillset を作成するか、既存の 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 Search Serviceで新しい 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 Search Serviceで名前付き 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]

戻り値

すべての SearchIndexers の一覧。

の戻り値の型 :

list[SearchIndexer]

get_skillset

Azure Search Serviceで名前付き SearchIndexerSkillset を取得する

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

パラメーター

name: str

必須

取得する SearchIndexerSkillset の名前

戻り値

取得した SearchIndexerSkillset

の戻り値の型 :

SearchIndexerSkillset

例外

ResourceNotFoundError

get_skillset_names

Azure Search Service内の SearchIndexerSkillset 名を一覧表示します。

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

戻り値

SearchIndexerSkillset 名の一覧

の戻り値の型 :

list[str]

例外

HttpResponseError

get_skillsets

Azure Search Serviceで SearchIndexerSkillsets を一覧表示します。

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

パラメーター

select: list[str]

戻り値

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

次の方法で共有

SearchIndexerClient クラス

コンストラクター

パラメーター

メソッド

close

create_data_source_connection

パラメーター

戻り値

の戻り値の型 :

例

create_indexer

パラメーター

戻り値

の戻り値の型 :

create_or_update_data_source_connection

create_or_update_indexer

パラメーター

戻り値

の戻り値の型 :

create_or_update_skillset

パラメーター

戻り値

の戻り値の型 :

create_skillset

パラメーター

戻り値

の戻り値の型 :

delete_data_source_connection

パラメーター

戻り値

の戻り値の型 :

例

delete_indexer

パラメーター

戻り値

の戻り値の型 :

delete_skillset

パラメーター

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

パラメーター

戻り値

の戻り値の型 :

例外

get_skillset_names

戻り値

の戻り値の型 :

例外

get_skillsets

パラメーター

戻り値

の戻り値の型 :