SessionAffinitySource Class

public final class SessionAffinitySource
extends ExpandableStringEnum<SessionAffinitySource>

Conversation identifier sources supported by Model Router session affinity.

Field Summary

Modifier and Type Field and Description
static final SessionAffinitySource CONVERSATION

The Responses conversation identifier.

static final SessionAffinitySource NOT_AVAILABLE

No usable conversation identifier was available.

static final SessionAffinitySource PREVIOUS_RESPONSE_ID

The Responses previous response identifier.

static final SessionAffinitySource SESSION_ID_HEADER

An explicit session identifier supplied in the `x-ms-session-id` request header.

static final SessionAffinitySource SESSION_ID_PAYLOAD

An explicit session identifier supplied in the request body.

Constructor Summary

Constructor Description
SessionAffinitySource()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of SessionAffinitySource value.

Method Summary

Modifier and Type Method and Description
static SessionAffinitySource fromString(String name)

Creates or finds a SessionAffinitySource from its string representation.

static Collection<SessionAffinitySource> values()

Gets known SessionAffinitySource values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

CONVERSATION

public static final SessionAffinitySource CONVERSATION

The Responses conversation identifier.

NOT_AVAILABLE

public static final SessionAffinitySource NOT_AVAILABLE

No usable conversation identifier was available.

PREVIOUS_RESPONSE_ID

public static final SessionAffinitySource PREVIOUS_RESPONSE_ID

The Responses previous response identifier.

SESSION_ID_HEADER

public static final SessionAffinitySource SESSION_ID_HEADER

An explicit session identifier supplied in the `x-ms-session-id` request header.

SESSION_ID_PAYLOAD

public static final SessionAffinitySource SESSION_ID_PAYLOAD

An explicit session identifier supplied in the request body.

Constructor Details

SessionAffinitySource

@Deprecated
public SessionAffinitySource()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of SessionAffinitySource value.

Method Details

fromString

public static SessionAffinitySource fromString(String name)

Creates or finds a SessionAffinitySource from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding SessionAffinitySource.

values

public static Collection<SessionAffinitySource> values()

Gets known SessionAffinitySource values.

Returns:

known SessionAffinitySource values.

Applies to