Package com.azure.ai.openai.models

Class ChatMessageTextContentItem

java.lang.Object

com.azure.ai.openai.models.ChatMessageContentItem

com.azure.ai.openai.models.ChatMessageTextContentItem

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatMessageContentItem>

public final class ChatMessageTextContentItem
extends ChatMessageContentItem

A structured chat content item containing plain text.

Constructor Summary

Constructors

Constructor	Description
ChatMessageTextContentItem(String text)	Creates an instance of ChatMessageTextContentItem class.

Method Summary

Modifier and Type	Method	Description
static ChatMessageTextContentItem	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatMessageTextContentItem from the JsonReader.
String	getText()	Get the text property: The content of the message.
String	getType()	Get the type property: The discriminated object type.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ChatMessageTextContentItem

public ChatMessageTextContentItem(String text)

Creates an instance of ChatMessageTextContentItem class.

Parameters:

text - the text value to set.

Method Details

getText

public String getText()

Get the text property: The content of the message.

Returns:

the text value.

getType

public String getType()

Get the type property: The discriminated object type.

Overrides:

getType in class ChatMessageContentItem

Returns:

the type value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ChatMessageContentItem>

Overrides:

toJson in class ChatMessageContentItem

Throws:

IOException

fromJson

public static ChatMessageTextContentItem fromJson(com.azure.json.JsonReader jsonReader)
                                           throws IOException

Reads an instance of ChatMessageTextContentItem from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ChatMessageTextContentItem if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the ChatMessageTextContentItem.