Share via

AzureOpenAIDeployment Class

  • Reference

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Azure OpenAI Deployment Information.

Readonly variables are only populated by the server, and will be ignored when sending a request.

ivar name: The deployment name.

vartype name: str

ivar model_name: The name of the model to deploy.

vartype model_name: str

ivar model_version: The model version to deploy.

vartype model_version: str

ivar connection_name: The name of the connection to deploy to.

vartype connection_name: str

ivar target_url: The target URL of the AOAI resource for the deployment.

vartype target_url: str

ivar id: The ARM resource id of the deployment.

vartype id: str

ivar properties: Properties of the deployment.

vartype properties: dict[str, str]

ivar tags: Tags of the deployment.

vartype tags: dict[str, str]

ivar system_data: System data of the deployment.

vartype system_data: ~azure.ai.ml.entities.SystemData

Inheritance
azure.ai.ml.entities._autogen_entities.models._models.AzureOpenAIDeployment
AzureOpenAIDeployment

Constructor

AzureOpenAIDeployment(*args: Any, **kwargs: Any)

Methods

as_dict
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict 

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

clear 

clear() -> None

Keyword-Only Parameters

Name Description
exclude_readonly
Required

copy 

copy() -> Model

Keyword-Only Parameters

Name Description
exclude_readonly
Required

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

Keyword-Only Parameters

Name Description
exclude_readonly
Required

items 

items() -> ItemsView[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

keys 

keys() -> KeysView[str]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

Keyword-Only Parameters

Name Description
exclude_readonly
Required

popitem 

popitem() -> Tuple[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

Keyword-Only Parameters

Name Description
exclude_readonly
Required

update 

update(*args: Any, **kwargs: Any) -> None

Keyword-Only Parameters

Name Description
exclude_readonly
Required

values 

values() -> ValuesView[Any]

Keyword-Only Parameters

Name Description
exclude_readonly
Required

Attributes

connection_name

The name of the connection to deploy to.

connection_name: str | None

id

The ARM resource id of the deployment.

id: str | None

model_name

The name of the model to deploy.

model_name: str | None

model_version

The model version to deploy.

model_version: str | None

name

The deployment name.

name: str | None

system_data

System data of the deployment.

system_data: SystemData | None

target_url

The target URL of the AOAI resource for the deployment.

target_url: str | None