你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ChatCompletionCommonModelParameters Class

Common language model parameters for Chat Completions. If omitted, default values are used.

Constructor

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

Variables

Name Description
model_name
str

The name of the model to use (e.g., 'gpt-4o', etc.). Default is null if not specified.
frequency_penalty
float

A float in the range [-2,2] that reduces or increases likelihood of repeated tokens. Default is 0.
presence_penalty
float

A float in the range [-2,2] that penalizes new tokens based on their existing presence. Default is 0.
max_tokens
int

Maximum number of tokens to generate.
temperature
float

Sampling temperature. Default is 0.7.
seed
int

Random seed for controlling deterministic outputs. If omitted, randomization is used.
stop
list[str]

List of stop sequences that will cut off text generation. Default is none.

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

frequency_penalty

A float in the range [-2,2] that reduces or increases likelihood of repeated tokens. Default is 0.

frequency_penalty: float | None

max_tokens

Maximum number of tokens to generate.

max_tokens: int | None

model_name

The name of the model to use (e.g., 'gpt-4o', etc.). Default is null if not specified.

model_name: str | None

presence_penalty

A float in the range [-2,2] that penalizes new tokens based on their existing presence. Default is 0.

presence_penalty: float | None

seed

Random seed for controlling deterministic outputs. If omitted, randomization is used.

seed: int | None

stop

List of stop sequences that will cut off text generation. Default is none.

stop: list[str] | None

temperature

Sampling temperature. Default is 0.7.

temperature: float | None