创建网络代理

开发环境

POST

/v1/agents

配置新 Web 代理的所有设置。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1/agents' \
--header 'authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "prompt": "<string>",
  "voice": "<string>",
  "analysis_schema": {},
  "metadata": {},
  "pathway_id": "<string>",
  "language": "<string>",
  "model": "<string>",
  "first_sentence": "<string>",
  "tools": [
    {}
  ],
  "dynamic_data": {},
  "interruption_threshold": 123,
  "keywords": [
    "<string>"
  ],
  "max_duration": {}
}'

响应示例

{
  "agent": {
    "agent_id": "2c565dc7-f41f-43db-a99f-e4c8ba9d7d18",
    "webhook": null,
    "dynamic_data": null,
    "interruption_threshold": null,
    "first_sentence": null,
    "model": "enhanced",
    "voice_settings": null,
    "voice": "maya",
    "prompt": "...",
    "temperature": null,
    "max_duration": 30,
    "language": "ENG",
    "tools": null
  }
}

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

authorization

string

必需

您用于身份验证的 API 密钥。

Web 调用用法示例（客户端）：

import { BlandWebClient } from 'bland-client-js-sdk';

const agentId = 'YOUR-AGENT-ID';
const sessionToken = 'YOUR-SESSION-TOKEN';

示例值:

Body 参数application/json

prompt

string

必需

提供理想对话流程的说明、相关信息和示例。

voice

string

可选

设置座席的声音 - 可以通过“列表声音”端点找到所有可用的声音。

analysis_schema

object

可选

定义一个 JSON 架构，决定如何获取有关呼叫的信息 - 电子邮件地址、姓名、预约时间或任何其他类型的自定义数据等信息。在 Webhook 响应中或以后每当您检索调用数据时，您都会在下获得您定义的数据analysis。例如，如果您想从调用中检索此信息：

json "analysis_schema": {   "email_address": "email",   "first_name": "string",   "last_name": "string",   "wants_to_book_appointment": "boolean",   "appointment_time": "YYYY-MM-DD HH:MM:SS" }

调用完成后，您将在 Webhook 中填写如下内容：

json "analysis": {   "email_address": "johndoe@gmail.com",   "first_name": "John",   "last_name": "Doe",   "wants_to_book_appointment": true,   "appointment_time": "2024-01-01 12:00:00" }

metadata

object

可选

添加您想要与呼叫关联的任何其他信息。这对于跟踪或分类呼叫非常有用。

pathway_id

string

可选

设置您的代理将遵循的路径。这将覆盖该prompt字段，因此如果您要设置路径，则无需传递“提示”字段。警告：设置路径会将以下字段设置为其null默认值 - prompt、first_sentence、model、dynamic_data、tools 设置为null或空字符串以清除路径。

language

string

可选

选择您选择的支持语言。针对该语言优化 API 的每个部分 - 转录、语音和其他内部工作。支持的语言及其代码： - 英语：ENG - 西班牙语：ESP - 法语： FRE - 抛光：POL - 德语：GER - 意大利语：ITA - 巴西葡萄牙语：PBR - 葡萄牙语：POR

model

string

可选

选择用于您通话的型号。选项：base、turbo和enhanced。几乎在所有情况下，enhanced这是目前最好的选择。

first_sentence

string

可选

您的通话将以此短语开头，而不是即时生成的短语。无论有没有，这都有效wait_for_greeting。可以多于一句话，但不得超过 200 个字符。要删除，请设置为null或空字符串。

tools

array [object]

可选

通过API调用与现实世界交互。详细教程在这里：自定义工具

dynamic_data

object

可选

将外部 API 的数据集成到代理的知识中。设置为null或空字符串以清除动态数据设置。发送呼叫端点中的详细用法。

interruption_threshold

integer

可选

调整 AI 在等待用户说完时的耐心程度。较低的值意味着 AI 会更快地响应，而较高的值意味着 AI 在响应之前会等待更长时间。推荐范围：50-200 - 50：极其快速的来回对话 - 100：平衡地以自然的速度做出反应 - 200：非常有耐心，允许长时间停顿和中断。非常适合收集详细信息。尝试从 100 开始，然后根据您的用例需要以 ~10 的增量进行小幅调整。

keywords

array[string]

可选

这些单词将在转录引擎中得到增强 - 建议用于专有名词或经常被错误转录的单词。例如，如果“Reece”一词经常被转录为“Reese”等同音异义词，您可以这样做： json { "keywords": ["Reece"] } 为了获得更强的关键字增强效果，您可以在单词后面放置一个冒号，然后放置一个增强因子。默认提升因子为 2。 json { "keywords": ["Reece:3"] }

max_duration

object

可选

在自动终止之前，对座席的呼叫可以持续的最长时间。设置为null重置为默认值。

示例

返回响应

🟢200成功

application/json

Body

agent

object

必需

agent_id

string

必需

webhook

null

必需

dynamic_data

null

必需

interruption_threshold

null

必需

first_sentence

null

必需

model

string

必需

voice_settings

null

必需

voice

string

必需

prompt

string

必需

temperature

null

必需

max_duration

integer

必需

language

string

必需

tools

null

必需

修改于 2024-05-10 07:23:39

获取更正的成绩单

更新网络代理设置