Package com.azure.ai.openai.models

Class AzureChatExtensionType

java.lang.Object

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

com.azure.ai.openai.models.AzureChatExtensionType

All Implemented Interfaces:

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

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

A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat completions request that should use Azure OpenAI chat extensions to augment the response behavior. The use of this configuration is compatible only with Azure OpenAI.

Field Summary

Fields

Modifier and Type	Field	Description
static final AzureChatExtensionType	AZURE_COSMOS_DB	Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension.
static final AzureChatExtensionType	AZURE_SEARCH	Represents the use of Azure AI Search as an Azure OpenAI chat extension.
static final AzureChatExtensionType	ELASTICSEARCH	Represents the use of Elasticsearch® index as an Azure OpenAI chat extension.
static final AzureChatExtensionType	MONGO_DB	Represents the use of a MongoDB chat extension.
static final AzureChatExtensionType	PINECONE	Represents the use of Pinecone index as an Azure OpenAI chat extension.

Constructor Summary

Constructors

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

Method Summary

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

AZURE_SEARCH

public static final AzureChatExtensionType AZURE_SEARCH

Represents the use of Azure AI Search as an Azure OpenAI chat extension.

AZURE_COSMOS_DB

public static final AzureChatExtensionType AZURE_COSMOS_DB

Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension.

ELASTICSEARCH

public static final AzureChatExtensionType ELASTICSEARCH

Represents the use of Elasticsearch® index as an Azure OpenAI chat extension.

PINECONE

public static final AzureChatExtensionType PINECONE

Represents the use of Pinecone index as an Azure OpenAI chat extension.

MONGO_DB

public static final AzureChatExtensionType MONGO_DB

Represents the use of a MongoDB chat extension.

Constructor Details

AzureChatExtensionType

@Deprecated
public AzureChatExtensionType()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of AzureChatExtensionType value.

Method Details

fromString

public static AzureChatExtensionType fromString(String name)

Creates or finds a AzureChatExtensionType from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding AzureChatExtensionType.

values

public static Collection<AzureChatExtensionType> values()

Gets known AzureChatExtensionType values.

Returns:

known AzureChatExtensionType values.