DocumentsOperationsExtensions.Index メソッド

定義

名前空間:

Microsoft.Azure.Search

アセンブリ:

Microsoft.Azure.Search.Data.dll

パッケージ:

Microsoft.Azure.Search.Data v10.1.0

オーバーロード

Index(IDocumentsOperations, IndexBatch<Document>, SearchRequestOptions)	検索インデックスにアップロード、マージ、または削除アクションのバッチを送信します。 https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents
Index<T>(IDocumentsOperations, IndexBatch<T>, SearchRequestOptions)	検索インデックスにアップロード、マージ、または削除アクションのバッチを送信します。 https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents

Index(IDocumentsOperations, IndexBatch<Document>, SearchRequestOptions)

ソース:

DocumentsOperationsExtensions.cs

検索インデックスにアップロード、マージ、または削除アクションのバッチを送信します。 https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents

public static Microsoft.Azure.Search.Models.DocumentIndexResult Index (this Microsoft.Azure.Search.IDocumentsOperations operations, Microsoft.Azure.Search.Models.IndexBatch<Microsoft.Azure.Search.Models.Document> batch, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default);

static member Index : Microsoft.Azure.Search.IDocumentsOperations * Microsoft.Azure.Search.Models.IndexBatch<Microsoft.Azure.Search.Models.Document> * Microsoft.Azure.Search.Models.SearchRequestOptions -> Microsoft.Azure.Search.Models.DocumentIndexResult

<Extension()>
Public Function Index (operations As IDocumentsOperations, batch As IndexBatch(Of Document), Optional searchRequestOptions As SearchRequestOptions = Nothing) As DocumentIndexResult

パラメーター

operations

IDocumentsOperations

この拡張メソッドの操作グループ。

batch

IndexBatch<Document>

インデックス アクションのバッチ。

searchRequestOptions

SearchRequestOptions

操作の追加パラメーター

戻り値

DocumentIndexResult

バッチ内のすべてのアクションの操作の状態を含む応答。

例外

IndexBatchException

インデックス作成アクションの一部が失敗したが、他のアクションが成功し、インデックスの状態が変更されたときにスローされます。 これは、Search Service のインデックス作成負荷が高い場合に発生する可能性があります。 この例外を明示的にキャッチし、そのIndexResultプロパティをチェックすることが重要です。 このプロパティは、バッチ内の各インデックス作成アクションの状態を報告し、部分的なエラー後にインデックスの状態を判断できるようにします。

注釈

Index、IndexAsync、および IndexWithHttpMessagesAsync メソッドの非ジェネリック オーバーロードでは、応答ペイロード内の JSON 型を .NET 型にマップすることをベスト エフォートで試みます。 詳細については、「 GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) 」を参照してください。

Index<T>(IDocumentsOperations, IndexBatch<T>, SearchRequestOptions)

ソース:

DocumentsOperationsExtensions.cs

検索インデックスにアップロード、マージ、または削除アクションのバッチを送信します。 https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents

public static Microsoft.Azure.Search.Models.DocumentIndexResult Index<T> (this Microsoft.Azure.Search.IDocumentsOperations operations, Microsoft.Azure.Search.Models.IndexBatch<T> batch, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default);

static member Index : Microsoft.Azure.Search.IDocumentsOperations * Microsoft.Azure.Search.Models.IndexBatch<'T> * Microsoft.Azure.Search.Models.SearchRequestOptions -> Microsoft.Azure.Search.Models.DocumentIndexResult

<Extension()>
Public Function Index(Of T) (operations As IDocumentsOperations, batch As IndexBatch(Of T), Optional searchRequestOptions As SearchRequestOptions = Nothing) As DocumentIndexResult

型パラメーター

T

インデックス スキーマにマッピングされる CLR タイプ。 このタイプのインスタンスはインデックスにドキュメントとして保存できます。

パラメーター

operations

IDocumentsOperations

この拡張メソッドの操作グループ。

batch

IndexBatch<T>

インデックス アクションのバッチ。

searchRequestOptions

SearchRequestOptions

操作の追加パラメーター

戻り値

DocumentIndexResult

バッチ内のすべてのアクションの操作の状態を含む応答。

例外

IndexBatchException

インデックス作成アクションの一部が失敗したが、他のアクションが成功し、インデックスの状態が変更されたときにスローされます。 これは、Search Service のインデックス作成負荷が高い場合に発生する可能性があります。 この例外を明示的にキャッチし、そのIndexResultプロパティをチェックすることが重要です。 このプロパティは、バッチ内の各インデックス作成アクションの状態を報告し、部分的なエラー後にインデックスの状態を判断できるようにします。

注釈

Index メソッドと IndexAsync メソッドのジェネリック オーバーロードでは、型パラメーター T を使用した .NET 型への検索フィールド型のマッピングがサポートされています。型マッピングの詳細については、以下を参照してください GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) 。