聊天引擎服务器 API (4.0.0)

下载 OpenAPI 规范:下载

NVIDIA ACE Agent 聊天引擎服务器 API

健康检查 API

用于检查和监控服务器健康状态的 API。

是否就绪

检查机器人的状态并返回可用机器人的详细信息

查询参数
BotName
string (Botname) <= 4096 个字符

响应

响应示例

内容类型
application/json
示例
[ ]

获取指标

响应

响应示例

内容类型
application/json
null

健康检查

执行健康检查

当服务启动时返回 200。这不检查下游服务的健康状况。

响应

响应示例

内容类型
application/json
null

核心 API

用于发送带有有效查询或事件的用户请求的 API。

聊天

此端点可用于为特定机器人的查询驱动的用户请求提供响应,使用定义的 NLU 模型和插件模块。响应形成方法从机器人配置和定义的规则中选取。

请求正文模式: application/json
必需
Botname (string) or Botname (null) (Botname)

需要访问的机器人名称。如果聊天引擎内部署了多个机器人,则此字段是必需的。它的值应与机器人配置文件中定义的“bot:”字段匹配。

Query (string) or Query (null) (Query)
默认值: ""

需要处理的用户查询。

UserId
必需
string (Userid) <= 4096 个字符

强制性的唯一标识符,用于识别哪个用户正在与聊天引擎交互。

Sourcelanguage (string) or Sourcelanguage (null) (Sourcelanguage)

用户查询的语言。如果用户查询的语言与机器人的语言不匹配,则聊天引擎会尝试调用机器翻译模型(目前不支持)以将查询转换为机器人语言。

Targetlanguage (string) or Targetlanguage (null) (Targetlanguage)

聊天引擎响应文本的预期语言。如果响应文本的语言与预期的输出语言不匹配,则聊天引擎会尝试调用机器翻译模型(目前不支持)来进行转换。

Usercontext (object) or Usercontext (null) (Usercontext)

对话流程所需的任何运行时自定义参数,都与此用户 ID 绑定。这在所有履行端点的请求 JSON 中以及上下文中填充。

Metadata (object) or Metadata (null) (Metadata)
默认值: {}

对话流程所需的任何聊天特定元数据。

响应

请求示例

内容类型
application/json
{
  • "BotName": "string",
  • "Query": "",
  • "UserId": "string",
  • "SourceLanguage": "string",
  • "TargetLanguage": "string",
  • "UserContext": { },
  • "Metadata": { }
}

响应示例

内容类型
application/json
null

事件

此端点可用于为特定机器人的事件驱动的用户请求提供响应,使用定义的 NLU 模型和插件模块。响应形成方法从机器人配置和定义的规则中选取。

请求正文模式: application/json
必需
Botname (string) or Botname (null) (Botname)

需要访问的机器人名称。如果聊天引擎内部署了多个机器人,则此字段是必需的。它的值应与机器人配置文件中定义的“bot:”字段匹配。

EventType
string (Eventtype) <= 4096 个字符
默认值: ""

需要处理的事件名称。

UserId
必需
string (Userid) <= 4096 个字符

强制性的唯一标识符,用于识别哪个用户正在与聊天引擎交互。

Metadata (object) or Metadata (null) (Metadata)
默认值: {}

对话流程所需的任何事件特定元数据。

Usercontext (object) or Usercontext (null) (Usercontext)

对话流程所需的任何运行时自定义参数,都与此用户 ID 绑定。这在所有履行端点的请求 JSON 中以及上下文中填充。

响应

请求示例

内容类型
application/json
{
  • "BotName": "string",
  • "EventType": "",
  • "UserId": "string",
  • "Metadata": { },
  • "UserContext": { }
}

响应示例

内容类型
application/json
示例
{
  • "Events": [
    ],
  • "EventType": "string",
  • "Response": {
    },
  • "Latency": {
    }
}

用户上下文 API

用于在运行时配置用户参数的 API。

更新用户上下文

在运行时更新用户的上下文。

查询参数
UserId
必需
string (Userid) <= 4096 个字符
请求正文模式: application/json
必需
object (Context)

响应

请求示例

内容类型
application/json
{ }

响应示例

内容类型
application/json
{
  • "StatusMessage": "string"
}

设置用户上下文

在运行时设置用户的上下文。它会覆盖任何现有上下文。

请求正文模式: application/json
必需
UserId
string (Userid) <= 4096 个字符

用于识别哪个用户正在与聊天引擎交互的唯一标识符。

Context
object (Context)
默认值: {}

需要在提供的用户内存上下文中更新的键值对。

必需
object (Chathistory) <= 256 个属性

提供的用户 ID 机器人方面的聊天记录。

EventHistory
必需
object (Eventhistory)

提供的用户 ID 机器人方面的事件历史记录。

响应

请求示例

内容类型
application/json
{
  • "UserId": "string",
  • "Context": { },
  • "ChatHistory": {
    },
  • "EventHistory": { }
}

响应示例

内容类型
application/json
{
  • "StatusMessage": "string"
}

获取用户上下文

返回指定用户 ID 的上下文。

查询参数
UserId
必需
string (Userid) <= 4096 个字符

响应

响应示例

内容类型
application/json
示例
{
  • "UserId": "string",
  • "Context": { },
  • "ChatHistory": {
    },
  • "EventHistory": { }
}

删除用户上下文

在运行时删除用户的上下文。

查询参数
UserId
必需
string (Userid) <= 4096 个字符

响应

响应示例

内容类型
application/json
{
  • "StatusMessage": "string"
}

机器人 API

用于在运行时控制机器人行为的 API。

重新加载机器人

如果提供了机器人名称,则重新加载所有已部署的机器人或选定的机器人

查询参数
BotName
string (Botname) <= 4096 个字符
BotVersion
string (Botversion) <= 4096 个字符
默认值: "1"

响应

响应示例

内容类型
application/json
{
  • "StatusMessage": "string"
}