Redocly 提供的 API 文档

NVIDIA ACE Agent NLP 服务器 (4.0.0)

下载 OpenAPI 规范:下载

健康状况 API

用于检查服务器健康状态的 API

根路径

健康检查端点

响应

响应示例

内容类型
application/json
null

获取指标

响应

响应示例

内容类型
application/json
null

注册表 API

用于获取可用模型的模型元数据的 API

模型是否就绪

检查模型注册表中模型的状态

查询参数
model_name
必需
string (模型名称)
endpoint
必需
string (端点)
model_version
string (模型版本)

响应

响应示例

内容类型
application/json
null

列出模型

列出模型注册表中的所有模型

响应

响应示例

内容类型
application/json
null

模型 API

NLP 服务器的底层模型 API

预测意图槽

联合意图槽分类模型 API

请求体模式: application/json
必需
query
必需
string (查询)
model_name
string (模型名称)
model_version
string (模型版本)

响应

请求示例

内容类型
application/json
{
  • "query": "string",
  • "model_name": "string",
  • "model_version": "string"
}

响应示例

内容类型
application/json
{
  • "domain": {
    },
  • "intent": {
    },
  • "entities": {
    }
}

文本分类

文本分类模型 API

请求体模式: application/json
必需
query
必需
string (查询)
model_name
string (模型名称)
model_version
string (模型版本)

响应

请求示例

内容类型
application/json
{
  • "query": "string",
  • "model_name": "string",
  • "model_version": "string"
}

响应示例

内容类型
application/json
{
  • "class_name": "string",
  • "score": 0
}

处理命名实体识别

命名实体识别模型 API

请求体模式: application/json
必需
query
必需
string (查询)
model_name
string (模型名称)
model_version
string (模型版本)

响应

请求示例

内容类型
application/json
{
  • "query": "string",
  • "model_name": "string",
  • "model_version": "string"
}

响应示例

内容类型
application/json
{
  • "entities": [
    ]
}

处理嵌入

嵌入模型 API

请求体模式: application/json
必需
queries
必需
Array of strings (查询)
model_name
string (模型名称)
model_version
string (模型版本)

响应

请求示例

内容类型
application/json
{
  • "queries": [
    ],
  • "model_name": "string",
  • "model_version": "string"
}

响应示例

内容类型
application/json
{
  • "queries": [
    ],
  • "embeddings": [
    ]
}

处理抽取式问答

抽取式问答模型 API

请求体模式: application/json
必需
query
必需
string (查询)
documents
必需
Array of strings (文档)
top_n
必需
integer (前 N 个)
model_name
string (模型名称)
model_version
string (模型版本)

响应

请求示例

内容类型
application/json
{
  • "query": "string",
  • "documents": [
    ],
  • "top_n": 0,
  • "model_name": "string",
  • "model_version": "string"
}

响应示例

内容类型
application/json
{
  • "results": [
    ]
}

嵌入搜索 API

用于嵌入搜索的 API

创建嵌入

请求体模式: application/json
必需
必需
Array of objects (锚点)
store_name
必需
string (存储名称)
model_name
string (模型名称)
model_version
string (模型版本)

响应

请求示例

内容类型
application/json
{
  • "anchors": [
    ],
  • "store_name": "string",
  • "model_name": "string",
  • "model_version": "string"
}

响应示例

内容类型
application/json
null

嵌入搜索

请求体模式: application/json
必需
query
必需
string (查询)
embedding_stores
Array of strings (嵌入存储)
Array of objects (锚点)
model_name
string (模型名称)
model_version
string (模型版本)
top_k
integer (前 K 个)
默认值: 1

响应

请求示例

内容类型
application/json
{
  • "query": "string",
  • "embedding_stores": [
    ],
  • "anchors": [
    ],
  • "model_name": "string",
  • "model_version": "string",
  • "top_k": 1
}

响应示例

内容类型
application/json
{
  • "results": [
    ]
}

删除存储

查询参数
store_name
必需
string (存储名称)
model_name
string (模型名称)
model_version
string (模型版本)

响应

响应示例

内容类型
application/json
null

语言翻译 API

用于将文本从源语言翻译为目标语言的 API

翻译

将文本从源语言翻译为目标语言

请求体模式: application/json
必需
texts
必需
Array of strings (文本)
source_language
必需
string (源语言)
target_language
必需
string (目标语言)
model_name
string (模型名称)
model_version
string (模型版本)

响应

请求示例

内容类型
application/json
{
  • "texts": [
    ],
  • "source_language": "string",
  • "target_language": "string",
  • "model_name": "string",
  • "model_version": "string"
}

响应示例

内容类型
application/json
{
  • "translated_texts": [
    ]
}

语音 API

用于集成语音模型和第三方 API（如 ASR 和 TTS）的 API

文本转语音

文本转语音 API

请求体模式: application/json
必需
text
必需
string (文本)
voice_name
必需
string (声音名称)
model_name
string (模型名称)
默认值: ""
model_version
string (模型版本)
默认值: ""
language_code
string (语言代码)
默认值: "en-US"
sample_rate_hz
integer (采样率 Hz)
默认值: 44100

响应

请求示例

内容类型
application/json
{
  • "text": "string",
  • "voice_name": "string",
  • "model_name": "",
  • "model_version": "",
  • "language_code": "en-US",
  • "sample_rate_hz": 44100
}

响应示例

内容类型
application/json
null

自定义 API

用户为 NLP 服务器创建的 API