SearchIndexerClient クラス

セッションを SearchIndexerClient 閉じます。

close() -> None

新しいデータ ソース接続を作成します。

create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> 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")

新しい SearchIndexer を作成します。

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

パラメーター

戻り値

作成された SearchIndexer

の戻り値の型 :

新しいデータ ソース接続を作成するか、データ ソース接続が既に存在する場合は更新します。 :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(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer

パラメーター

戻り値

作成された SearchIndexer

の戻り値の型 :

Azure Search Serviceに新しい SearchIndexerSkillset を作成するか、既存の SearchIndexerSkillset を更新します。

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

パラメーター

戻り値

作成または更新された SearchIndexerSkillset

の戻り値の型 :

Azure Search Serviceで新しい SearchIndexerSkillset を作成する

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

パラメーター

戻り値

作成された SearchIndexerSkillset

の戻り値の型 :

データ ソース接続を削除します。 アクセス条件を使用するには、名前の代わりに SearchIndexerDataSourceConnection モデルを指定する必要があります。 無条件に削除するには、データ ソース接続の名前を指定するだけで十分です

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

パラメーター

戻り値

なし

の戻り値の型 :

例

SearchIndexerDataSourceConnection を削除する

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

インデクサーを削除します。 アクセス条件を使用するには、名前の代わりに SearchIndexer モデルを指定する必要があります。 無条件に削除するには、インデクサーの名前を指定するだけで十分です。

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

パラメーター

戻り値

なし

の戻り値の型 :

Azure Search Serviceで名前付き SearchIndexerSkillset を削除します。 アクセス条件を使用するには、名前の代わりに SearchIndexerSkillset モデルを指定する必要があります。 無条件に削除するには、スキルセットの名前を指定するだけで十分です

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

パラメーター

データ ソース接続定義を取得します。

get_data_source_connection(name: str, **kwargs: Any) -> 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(**kwargs: Any) -> Sequence[str]

戻り値

すべてのデータ ソース接続名の一覧。

の戻り値の型 :

検索サービスで使用できるすべてのデータ ソース接続を一覧表示します。

get_data_source_connections(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[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(name: str, **kwargs: Any) -> SearchIndexer

パラメーター

戻り値

フェッチされる SearchIndexer。

の戻り値の型 :

検索サービスで使用できるすべてのインデクサー名を一覧表示します。

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

戻り値

すべての SearchIndexers の一覧。

の戻り値の型 :

インデクサーの状態を取得します。

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

パラメーター

戻り値

SearchIndexerStatus

の戻り値の型 :

検索サービスで使用できるすべてのインデクサーを一覧表示します。

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

パラメーター

戻り値

すべての SearchIndexers の一覧。

の戻り値の型 :

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

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

パラメーター

戻り値

取得した SearchIndexerSkillset

の戻り値の型 :

例外

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

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

戻り値

SearchIndexerSkillset 名の一覧

の戻り値の型 :

例外

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

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

パラメーター

戻り値

SearchIndexerSkillsets の一覧

の戻り値の型 :

例外

インデクサーに関連付けられている変更追跡状態をリセットします。

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

パラメーター

戻り値

なし

の戻り値の型 :

インデクサーを実行します。

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

パラメーター

戻り値

なし

の戻り値の型 :