Generated with sparks and insights from 2 sources

img10

img11

img12

img13

img14

img15

Introduction

  • 火山方舟大模型服务平台提供了详细的API调用指南，支持多种编程语言。

  • 用户需要获取AccessKey ID和Secret Access Key（AK/SK）进行API请求认证和鉴权。

  • SDK V3版本新增了API Key鉴权模式，简化了调用过程。

  • 支持的编程语言包括Python、Golang和Java。

  • 用户可以通过火山方舟的模型接入页面建立Endpoint，作为请求接入的入口。

  • API调用支持多种功能，包括聊天、分类、嵌入和分词。

  • 提供了详细的参数说明和示例代码，帮助用户快速上手。

API调用前提条件 [1]

  • 用户需要通过火山引擎SDK来使用服务，支持Python、Golang和Java版本。

  • 前往火山方舟的模型接入页面建立Endpoint，作为请求接入的入口。

  • 调用前需要获取AccessKey ID和Secret Access Key（AK/SK），用于API请求认证和鉴权。

  • 如果用户需要自己实现client调用代码，需要用AK/SK进行旁路鉴权。

  • 火山鉴权逻辑可以参考签名方法。

模型调用API [1]

  • 火山方舟对模型调用API进行了新版本升级，新增了API Key鉴权模式。

  • 支持的编程语言包括Python、Golang和Java。

  • 用户可以通过火山方舟的模型接入页面建立Endpoint，作为请求接入的入口。

  • API调用支持多种功能，包括聊天、分类、嵌入和分词。

  • 提供了详细的参数说明和示例代码，帮助用户快速上手。

聊天功能 [1]

  • 聊天功能支持多种消息类型，包括文本和图片。

  • 消息是列表形式，依次记录了消息聊天上下文。

  • 支持流式返回，按SSE（Server-Sent Events）协议返回数据。

  • 提供了详细的参数说明，包括消息角色、内容、工具列表等。

  • 示例代码展示了如何使用Curl进行聊天功能的调用。

分词功能 [1]

  • 分词功能用于将文本编码为token。

  • 输入字段包括需要编码的文本。

  • 输出字段包括请求id、编码后token的数量、token列表等。

  • 提供了详细的参数说明和示例代码，帮助用户快速上手。

  • 示例代码展示了如何使用Curl进行分词功能的调用。

分类功能 [1]

  • 分类功能用于将输入的查询请求内容进行分类。

  • 输入字段包括查询请求内容和类别列表。

  • 输出字段包括请求id、选中的label、每个label的token概率等。

  • 强烈建议使用单token_id的label，以大幅度提高性能。

  • 示例代码展示了如何使用Curl进行分类功能的调用。

嵌入功能 [1]

  • 嵌入功能用于将输入的内容向量化。

  • 输入字段包括需要向量化的内容。

  • 输出字段包括请求id、每个query的向量化结果等。

  • 提供了详细的参数说明和示例代码，帮助用户快速上手。

  • 示例代码展示了如何使用Curl进行嵌入功能的调用。

示例代码 [1]

  • 提供了多种编程语言的示例代码，包括Python、Golang和Java。

  • 示例代码展示了如何进行聊天、分词、分类和嵌入功能的调用。

  • 每个示例代码都包含详细的参数说明和调用步骤。

  • 用户可以根据示例代码快速上手，进行API调用。

  • 示例代码链接：Python、Golang、Java。

img10

<br><br>