SearchIndexClient.AnalyzeText Method

Definition

Shows how an analyzer breaks text into tokens.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.AnalyzedTokenInfo>> AnalyzeText (string indexName, Azure.Search.Documents.Indexes.Models.AnalyzeTextOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member AnalyzeText : string * Azure.Search.Documents.Indexes.Models.AnalyzeTextOptions * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.AnalyzedTokenInfo>>
override this.AnalyzeText : string * Azure.Search.Documents.Indexes.Models.AnalyzeTextOptions * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.AnalyzedTokenInfo>>
Public Overridable Function AnalyzeText (indexName As String, options As AnalyzeTextOptions, Optional cancellationToken As CancellationToken = Nothing) As 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

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

Exceptions

Thrown when indexName or options is null.

Thrown when a failure is returned by the Search service.

Applies to