Generative AI Endpoint Calls

Generative AI Endpoint Calls

This document is created to explain how to use endpoints for Generative AI. With API Endpoints improvement, now clients will be able to create document with placeholder keys in it to be able to use it dynamically. Also, with new endpoints clients will be able to batch add or update documents.

How To Add or Update Documents To Knowledge Base?

To be able to add or update bulk documents you can use following endpoints.

In Postman Collections page, click on Import button. This will open a new window, copy paste related endpoint curl request you want use.




  • {domain} can be change due to environment.

dev - dev.mindbehind.com

uat - uatapp.mindbehind.com

master - app.mindbehind.com

  • You can get companyId and knowledgebaseId from MindBehind Knowledge Base Page.

Batch Add Document:

  2. curl --location 'https://{domain}/oai-orchestrator/knowledgebase/context/{companyId}/{knowledgebaseId}/batch' \
  3. --header 'accept: application/json' \
  4. --header 'token: {securityToken}' \
  5. --data '{
  6.     "contexts": [
  7.         {
  8.             "label": "label",
  9.             "createdBy": "userId",
  10.             "content": {
  11.                 "language": "English",
  12.                 "contentText": "content"
  13.             }
  14.         },
  15.         {
  16.             "label": "label",
  17.             "createdBy": "userId",
  18.             "content": {
  19.                 "language": "English",
  20.                 "contentText": "content"
  21.             }
  22.         }
  23.     ]
  24. }'
Batch Update Document:
  2. curl --location --request PATCH 'https://{domain}/oai-orchestrator/knowledgebase/context/{companyId}/{knowledgebaseID}/batch' \
  3. --header 'content-type: application/json' \
  4. --header 'token: {securityToken}' \
  5. --data '{
  6.     "contexts": [
  7.         {
  8. "_id": "id",
  9.             "label": "label",
  10.             "knowledgeBaseId": "knowledgeBaseId",
  11.             "content": {
  12.                 "language": "English",
  13.                 "contentText": "context"
  14.             }
  15.         },
  16.         {
  17. "_id": "id",
  18. "label": "label",
  19.             "knowledgeBaseId": "knowledgeBaseId",
  20.             "content": {
  21.                 "language": "Turkish",
  22.                 "contentText": "context"
  23.             }
  24.         }
  25.     ]
  26. }'
Batch Get Document:

  2. curl --location --globoff 'https://{{domain}}/oai-orchestrator/knowledgebase/context/{companyID}/{knowledgebaseID}/batch' \
  3. --header 'accept: application/json' \
  4. --header 'token: {securityToken}'

How To Add or Update Dictionary To Knowledge Base Using Postman?

Update a new dictionary

  2. curl --location --request PATCH 'http://{domain}/oai-orchestrator/oai-dictionary/knowledgebase' \
  3. --header 'token: {oldSecurityToken}' \
  4. --header 'Content-Type: application/json' \
  5. --data '{
  6.     "knowledgeBaseId": "randomID",
  7.     "companyId": "companyId",
  8.     "token": "newSecurityToken",
  9.     "dictionary": {
  10.         "key": "value"
  11.     }
  12. }'
Delete a dictionary
  2. curl --location --request DELETE 'http://{domain}/oai-orchestrator/oai-dictionary/knowledgebase/knowledgebaseID' \
  3. --header 'token: token'
You can also use this API to get the token for related dictionary
  1. curl --location 'http://{domain}/oai-orchestrator/oai-dictionary/dictionaryID'

    • Related Articles

    • Generative AI: Dictionary & Keys

      What are dictionary & keys? Dictionary is a feature of Generative AI, which is designed to show texts in multiple fields and update those text with only one action into those multiple fields. Keys are the pointers that we use into Gen AI Knowledge ...

    • How to Use Generative AI Module

      What is Generative AI Module for? The Generative AI Module is designed for generating human-like text based on given prompts or input. It utilizes advanced natural language processing and artificial intelligence techniques to produce coherent and ...

    • AI Designer Tricks

      General Settings 1. How to use 'Global Keyword' 1. Go to 'Settings' gear icon so see more options of customization. Functionality: Global Keyword helps you to achieve immediate bot reaction without AI . The condition is 1 score* wording resemblance. ...

    • How to Use AI Action

      Action usage AI action helps user to create a comprehensive conversation without too much effort. MindBehind supports three AI providers: Google DialogFlow, IBM Watson, CLU and Microsoft Luis. After connecting to a provider, the page fills up with ...

    • LUIS Provider User Documentation

      Prerequisites: To connect Microsoft LUIS AI Provider in MindBehind following fields needs to be filled. Application ID, Authoring Resource Primary Key, Prediction Resource Primary Key, Endpoint and Management Endpoint fields can be provided from Luis ...