文档中心
文档
备案
控制台
登录
立即注册
导航
火山方舟大模型服务平台
搜索目录或文档标题
搜索目录或文档标题
开始使用
什么是火山方舟
地域和访问域名
产品动态
产品更新公告
模型发布公告
模型弃用&下线机制说明
火山方舟 SDK V1/V2下线公告及迁移指引
模型插件联网基础版、联网plus版、联网pro版下线公告
产品简介
应用场景
产品计费
模型服务计费
知识库计费
联网系列产品计费
联网内容插件产品计费
快速入门
快速入门
模型能力
视觉理解
控制台操作
模型广场
模型广场介绍
体验中心
文本模型
语音模型
模型精调
创建模型精调任务
查看并管理模型精调任务
模型精调数据集格式说明
精调错误码
模型仓库
模型仓库
模型上传
模型评测
自动评测
模型评测体系介绍
创建模型评测任务
评测数据集格式说明
查看评测报告
在线推理
创建推理接入点(Endpoint)
查看并管理推理接入点
批量推理
智能体中心
智能体中心
零代码产品使用说明
低代码产品使用说明
高代码产品使用说明
零代码智能体操作指南
服务组件库
联网系列功能说明
计算器插件功能说明
网页解析插件功能说明
联网内容插件功能说明
联网系列插件升级为联网内容插件说明及操作指南
知识库
核心流程
知识库管理
创建知识库
编辑知识库
查看知识库列表
查看知识库详情
删除知识库
检索测试知识库
退订知识库
文档管理
导入文档
标签配置
删除文档
切片管理
新增切片
编辑切片
查阅切片
删除切片
知识库配额说明
SDK参考
Python SDK
安装与初始化
核心流程
知识库(Collection)
create_collection
get_collection
drop_collection
list_collections
update_collection
search_collection
search_and_generate
search_knowledge(新)
chat_completions(新)
文档(Doc)
add_doc
delete_doc
get_doc
list_docs
update_meta
知识点(Point)
get_point
list_points
rerank 重排
最佳实践
稀疏+稠密向量混合检索
文档图片检索生成
模型推理接入点保障 QPS
数据集
数据集介绍
共享数据集
用量统计
开通管理
网络配置
API Key 管理
安全信任
火山方舟互信计算架构白皮书
推理会话数据应用层加密方案
数据加密
API 参考
概述
API 列表
调用方式
请求结构
签名鉴权方式
返回结构
公共错误码
调用模型
模型能力概览
ChatCompletions-文字对话
ChatCompletions-视觉理解
Embeddings-向量化
Tokenization-分词
调用智能体
插件数据结构
联网插件
知识库插件
BotChatCompletions
管理API Key
GetApiKey - 获取临时API Key
管理推理接入点(Endpoint)
StartEndpoint - 开启推理接入点
StopEndpoint - 停止推理接入点
ListEndpoints - 获取推理接入点列表
GetEndpoint - 获取推理接入点
DeleteEndpoint - 删除推理接入点
UpdateEndpoint - 更新推理接入点
CreateEndpoint - 创建推理接入点
GetEndpointCertificate - 获取接入点推理端到端加密证书
管理基础模型
ListFoundationModelVersions - 获取基础模型版本列表
GetFoundationModelVersion - 获取基础模型版本信息
ListFoundationModels - 获取基础模型列表
GetFoundationModelVersionConfiguration - 获取基础模型版本配置信息(不推荐)
GetFoundationModel - 获取基础模型信息
管理批量推理任务
CreateBatchInferenceJob - 创建批量推理任务
ListBatchInferenceJobs - 获取批量推理任务列表
GetBatchInferenceJob - 获取批量推理任务信息
UpdateBatchInferenceJob - 更新批量推理任务
DeleteBatchInferenceJob - 删除批量推理任务
StopBatchInferenceJob - 停止批量推理任务
管理模型调优任务
TerminateModelCustomizationJob - 停止模型调优任务
GetModelCustomizationJob - 获取模型调优任务信息
CreateModelCustomizationJob - 创建模型调优任务
ListModelCustomizationJobs - 获取模型调优任务列表
UpdateModelCustomizationJob - 更新模型调优任务
DeleteModelCustomizationJob - 删除模型调优任务
ResumeModelCustomizationJob - 重试模型调优任务
管理定制模型
DeleteCustomModel - 删除定制模型
GetCustomModel - 获取定制模型信息
UpdateCustomModel - 更新定制模型
ListCustomModels - 获取定制模型列表
管理模型评测任务
TerminateEvaluationJob - 停止评测任务
GetEvaluationJob - 获取评测任务
ListEvaluationJobs - 获取评测任务列表
CreateEvaluationJob - 创建评测任务
UpdateEvaluationJob - 更新评测任务
ListEvaluationResults - 获取评测任务结果列表
DeleteEvaluationJob - 删除评测任务
GetEvaluationResult - 获取评测任务结果
安全审计
ListAuditLogs - 获取安全审计日志
查询用量
GetUsage - 查询推理服务调用量
SDK 参考
概述
Python SDK
环境配置与初始化
大模型调用
ChatCompletions
Embeddings
调用智能体
BotChatCompletions
Go SDK
安装与初始化
大模型调用
ChatCompletions
Embeddings
智能体调用
BotChatCompletions
Java SDK
安装与初始化
大模型调用
ChatCompletions
Embeddings
智能体调用
BotChatCompletions
多语言社区 SDK
最佳实践
使用IAM进行访问控制
Prompt 最佳实践
SFT最佳实践
豆包角色制作指南
角色扮演解决方案
智能座舱解决方案
RAG( 检索增强)解决方案
Function Calling 使用说明
Prefill Response模式最佳实践
批量推理最佳实践
在 RTC 应用中实现 AI 实时对话
常见问题
相关协议
火山方舟平台专用条款
火山方舟平台免责声明和体验服务规则说明
模型服务协议
豆包模型服务协议
月之暗面模型服务协议
智谱AI模型服务协议
算法备案
客户应用上架指南-算法备案资质申请流程
模型简介
旧版文档
升级一览
文档首页
/
火山方舟大模型服务平台
/
API 参考
/
历史版本
/
获取 API key
获取 API key
最近更新时间:2024.12.04 21:20:39
首次发布时间:2024.05.14 23:50:17
我的收藏
文档反馈
获取API Key请参见
API Key 管理
。