API docs by Redocly

Nvidia Botmaker Dialog Manager Server (3.0.0-ea)

Download OpenAPI specification:Download

NVIDIA Botmaker Dialog Manager Server API

Health APIs

APIs for checking and monitoring Server Health Status.

Is Ready

Check status of the bots and returns the details of available bots

query Parameters
BotName
string (Botname)
BotVersion
string (Botversion)
Default: "1"

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get Metrics

Responses

Response samples

Content type
application/json
null

Core APIs

APIs for sending user requests with a valid query or event.

Chat

This endpoint can be used to provide response to query driven user request for a specific bot, using defined NLU models and Fulfillment modules. The response formation methodology is picked from the bot configurations and rules defined.

Request Body schema: application/json
required
BotName
string (Botname)

The Bot Name which needs to be accessed. This field is mandatory if multiple bots are deployed within Dialog Manager. It's value should match the 'bot: ' field defined in the bot config file.

BotVersion
string (Botversion)

The Bot version which needs to be accessed. It should match the 'version: ' field defined in the bot config file.

Query
string (Query)
Default: ""

The user query which needs to be processed.

UserId
required
string (Userid)

Mandatory unique identifier to recognize which user is interacting with the dialog manager.

QueryId
string (Queryid)

Unique identifier for the user query. This field is assigned automatically by the dialog manager if not defined.

SourceLanguage
string (Sourcelanguage)

Language of the user query. If language of user query does not match language of the bot, then dialog manager tries to call machine translator model (currently not supported) to convert the query to bot language.

TargetLanguage
string (Targetlanguage)

Expected Langauge of Dialog Manager Response text. If language of response text does not match expected output language, then dialog manager tries to call machine translator model (currently not supported) to do the conversion.

UserContext
object (Usercontext)

Any runtime custom parameters needed for dialog flow. tied to this user id. This is populated as part of the request JSON of all fulfillment endpoints as well under context.

Responses

Request samples

Content type
application/json
{
  • "BotName": "string",
  • "BotVersion": "string",
  • "Query": "",
  • "UserId": "string",
  • "QueryId": "string",
  • "SourceLanguage": "string",
  • "TargetLanguage": "string",
  • "UserContext": { }
}

Response samples

Content type
application/json
Example
{
  • "ApiVersion": "string",
  • "SourceLanguage": "en-US",
  • "TargetLanguage": "en-US",
  • "SchemaVersion": "string",
  • "UserId": "string",
  • "SessionId": "string",
  • "TimeStamp": "string",
  • "QueryId": "string",
  • "Query": "string",
  • "ProcessedQuery": "string",
  • "Response": {
    },
  • "Latency": {
    }
}

Event

This endpoint can be used to provide response to a event driven user request for a specific bot, using defined NLU models and Fulfillment modules. The response formation methodology is picked from the bot configurations and rules defined.

Request Body schema: application/json
required
BotName
string (Botname)

The Bot Name which needs to be accessed. This field is mandatory if multiple bots are deployed within Dialog Manager. It's value should match the 'bot: ' field defined in the bot config file.

BotVersion
string (Botversion)

The Bot version which needs to be accessed. It should match the 'version: ' field defined in the bot config file.

EventType
string (Eventtype)
Default: ""

The event name which needs to be processed.

UserId
required
string (Userid)

Mandatory unique identifier to recognize which user is interacting with the dialog manager.

Eventid
string (Eventid)

Unique identifier for the user event. This field is assigned automatically by the dialog manager if not defined.

Metadata
object (Metadata)

Any event specific metadata needed for dialog flow.

UserContext
object (Usercontext)

Any runtime custom parameters needed for dialog flow, tied to this user id. This is populated as part of the request JSON of all fulfillment endpoints as well under context.

Responses

Request samples

Content type
application/json
{
  • "BotName": "string",
  • "BotVersion": "string",
  • "EventType": "",
  • "UserId": "string",
  • "Eventid": "string",
  • "Metadata": { },
  • "UserContext": { }
}

Response samples

Content type
application/json
Example
{
  • "ApiVersion": "string",
  • "SchemaVersion": "string",
  • "UserId": "string",
  • "EventId": "string",
  • "SessionId": "string",
  • "TimeStamp": "string",
  • "EventType": "string",
  • "Events": [
    ],
  • "Response": {
    },
  • "Latency": {
    }
}

User Context APIs

APIs for configuring the user parameters at runtime.

Update User Context

Updates the context of the user at runtime.

query Parameters
UserId
required
string (Userid)
Request Body schema: application/json
required
object (Context)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Set User Context

Sets the context of the user at runtime. It overwrites any existing context.

Request Body schema: application/json
required
UserId
string (Userid)

Unique identifier to recognize which user is interacting with the dialog manager.

Context
object (Context)
Default: "[object Object]"

The key value pairs which needs to be updated in the context of the provided user memory.

required
object (Chathistory)

The chat history of the provided user id bot wise.

EventHistory
required
object (Eventhistory)

The event history of the provided user id bot wise.

Responses

Request samples

Content type
application/json
{
  • "UserId": "string",
  • "Context": { },
  • "ChatHistory": {
    },
  • "EventHistory": { }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get User Context

Returns the context for a specified user ids.

query Parameters
UserId
required
string (Userid)

Responses

Response samples

Content type
application/json
Example
{
  • "UserId": "string",
  • "Context": { },
  • "ChatHistory": {
    },
  • "EventHistory": { }
}

Delete User Context

Deletes the context of the user at runtime.

query Parameters
UserId
required
string (Userid)

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Bot APIs

APIs for controlling bot behaviour at runtime.

Reload Bot

Reloads all the deployed bots or a selected bot if a bot name is provided

query Parameters
BotName
string (Botname)
BotVersion
string (Botversion)
Default: "1"

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}