AzureOpenAIModelConfiguration Class

Model configuration for Azure OpenAI models

Constructor

AzureOpenAIModelConfiguration()

Parameters

Name	Description
type Required	NotRequired[Literal["azure_openai"]] The type of the model configuration. Should be 'azure_openai' for AzureOpenAIModelConfiguration
azure_deployment Required	str Name of Azure OpenAI deployment to make requests to
azure_endpoint Required	str Endpoint of Azure OpenAI resource to make requests to
api_key Required	str API key of Azure OpenAI resource
api_version Required	NotRequired[str] API version to use in request to Azure OpenAI deployment. Optional.

Examples

Creating an AzureOpenAIModelConfiguration object.

   from azure.ai.evaluation._model_configurations import AzureOpenAIModelConfiguration

   model_config = AzureOpenAIModelConfiguration(
       azure_endpoint="https://abcdefghijklmnopqrstuvwxyz.api.cognitive.microsoft.com",
       api_key="my-aoai-api-key",
       api_version="2024-04-01-preview",
       azure_deployment="my-aoai-deployment-name",
   )

Methods

clear
copy
fromkeys	Create a new dictionary with keys from iterable and values set to value.
get	Return the value for key if key is in the dictionary, else default.
items
keys
pop	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem	Remove and return a (key, value) pair as a 2-tuple. Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.
setdefault	Insert key with a value of default if key is not in the dictionary. Return the value for key if key is in the dictionary, else default.
update	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values

clear

clear() -> None.  Remove all items from D.

copy

copy() -> a shallow copy of D

fromkeys

Create a new dictionary with keys from iterable and values set to value.

fromkeys(value=None, /)

Positional-Only Parameters

Name	Description
iterable Required
value	Default value: None

get

Return the value for key if key is in the dictionary, else default.

get(key, default=None, /)

Positional-Only Parameters

Name	Description
key Required
default	Default value: None

items

items() -> a set-like object providing a view on D's items

keys

keys() -> a set-like object providing a view on D's keys

pop

If the key is not found, return the default if given; otherwise, raise a KeyError.

pop(k, [d]) -> v, remove specified key and return the corresponding value.

popitem

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

popitem()

setdefault

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

setdefault(key, default=None, /)

Positional-Only Parameters

Name	Description
key Required
default	Default value: None

update

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

update([E], **F) -> None.  Update D from dict/iterable E and F.

values

values() -> an object providing a view on D's values

Attributes

api_key

API key of Azure OpenAI resource

api_key: str

azure_endpoint

Endpoint of Azure OpenAI resource to make request to

azure_endpoint: str

api_version

api_version: str

azure_deployment

azure_deployment: str

type

type: Literal['azure_openai']