Package com.azure.ai.openai.models

Class ChatMessageContentItem

java.lang.Object

com.azure.ai.openai.models.ChatMessageContentItem

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatMessageContentItem>

Direct Known Subclasses:

ChatMessageImageContentItem, ChatMessageTextContentItem

public class ChatMessageContentItem
extends Object
implements com.azure.json.JsonSerializable<ChatMessageContentItem>

An abstract representation of a structured content item within a chat message.

Constructor Summary

Constructors

Constructor	Description
ChatMessageContentItem()	Creates an instance of ChatMessageContentItem class.

Method Summary

Modifier and Type	Method	Description
static ChatMessageContentItem	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatMessageContentItem from the JsonReader.
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

ChatMessageContentItem

public ChatMessageContentItem()

Creates an instance of ChatMessageContentItem class.

Method Details

getType

public String getType()

Get the type property: The discriminated object type.

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>

Throws:

IOException

fromJson

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

Reads an instance of ChatMessageContentItem from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException - If an error occurs while reading the ChatMessageContentItem.