Package com.azure.ai.openai.assistants.models

Class MessageStreamEvent

java.lang.Object

com.azure.core.util.ExpandableStringEnum<MessageStreamEvent>

com.azure.ai.openai.assistants.models.MessageStreamEvent

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class MessageStreamEvent
extends com.azure.core.util.ExpandableStringEnum<MessageStreamEvent>

Message operation related streaming events.

Field Summary

Fields

Modifier and Type	Field	Description
static final MessageStreamEvent	THREAD_MESSAGE_COMPLETED	Event sent when a message is completed.
static final MessageStreamEvent	THREAD_MESSAGE_CREATED	Event sent when a new message is created.
static final MessageStreamEvent	THREAD_MESSAGE_DELTA	Event sent when a message is being streamed.
static final MessageStreamEvent	THREAD_MESSAGE_IN_PROGRESS	Event sent when a message moves to `in_progress` status.
static final MessageStreamEvent	THREAD_MESSAGE_INCOMPLETE	Event sent before a message is completed.

Constructor Summary

Constructors

Constructor	Description
MessageStreamEvent()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static MessageStreamEvent	fromString(String name)	Creates or finds a MessageStreamEvent from its string representation.
static Collection<MessageStreamEvent>	values()	Gets known MessageStreamEvent values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

THREAD_MESSAGE_CREATED

public static final MessageStreamEvent THREAD_MESSAGE_CREATED

Event sent when a new message is created. The data of this event is of type ThreadMessage.

THREAD_MESSAGE_IN_PROGRESS

public static final MessageStreamEvent THREAD_MESSAGE_IN_PROGRESS

Event sent when a message moves to `in_progress` status. The data of this event is of type ThreadMessage.

THREAD_MESSAGE_DELTA

public static final MessageStreamEvent THREAD_MESSAGE_DELTA

Event sent when a message is being streamed. The data of this event is of type MessageDeltaChunk.

THREAD_MESSAGE_COMPLETED

public static final MessageStreamEvent THREAD_MESSAGE_COMPLETED

Event sent when a message is completed. The data of this event is of type ThreadMessage.

THREAD_MESSAGE_INCOMPLETE

public static final MessageStreamEvent THREAD_MESSAGE_INCOMPLETE

Event sent before a message is completed. The data of this event is of type ThreadMessage.

Constructor Details

MessageStreamEvent

@Deprecated
public MessageStreamEvent()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of MessageStreamEvent value.

Method Details

fromString

public static MessageStreamEvent fromString(String name)

Creates or finds a MessageStreamEvent from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding MessageStreamEvent.

values

public static Collection<MessageStreamEvent> values()

Gets known MessageStreamEvent values.

Returns:

known MessageStreamEvent values.