Share via

KeyPhrasesActionResult Class

  • Reference

Definition

Namespace:
Azure.AI.Language.Text
Assembly:
Azure.AI.Language.Text.dll
Package:
Azure.AI.Language.Text v1.0.0-beta.1

A ranked list of sentences representing the extracted summary.

public class KeyPhrasesActionResult : System.ClientModel.Primitives.IJsonModel<Azure.AI.Language.Text.KeyPhrasesActionResult>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Language.Text.KeyPhrasesActionResult>
type KeyPhrasesActionResult = class
    interface IJsonModel<KeyPhrasesActionResult>
    interface IPersistableModel<KeyPhrasesActionResult>
Public Class KeyPhrasesActionResult
Implements IJsonModel(Of KeyPhrasesActionResult), IPersistableModel(Of KeyPhrasesActionResult)
Inheritance
Object
KeyPhrasesActionResult
Implements
IJsonModel<KeyPhrasesActionResult> IPersistableModel<KeyPhrasesActionResult> IPersistableModel<T>

Properties

DetectedLanguage

If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document.
Id

Unique, non-empty document identifier.
KeyPhrases

A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.
Statistics

if showStats=true was specified in the request this field will contain information about the document payload.
Warnings

Warnings encountered while processing document.

Explicit Interface Implementations

IJsonModel<KeyPhrasesActionResult>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<KeyPhrasesActionResult>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<KeyPhrasesActionResult>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<KeyPhrasesActionResult>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<KeyPhrasesActionResult>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to