SearchClient クラス

Azure 検索インデックスから検索の自動入力候補の結果を取得します。

インデックス定義の一部である コレクション。 :キーワード (keyword) モード: オートコンプリートのモードを指定します。 既定値は 'oneTerm' です。 用途

'twoTerms' を使用して、シングルグルを取得し、"oneTermWithContext" を取得して現在のコンテキストを使用し、自動完了の用語を生成します。 使用できる値は、'oneTerm'、'twoTerms'、'oneTermWithContext' です。

async autocomplete(search_text: str, suggester_name: str, *, mode: str | AutocompleteMode | None = None, use_fuzzy_matching: bool | None = None, highlight_post_tag: str | None = None, highlight_pre_tag: str | None = None, minimum_coverage: float | None = None, search_fields: List[str] | None = None, top: int | None = None, **kwargs) -> List[Dict]

パラメーター

の戻り値の型 :

例

自動入力候補を取得します。

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.aio import SearchClient

   search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))

   async with search_client:
       results = await search_client.autocomplete(search_text="bo", suggester_name="sg")

       print("Autocomplete suggestions for 'bo'")
       for result in results:
           print("    Completion: {}".format(result["text"]))

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

async close() -> None

戻り値

なし

の戻り値の型 :

Azure Search インデックスからドキュメントを削除する

削除すると、指定したドキュメントがインデックスから削除されます。 キー フィールド以外の削除操作で指定したフィールドは無視されます。 ドキュメントから個々のフィールドを削除する場合は、代わりに merge_documents を使用し、フィールドを明示的に None に設定します。

削除操作はべき等です。 つまり、インデックスにドキュメント キーが存在しない場合でも、そのキーを使用した削除操作に対して状態コード 200 が返されます。

async delete_documents(documents: List[Dict], **kwargs: Any) -> List[IndexingResult]

パラメーター

戻り値

IndexingResult の一覧

の戻り値の型 :

例

既存のドキュメントをインデックスに削除する

   result = await search_client.upload_documents(documents=[{"hotelId": "1000"}])

   print("Delete new document succeeded: {}".format(result[0].succeeded))

キーを使用して Azure 検索インデックスからドキュメントを取得します。

async get_document(key: str, selected_fields: List[str] | None = None, **kwargs: Any) -> Dict

パラメーター

戻り値

指定したキーと一致するドキュメント

の戻り値の型 :

例

検索インデックスから特定のドキュメントを取得します。

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.aio import SearchClient

   search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))

   async with search_client:
       result = await search_client.get_document(key="23")

       print("Details for hotel '23' are:")
       print("        Name: {}".format(result["hotelName"]))
       print("      Rating: {}".format(result["rating"]))
       print("    Category: {}".format(result["category"]))

Azure 検索インデックス内のドキュメントの数を返します。

async get_document_count(**kwargs: Any) -> int

戻り値

インデックス内のドキュメントの数

の戻り値の型 :

バッチとして実行するドキュメント操作を指定します。

：発生 させます RequestEntityTooLargeError

async index_documents(batch: IndexDocumentsBatch, **kwargs: Any) -> List[IndexingResult]

パラメーター

戻り値

IndexingResult の一覧

の戻り値の型 :

内のドキュメントを Azure 検索インデックス内の既存のドキュメントにマージします。

マージによって、指定したフィールドで既存のドキュメントが更新されます。 ドキュメントが存在しない場合、マージは失敗します。 マージで指定したすべてのフィールドは、ドキュメント内の既存のフィールドを置き換えます。 これは、プリミティブ型と複合型のコレクションにも適用されます。

async merge_documents(documents: List[Dict], **kwargs: Any) -> List[IndexingResult]

パラメーター

戻り値

IndexingResult の一覧

の戻り値の型 :

例

フィールドを既存のドキュメントにインデックスにマージする

   result = await search_client.upload_documents(documents=[{"hotelId": "1000", "rating": 4.5}])

   print("Merge into new document succeeded: {}".format(result[0].succeeded))

内のドキュメントを Azure 検索インデックス内の既存のドキュメントにマージするか、まだ存在しない場合はアップロードします。

このアクションは、指定されたキーを持つドキュメントが既にインデックスに存在する場合、 merge_documents のように動作します。 ドキュメントが存在しない場合は、新しいドキュメントで upload_documents のように動作します。

async merge_or_upload_documents(documents: List[Dict], **kwargs: Any) -> List[IndexingResult]

パラメーター

戻り値

IndexingResult の一覧

の戻り値の型 :

Azure Search インデックスでドキュメントを検索します。

async search(search_text: str | None = None, *, include_total_count: bool | None = None, facets: List[str] | None = None, filter: str | None = None, highlight_fields: str | None = None, highlight_post_tag: str | None = None, highlight_pre_tag: str | None = None, minimum_coverage: float | None = None, order_by: List[str] | None = None, query_type: str | QueryType | None = None, scoring_parameters: List[str] | None = None, scoring_profile: str | None = None, search_fields: List[str] | None = None, search_mode: str | SearchMode | None = None, query_answer: str | QueryAnswerType | None = None, query_answer_count: int | None = None, query_answer_threshold: float | None = None, query_caption: str | QueryCaptionType | None = None, query_caption_highlight_enabled: bool | None = None, semantic_configuration_name: str | None = None, select: List[str] | None = None, skip: int | None = None, top: int | None = None, scoring_statistics: str | ScoringStatistics | None = None, session_id: str | None = None, vector_queries: List[VectorQuery] | None = None, vector_filter_mode: str | VectorFilterMode | None = None, semantic_error_mode: str | SemanticErrorMode | None = None, semantic_max_wait_in_milliseconds: int | None = None, **kwargs) -> AsyncSearchItemPaged[Dict]

パラメーター

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.aio import SearchClient

   search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))

   async with search_client:
       results = await search_client.search(search_text="WiFi", facets=["category,count:3", "parkingIncluded"])

       facets: Dict[str, List[str]] = cast(Dict[str, List[str]], await results.get_facets())

       print("Catgory facet counts for hotels:")
       for facet in facets["category"]:
           print("    {}".format(facet))