SearchClient.GetDocument<T> メソッド

定義

名前空間:

Azure.Search.Documents

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

ソース:

SearchClient.cs

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

public virtual Azure.Response<T> GetDocument<T> (string key, Azure.Search.Documents.GetDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDocument : string * Azure.Search.Documents.GetDocumentOptions * System.Threading.CancellationToken -> Azure.Response<'T>
override this.GetDocument : string * Azure.Search.Documents.GetDocumentOptions * System.Threading.CancellationToken -> Azure.Response<'T>

Public Overridable Function GetDocument(Of T) (key As String, Optional options As GetDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of T)

型パラメーター

T

インデックス スキーマにマップされる .NET 型。 この型のインスタンスは、インデックスからドキュメントとして取得できます。

パラメーター

key

String

必須。 インデックス内の各ドキュメントを一意に識別する文字列値。 キーは、ドキュメント ID と呼ばれることもあります。 有効なドキュメント キーを作成するための規則については、「 名前付け 規則」を参照してください。

options

GetDocumentOptions

操作の動作をカスタマイズするためのオプション。

cancellationToken

CancellationToken

操作を取り消す必要がある通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Response<T>

に key対応するドキュメント。

例外

RequestFailedException

Search Service によってエラーが返されたときにスローされます。

注釈

メソッドと GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) メソッドのGetDocument<T>(String, GetDocumentOptions, CancellationToken)ジェネリック オーバーロードでは、型パラメーター Tを使用した Azure Search フィールド型の .NET 型へのマッピングがサポートされています。 コレクションを除くすべての検索フィールド型は null 許容であるため、 の Tプロパティに null 許容型を使用することをお勧めします。 詳細については、「 GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) 」を参照してください。