类class
agentscope.modelVolcengineChatModel
class VolcengineChatModel(ChatModelBase)
源码Source
agentscope/model/_volcengine/_model.py:27–452火山引擎聊天模型,与模型服务通信并返回生成或向量化结果。位于 agentscope.model 包,继承自 ChatModelBase。
The Volcengine Ark chat model. Declared in agentscope.model. Extends ChatModelBase.
嵌套类摘要Nested Class Summary
| 类Class | 类型Kind | 说明Description |
|---|---|---|
Parameters | 类class | 参数,与模型服务通信并返回生成或向量化结果。 The parameters for the Volcengine Ark chat model. |
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
def __init__(credential: VolcengineCredential, model: str, parameters: 'VolcengineChatModel.Parameters | None' = None,… | 初始化 `VolcengineChatModel` 实例。 Initialize the Volcengine Ark chat model. |
属性摘要Attribute Summary
| 属性Attribute | 类型Type | 说明Description | 值Value |
|---|---|---|---|
type | Literal['volcengine_chat'] | 类型字段。 | 'volcengine_chat' |
构造器详情Constructor Detail
VolcengineChatModel
def __init__(credential: VolcengineCredential, model: str, parameters: 'VolcengineChatModel.Parameters | None' = None, stream: bool = True, max_retries: int = 3, retry_delay: float = 1.0, context_size: int = 256000, formatter: FormatterBase | None = None, client_kwargs: dict[str, Any] | None = None) -> None
初始化 VolcengineChatModel 实例。
Initialize the Volcengine Ark chat model.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
credential | VolcengineCredential | 凭证对象(类型 `VolcengineCredential`)。The Volcengine Ark credential used to authenticate API calls. |
model | str | 模型实例(类型 `str`)。The versioned Ark model ID, e.g. `doubao-seed-2-1-pro-260628`. |
parameters默认default None | 'VolcengineChatModel.Parameters | None' | 参数(类型 `'VolcengineChatModel.Parameters | None'`)。The Volcengine Ark API parameters. When `None`, the default parameters will be used. |
stream默认default True | bool | 判断是否到启用流式输出。Whether to enable streaming output. |
max_retries默认default 3 | int | 最大重试次数(类型 `int`)。The maximum number of retries for the Volcengine Ark API. |
retry_delay默认default 1.0 | float | 重试延迟(类型 `float`)。Seconds to sleep between retry attempts. |
context_size默认default 256000 | int | 上下文大小(类型 `int`)。The model context size used for context compression. |
formatter默认default None | FormatterBase | None | 格式化器(类型 `FormatterBase | None`)。The formatter that converts `Msg` objects to the format required by the Volcengine Ark API. When `None`, a `VolcengineChatFormatter` instance will be used. |
client_kwargs默认default None | dict[str, Any] | None | 客户端关键字参数(类型 `dict[str, Any] | None`)。Extra keyword arguments forwarded to `openai.AsyncClient` (e.g. `timeout`, `default_headers`, `http_client`). |
源码Source
agentscope/model/_volcengine/_model.py:80–138属性详情Attribute Detail
type
Literal['volcengine_chat'] = 'volcengine_chat'类型字段。声明为 Literal['volcengine_chat']。
The type field.
源码Source
agentscope/model/_volcengine/_model.py:77嵌套类详情Nested Class Detail
Parameters
class Parameters参数,与模型服务通信并返回生成或向量化结果。位于 agentscope.model 包。
The parameters for the Volcengine Ark chat model. Declared in agentscope.model.