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

Class RunStepStreamEvent

java.lang.Object

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

com.azure.ai.openai.assistants.models.RunStepStreamEvent

All Implemented Interfaces:

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

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

Run step operation related streaming events.

Field Summary

Fields

Modifier and Type	Field	Description
static final RunStepStreamEvent	THREAD_RUN_STEP_CANCELLED	Event sent when a run step is cancelled.
static final RunStepStreamEvent	THREAD_RUN_STEP_COMPLETED	Event sent when a run step is completed.
static final RunStepStreamEvent	THREAD_RUN_STEP_CREATED	Event sent when a new thread run step is created.
static final RunStepStreamEvent	THREAD_RUN_STEP_DELTA	Event sent when a run stepis being streamed.
static final RunStepStreamEvent	THREAD_RUN_STEP_EXPIRED	Event sent when a run step is expired.
static final RunStepStreamEvent	THREAD_RUN_STEP_FAILED	Event sent when a run step fails.
static final RunStepStreamEvent	THREAD_RUN_STEP_IN_PROGRESS	Event sent when a run step moves to `in_progress` status.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static RunStepStreamEvent	fromString(String name)	Creates or finds a RunStepStreamEvent from its string representation.
static Collection<RunStepStreamEvent>	values()	Gets known RunStepStreamEvent 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_RUN_STEP_CREATED

public static final RunStepStreamEvent THREAD_RUN_STEP_CREATED

Event sent when a new thread run step is created. The data of this event is of type RunStep.

THREAD_RUN_STEP_IN_PROGRESS

public static final RunStepStreamEvent THREAD_RUN_STEP_IN_PROGRESS

Event sent when a run step moves to `in_progress` status. The data of this event is of type RunStep.

THREAD_RUN_STEP_DELTA

public static final RunStepStreamEvent THREAD_RUN_STEP_DELTA

Event sent when a run stepis being streamed. The data of this event is of type RunStepDeltaChunk.

THREAD_RUN_STEP_COMPLETED

public static final RunStepStreamEvent THREAD_RUN_STEP_COMPLETED

Event sent when a run step is completed. The data of this event is of type RunStep.

THREAD_RUN_STEP_FAILED

public static final RunStepStreamEvent THREAD_RUN_STEP_FAILED

Event sent when a run step fails. The data of this event is of type RunStep.

THREAD_RUN_STEP_CANCELLED

public static final RunStepStreamEvent THREAD_RUN_STEP_CANCELLED

Event sent when a run step is cancelled. The data of this event is of type RunStep.

THREAD_RUN_STEP_EXPIRED

public static final RunStepStreamEvent THREAD_RUN_STEP_EXPIRED

Event sent when a run step is expired. The data of this event is of type RunStep.

Constructor Details

RunStepStreamEvent

@Deprecated
public RunStepStreamEvent()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of RunStepStreamEvent value.

Method Details

fromString

public static RunStepStreamEvent fromString(String name)

Creates or finds a RunStepStreamEvent from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding RunStepStreamEvent.

values

public static Collection<RunStepStreamEvent> values()

Gets known RunStepStreamEvent values.

Returns:

known RunStepStreamEvent values.