API docs by Redocly

NVIDIA BotMaker NLP Server (3.0.0-ea)

Download OpenAPI specification:Download

Health APIs

APIs for checking Server Health Status

Root

Health Check Endpoint

Responses

Response samples

Content type
application/json
null

Get Metrics

Responses

Response samples

Content type
application/json
null

Registry APIs

APIs for getting model metadata for available models

Is Model Ready

Check status of model in Model Registry

query Parameters
model_name
required
string (Model Name)
endpoint
required
string (Endpoint)
model_version
string (Model Version)

Responses

Response samples

Content type
application/json
null

List Models

List all models in Model Registry

Responses

Response samples

Content type
application/json
null

Model APIs

Low Level Model APIs for NLP Server

Predict Intent Slot

Joint Intent Slot Classification Model API

Request Body schema: application/json
required
query
required
string (Query)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
{
  • "domain": {
    },
  • "intent": {
    },
  • "entities": {
    }
}

Classify Text

Text Classification Model API

Request Body schema: application/json
required
query
required
string (Query)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
{
  • "class_name": "string",
  • "score": 0
}

Process Ner

Named Entity Recognition Model API

Request Body schema: application/json
required
query
required
string (Query)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Process Embeddings

Embedding Model API

Request Body schema: application/json
required
queries
required
Array of strings (Queries)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "queries": [
    ],
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
{
  • "queries": [
    ],
  • "embeddings": [
    ]
}

Process Zero Shot Ner

Zero Shot Named Entity Recognition Model API

Request Body schema: application/json
required
query
required
string (Query)
required
object (Anchors)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "anchors": {
    },
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Process Eqa

Extractive QA Model API

Request Body schema: application/json
required
query
required
string (Query)
documents
required
Array of strings (Documents)
top_n
required
integer (Top N)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "documents": [
    ],
  • "top_n": 0,
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Complete Text

Text Completion Model API

Request Body schema: application/json
required
prompt
required
string (Prompt)
object (Parameters)
Default: "[object Object]"
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "prompt": "string",
  • "parameters": {
    },
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
{
  • "completion_labels": [
    ],
  • "prompt_labels": [
    ],
  • "text": ""
}

Embedding Search APIs

APIs for Embedding Search

Create Embedding

Request Body schema: application/json
required
required
Array of objects (Anchors)
store_name
required
string (Store Name)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "anchors": [
    ],
  • "store_name": "string",
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
null

Embedding Search

Request Body schema: application/json
required
query
required
string (Query)
embedding_stores
Array of strings (Embedding Stores)
Array of objects (Anchors)
model_name
string (Model Name)
model_version
string (Model Version)
top_k
integer (Top K)
Default: 1

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "embedding_stores": [
    ],
  • "anchors": [
    ],
  • "model_name": "string",
  • "model_version": "string",
  • "top_k": 1
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Delete Store

query Parameters
store_name
required
string (Store Name)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Response samples

Content type
application/json
null

Information Retrivial APIs

APIs for IR document ingestion and inference

Ingestion

Ingest list of urls, txt files and html files with .csv or .tar.gz

Request Body schema: multipart/form-data
required
documents
string <binary> (Documents)
urls
Array of strings (Urls)
document_store_name
required
string (Document Store Name)
model_name
string (Model Name)
model_version
string (Model Version)
content_type
string (Content Type)
Default: "document"
chunk_size
integer (Chunk Size)
Default: 256
chunk_overlap
integer (Chunk Overlap)
Default: 32

Responses

Response samples

Content type
application/json
null

Show All Document Stores

Lists all document stores present on IR server

query Parameters
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Response samples

Content type
application/json
null

Delete Document Store

Deletes document store from IR server

query Parameters
document_store_name
required
string (Document Store Name)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Response samples

Content type
application/json
null

Retrieval

Request Body schema: application/json
required
query
required
string (Query)
document_store_name
required
string (Document Store Name)
model_name
string (Model Name)
model_version
string (Model Version)
top_k
integer (Top K)
Default: 10
rerank
boolean (Rerank)
Default: true

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "document_store_name": "string",
  • "model_name": "string",
  • "model_version": "string",
  • "top_k": 10,
  • "rerank": true
}

Response samples

Content type
application/json
null

Language Translation APIs

APIs for translating text from source language to target language

Translate

Translate text from source language to target language

Request Body schema: application/json
required
texts
required
Array of strings (Texts)
source_language
required
string (Source Language)
target_language
required
string (Target Language)
model_name
string (Model Name)
model_version
string (Model Version)

Responses

Request samples

Content type
application/json
{
  • "texts": [
    ],
  • "source_language": "string",
  • "target_language": "string",
  • "model_name": "string",
  • "model_version": "string"
}

Response samples

Content type
application/json
{
  • "translated_texts": [
    ]
}

Speech APIs

APIs for integrating Speech models and 3rd party APIs such as ASR and TTS

Text To Speech

Text to Speech API

Request Body schema: application/json
required
text
required
string (Text)
voice_name
required
string (Voice Name)
model_name
string (Model Name)
Default: ""
model_version
string (Model Version)
Default: ""
language_code
string (Language Code)
Default: "en-US"
sample_rate_hz
integer (Sample Rate Hz)
Default: 44100

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "voice_name": "string",
  • "model_name": "",
  • "model_version": "",
  • "language_code": "en-US",
  • "sample_rate_hz": 44100
}

Response samples

Content type
application/json
null

Custom APIs

User created APIs for NLP Server