Share via

ItemContentOutputText Class

Definition

Namespace:
Azure.AI.AgentServer.Contracts.Generated.OpenAI
Assembly:
Azure.AI.AgentServer.Contracts.dll
Package:
Azure.AI.AgentServer.Contracts v1.0.0-beta.4
Source:
ItemContentOutputText.cs

A text output from the model.

public class ItemContentOutputText : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemContent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemContentOutputText>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemContentOutputText>
type ItemContentOutputText = class
    inherit ItemContent
    interface IUtf8JsonSerializable
    interface IJsonModel<ItemContentOutputText>
    interface IPersistableModel<ItemContentOutputText>
Public Class ItemContentOutputText
Inherits ItemContent
Implements IJsonModel(Of ItemContentOutputText), IPersistableModel(Of ItemContentOutputText)
Inheritance
Object
ItemContent
ItemContentOutputText
Implements
IUtf8JsonSerializable IJsonModel<ItemContentOutputText> IPersistableModel<ItemContentOutputText> IPersistableModel<T>

Constructors

Name Description
ItemContentOutputText()

Initializes a new instance of ItemContentOutputText for deserialization.
ItemContentOutputText(ItemContentType, IDictionary<String,BinaryData>, String, IList<Annotation>, IList<LogProb>)

Initializes a new instance of ItemContentOutputText.
ItemContentOutputText(String, IEnumerable<Annotation>)

Initializes a new instance of ItemContentOutputText.

Properties

Name Description
Annotations

The annotations of the text output. Please note Annotation is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AnnotationFileCitation, AnnotationFilePath and AnnotationUrlCitation.
Logprobs

Gets the logprobs.
Text

The text output from the model.
Type

Gets or sets the type.

(Inherited from ItemContent)

Methods

Name Description
DeserializeItemContentOutputText(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<ItemContent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ItemContent)
IJsonModel<ItemContent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemContent)
IJsonModel<ItemContentOutputText>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Converts the provided BinaryData into a model.

(Inherited from ItemContent)
IPersistableModel<ItemContent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ItemContent)
IPersistableModel<ItemContent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ItemContent)
IPersistableModel<ItemContentOutputText>.Create(BinaryData, ModelReaderWriterOptions)

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

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

Writes the model into a BinaryData.
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to