SearchClient クラス

定義

Azure Cognitive Searchインデックスのクエリを実行し、ドキュメントのアップロード、マージ、または削除に使用できるクライアントです。

public class SearchClient
type SearchClient = class
Public Class SearchClient
継承
SearchClient

コンストラクター

SearchClient()

モック作成のために SearchClient クラスの新しいインスタンスを初期化します。

SearchClient(Uri, String, AzureKeyCredential)

インデックスのクエリを実行し、ドキュメントのアップロード、マージ、または削除を行う SearchClient クラスの新しいインスタンスを初期化します。

SearchClient(Uri, String, AzureKeyCredential, SearchClientOptions)

インデックスのクエリを実行し、ドキュメントのアップロード、マージ、または削除を行う SearchClient クラスの新しいインスタンスを初期化します。

SearchClient(Uri, String, TokenCredential)

インデックスのクエリを実行し、ドキュメントのアップロード、マージ、または削除を行う SearchClient クラスの新しいインスタンスを初期化します。

SearchClient(Uri, String, TokenCredential, SearchClientOptions)

インデックスのクエリを実行し、ドキュメントのアップロード、マージ、または削除を行う SearchClient クラスの新しいインスタンスを初期化します。

プロパティ

Endpoint

Search Service の URI エンドポイントを取得します。 これは、"https://{search_service}.search.windows.net" と似ている可能性があります。

IndexName

検索インデックスの名前を取得します。

ServiceName

Search Service の名前を取得します。

メソッド

Autocomplete(String, String, AutocompleteOptions, CancellationToken)

入力テキストと検索インデックス内の一致するドキュメントに基づいてクエリ用語を提案します。 オートコンプリート

AutocompleteAsync(String, String, AutocompleteOptions, CancellationToken)

入力テキストと検索インデックス内の一致するドキュメントに基づいてクエリ用語を提案します。 オートコンプリート

DeleteDocuments(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)

キーのみが指定されたバッチとして、インデックスからドキュメントを削除します。

DeleteDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

バッチとしてインデックスからドキュメントを削除します。

DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)

キーのみが指定されたバッチとして、インデックスからドキュメントを削除します。

DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

バッチとしてインデックスからドキュメントを削除します。

GetDocument<T>(String, GetDocumentOptions, CancellationToken)

Azure Cognitive Searchからドキュメントを取得します。 これは、ユーザーが特定の検索結果をクリックして、そのドキュメントに関する詳細を検索するときに役立ちます。 一度に取得できるドキュメントは 1 つだけです。 1 回の要求で複数のドキュメントを取得するには、Search を使用します。 ドキュメントの参照

GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken)

Azure Cognitive Searchからドキュメントを取得します。 これは、ユーザーが特定の検索結果をクリックして、そのドキュメントに関する詳細を検索するときに役立ちます。 一度に取得できるドキュメントは 1 つだけです。 1 回の要求で複数のドキュメントを取得するには、Search を使用します。 ドキュメントの参照

GetDocumentCount(CancellationToken)

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

GetDocumentCountAsync(CancellationToken)

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

IndexDocuments<T>(IndexDocumentsBatch<T>, IndexDocumentsOptions, CancellationToken)

アップロード、マージ、削除アクションのバッチを検索インデックスに送信します。 ドキュメントの追加、更新、または削除

IndexDocumentsAsync<T>(IndexDocumentsBatch<T>, IndexDocumentsOptions, CancellationToken)

アップロード、マージ、削除アクションのバッチを検索インデックスに送信します。 ドキュメントの追加、更新、または削除

MergeDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

ドキュメントをバッチとしてインデックスにマージします。

MergeDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

ドキュメントをバッチとしてインデックスにマージします。

MergeOrUploadDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

ドキュメントをバッチとしてインデックスにマージまたはアップロードします。

MergeOrUploadDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

ドキュメントをバッチとしてインデックスにマージまたはアップロードします。

Search<T>(String, SearchOptions, CancellationToken)

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

SearchAsync<T>(String, SearchOptions, CancellationToken)

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

Suggest<T>(String, String, SuggestOptions, CancellationToken)

部分的なテキスト入力 (最小 3 文字) で構成される "型として検索" クエリを実行します。 suggester 対応フィールドで見つかった一致するテキストが返されます。 Azure Cognitive Searchは、Suggester で定義済みのフィールドで一致する値を検索します。 たとえば、都市フィールドで提案を有効にした場合、「sea」と入力すると、そのフィールドの "Seattle"、"Sea Tac"、"Seaside" (すべての実際の都市名) を含むドキュメントが生成されます。 推奨事項

SuggestAsync<T>(String, String, SuggestOptions, CancellationToken)

部分的なテキスト入力 (最小 3 文字) で構成される "型として検索" クエリを実行します。 suggester 対応フィールドで見つかった一致するテキストが返されます。 Azure Cognitive Searchは、Suggester で定義済みのフィールドで一致する値を検索します。 たとえば、都市フィールドで提案を有効にした場合、「sea」と入力すると、そのフィールドの "Seattle"、"Sea Tac"、"Seaside" (すべての実際の都市名) を含むドキュメントが生成されます。 推奨事項

UploadDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

ドキュメントをバッチとしてインデックスにアップロードします。

UploadDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

ドキュメントをバッチとしてインデックスにアップロードします。

適用対象