Share via

MessageStreamEvent Class

Package:
com.azure.ai.agents.persistent.models
Maven Artifact:
com.azure:azure-ai-agents-persistent:1.0.0-beta.2

public final class MessageStreamEvent
extends ExpandableStringEnum<MessageStreamEvent>

Message operation related streaming events.

Field Summary

Modifier and Type Field and 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_INCOMPLETE

Event sent before a message is completed.
static final MessageStreamEvent THREAD_MESSAGE_IN_PROGRESS

Event sent when a message moves to `in_progress` status.

Constructor Summary

Constructor Description
MessageStreamEvent()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of MessageStreamEvent value.

Method Summary

Modifier and Type Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

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_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_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_INCOMPLETE

public static final MessageStreamEvent THREAD_MESSAGE_INCOMPLETE

Event sent before a message is completed. 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.

Constructor Details

MessageStreamEvent

@Deprecated
public MessageStreamEvent()

Deprecated

Use the fromString(String name) 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.

Applies to