Skip to main content
⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考英文原版。
以下所有实体均基于 Pydantic BaseModel，可在 entities 模块中找到。

​
Provider

​
string
供应商标识符，例如：openai
​
object
供应商显示名称，i18n，可设置 en_US（英文）和 zh_Hans（中文）两种语言
​
string
中文标签，若未设置，将默认使用 en_US
​
string
required
英文标签
​
object
供应商描述，i18n
​
string
中文描述
​
string
required
英文描述
​
object
供应商小图标，存储在相应供应商实现目录下的 _assets 目录中
​
string
中文图标
​
string
required
英文图标
​
object
供应商大图标，存储在相应供应商实现目录下的 _assets 目录中
​
string
中文图标
​
string
required
英文图标
​
string
背景颜色值，例如：#FFFFFF，若为空，将显示前端默认颜色值
​
object
帮助信息
​
object
帮助标题，i18n
​
string
中文标题
​
string
required
英文标题
​
object
帮助链接，i18n
​
string
中文链接
​
string
required
英文链接
​
array[ModelType]
required
支持的模型类型
​
array[ConfigurateMethod]
required
配置方法
​
ProviderCredentialSchema
required
供应商凭据规范
​
ModelCredentialSchema
模型凭据规范

​
AIModelEntity

​
string
required
模型标识符，例如：gpt-3.5-turbo
​
object
模型显示名称，i18n，可设置 en_US（英文）和 zh_Hans（中文）两种语言
​
string
中文标签
​
string
required
英文标签
​
ModelType
required
模型类型
​
array[ModelFeature]
支持的特性列表
​
object
required
模型属性
​
LLMMode
模式（适用于模型类型 llm）
​
integer
上下文大小（适用于模型类型 llm 和 text-embedding）
​
integer
最大分块数（适用于模型类型 text-embedding 和 moderation）
​
integer
最大文件上传限制，单位：MB（适用于模型类型 speech2text）
​
string
支持的文件扩展名格式，例如：mp3,mp4（适用于模型类型 speech2text）
​
string
默认语音，必填项：alloy,echo,fable,onyx,nova,shimmer（适用于模型类型 tts）
​
array
可用语音列表（适用于模型类型 tts）
​
string
语音模型
​
string
语音模型显示名称
​
string
语音模型支持的语言
​
integer
单次转换的字数限制，默认按段落分割（适用于模型类型 tts）
​
string
支持的音频文件扩展名格式，例如：mp3,wav（适用于模型类型 tts）
​
integer
文字转音频转换支持的并发任务数（适用于模型类型 tts）
​
integer
每个分块的最大字符数（适用于模型类型 moderation）
​
array[ParameterRule]
模型调用参数规则
​
PriceConfig
价格信息
​
boolean
是否已弃用。若已弃用，模型列表将不再显示该模型，但已配置的仍可继续使用。默认为 False。

​
ModelType

​
string
文本生成模型
​
string
文本嵌入模型
​
string
重排序模型
​
string
语音转文字
​
string
文字转语音
​
string
内容审核

​
ConfigurateMethod

​
string
预定义模型 - 表示用户只需配置统一的供应商凭据即可使用该供应商下的预定义模型。
​
string
自定义模型 - 用户需要为每个模型添加凭据配置。
​
string
从远程获取 - 与 predefined-model 配置方法类似，只需统一的供应商凭据，但模型是使用凭据信息从供应商获取的。

​
ModelFeature

​
string
智能体推理，通常 70B 以上的模型具有思维链能力。
​
string
视觉，即：图像理解。
​
string
工具调用
​
string
多工具调用
​
string
流式工具调用

​
FetchFrom

​
string
预定义模型
​
string
远程模型

​
LLMMode

​
string
文本补全
​
string
对话

​
ParameterRule

​
string
required
模型调用的实际参数名称
​
string
使用模板
有关使用模板的详细信息，可参考创建新模型供应商中的示例。
默认有 5 个预配置的变量内容模板：
  • temperature
  • top_p
  • frequency_penalty
  • presence_penalty
  • max_tokens
可以直接在 use_template 中设置模板变量名，这将使用 entities.defaults.PARAMETER_RULE_TEMPLATE 中的默认配置，无需设置除 name 和 use_template 之外的任何参数。如果设置了额外的配置参数，它们将覆盖默认配置。可参考 openai/llm/gpt-3.5-turbo.yaml 中的示例。
​
object
标签，i18n
​
string
中文标签
​
string
required
英文标签
​
string
参数类型
​
string
整数
​
string
浮点数
​
string
字符串
​
string
布尔值
​
object
帮助信息
​
string
中文帮助信息
​
string
required
英文帮助信息
​
boolean
是否必填，默认为 False
​
int/float/string/boolean
默认值
​
int/float
最小值，仅适用于数值类型
​
int/float
最大值，仅适用于数值类型
​
integer
精度，保留的小数位数，仅适用于数值类型
​
array[string]
下拉选项值，仅当 type 为 string 时适用，若未设置或为 null，则不限制选项值

​
PriceConfig

​
float
输入单价，即提示词单价
​
float
输出单价，即返回内容单价
​
float
价格单位，例如，若按每 1M 令牌计价，则单价对应的单位令牌数为 0.000001
​
string
货币单位

​
ProviderCredentialSchema

​
array[CredentialFormSchema]
required
凭据表单规范

​
ModelCredentialSchema

​
object
required
模型标识符，默认变量名为 model
​
object
required
模型表单项显示名称
​
string
required
英文
​
string
中文
​
object
required
模型提示内容
​
string
required
英文
​
string
中文
​
array[CredentialFormSchema]
required
凭据表单规范

​
CredentialFormSchema

​
string
required
表单项变量名
​
object
required
表单项标签
​
string
required
英文
​
string
中文
​
FormType
required
表单项类型
​
boolean
是否必填
​
string
默认值
​
array[FormOption]
select 或 radio 特有的表单项属性，定义下拉内容
​
object
text-input 特有的表单项属性，表单项占位符
​
string
required
英文
​
string
中文
​
integer
text-input 特有的表单项属性，定义最大输入长度，0 表示无限制
​
array[FormShowOnObject]
当其他表单项值满足条件时显示，为空表示始终显示

​
FormType

​
string
文本输入组件
​
string
密码输入组件
​
string
单选下拉框
​
string
单选按钮组件
​
string
开关组件，仅支持 true 和 false

​
FormOption

​
object
required
标签
​
string
required
英文
​
string
中文
​
string
required
下拉选项值
​
array[FormShowOnObject]
当其他表单项值满足条件时显示，为空表示始终显示

​
FormShowOnObject

​
string
required
其他表单项变量名
​
string
required
其他表单项变量值

​
相关资源

编辑此页面 | 报告问题