SearchIndexClient.AnalyzeTextAsync Method

Reference

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.5.1

Package:: Azure.Search.Documents v11.6.0-beta.3

Source:: SearchIndexClient.cs

Source:: SearchIndexClient.Aliases.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Shows how an analyzer breaks text into tokens.

public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.AnalyzedTokenInfo>>> AnalyzeTextAsync (string indexName, Azure.Search.Documents.Indexes.Models.AnalyzeTextOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member AnalyzeTextAsync : string * Azure.Search.Documents.Indexes.Models.AnalyzeTextOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.AnalyzedTokenInfo>>>
override this.AnalyzeTextAsync : string * Azure.Search.Documents.Indexes.Models.AnalyzeTextOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.AnalyzedTokenInfo>>>

Public Overridable Function AnalyzeTextAsync (indexName As String, options As AnalyzeTextOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of AnalyzedTokenInfo)))

Parameters

indexName: String

The name of the index used to test an analyzer.

options: AnalyzeTextOptions

The AnalyzeTextOptions containing the text and analyzer or analyzer components to test.

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

Task<Response<IReadOnlyList<AnalyzedTokenInfo>>>

The Response<T> from the server containing a list of AnalyzedTokenInfo for analyzed text.

Exceptions

ArgumentNullException

Thrown when indexName or options is null.

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to