PromptAgentDefinition Class

The prompt agent definition.

Constructor

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

Variables

Name	Description
rai_config	RaiConfig Configuration for Responsible AI (RAI) content filtering and safety features.
kind	str or <xref:azure.ai.projects.models.PROMPT> Required. PROMPT.
model	str The model deployment to use for this agent. Required.
instructions	str A system (or developer) message inserted into the model's context.
temperature	float What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.
top_p	float An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
reasoning	Reasoning
tools	list[Tool] An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.
tool_choice	str or ToolChoiceParam How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call. Is either a str type or a ToolChoiceParam type.
text	PromptAgentDefinitionTextOptions Configuration options for a text response from the model. Can be plain text or structured JSON data.
structured_inputs	dict[str, StructuredInputDefinition] Set of structured inputs that can participate in prompt template substitution or tool argument bindings.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

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

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

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

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

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

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

instructions

A system (or developer) message inserted into the model's context.

instructions: str | None

kind

Required. PROMPT.

kind: PROMPT: 'prompt'>]

model

The model deployment to use for this agent. Required.

model: str

rai_config

Configuration for Responsible AI (RAI) content filtering and safety features.

rai_config: '_models.RaiConfig' | None

reasoning

reasoning: _models.Reasoning | None

structured_inputs

Set of structured inputs that can participate in prompt template substitution or tool argument bindings.

structured_inputs: dict[str, '_models.StructuredInputDefinition'] | None

temperature

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

temperature: float | None

text

Configuration options for a text response from the model. Can be plain text or structured JSON data.

text: _models.PromptAgentDefinitionTextOptions | None

tool_choice

How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call. Is either a str type or a ToolChoiceParam type.

tool_choice: str | _models.ToolChoiceParam | None

tools

An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.

tools: list['_models.Tool'] | None

top_p

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

top_p: float | None