OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Create a Simple Bot
SKILLS
Storyboard
Dialog Tasks
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Train
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Introduction
How to Configure Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Bot Versioning
Collaborative Development
Plan Management
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Create a Simple Bot
Create a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
RELEASE NOTES

ユーザーAPIを更新

ユーザーの詳細を更新します。

このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [セキュリティおよび管理] の [ユーザー管理] の管理APIスコープを必要とします。

入力 https://{{host}}/api/public/users 注意:この機能は、プラットフォームのバージョン7.1で導入されました。

クエリパラメータ

パラメータ 説明
ホスト 環境URL(例: https://bots.kore.ai)

本文パラメータ

パラメータ 説明
users 更新する必要のある各ユーザーの詳細の配列

userInfo.emailIdまたはuserInfo.orgUserId(必須) 更新されるユーザーのメールIDまたは組織のユーザーID
userInfo.firstName(任意) 更新が必要なユーザーの名
userInfo.lastName(任意) 更新が必要なユーザーの姓
userInfo.companyName(任意) 更新が必要なユーザーの会社
userInfo.dept(任意) 更新が必要なユーザーの部署
userInfo.companyContactPhone(任意) 更新が必要なユーザーが所属する会社の連絡先電話番号
userInfo.worknumber(任意) 更新が必要なユーザーの仕事用の電話番号
userInfo.street(任意) 更新が必要なユーザーの市区町村
userInfo.suiteNo(任意) 更新が必要なユーザーの番地
userInfo.city(任意) 更新が必要なユーザーの都市
userInfo.zip(任意) 更新が必要なユーザーの郵便番号
userInfo.state(任意) 更新が必要なユーザーの都道府県
userInfo.country(任意) 更新が必要なユーザーの国
groups(任意) ユーザーがaddToまたはremoveFromとされるべきグループIDの配列
roles(任意) ユーザーがaddToまたはremoveFromとされるべきroleIdとbotIdの組み合わせの配列
assignBotTasks(任意) ユーザーに割り当てられなければならないボットの配列です。存在しない場合は、現在の割り当てが保持されます。

botId ユーザーに割り当てられるボットのIDです。指定されていない場合は、以前割り当てられていたすべてのボットが割り当てられなくなります。つまり、ボットタスクのユーザーへの割り当てを解除するために、"botId"エントリのない"assignBotTasks"のエントリを使用することができます。
dialogs ユーザーに割り当てる必要のあるボット内のダイアログタスクIDの配列です。指定されていない場合は、すべてのダイアログタスクが割り当てられます。
canCreateBot(任意) 指定されたユーザーが、ボットビルダーのアカウントでボットを作成できるかどうかを判断します。TrueまたはFalseを設定します。デフォルト値は"True"です。
isDeveloper(任意) 指定されたユーザーがボットビルダーにアクセスできるかどうかを判断します。TrueまたはFalseを設定します。デフォルト値は"True"です。

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X PUT \ https://{{host}}/api/public/users \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '{ "users": [ { "userInfo": { "emailId": "publicuser2@gmail.com" // or "orgUserId": <orgUserId>, "firstName": "user1", "lastName":"user1", "companyName":"company_name", "dept":"dept", "companyContactPhone":"12334444", "worknumber":"321", "street":"street", "suiteNo":"suite", "city":"city", "zip":"123123", "state":"state", "country":"country" }, "groups": { "addTo": [ "e-f9c09c08-9310-52ff-b672-570ec7325215" ] }, "roles": { "addTo": [ { "roleId": "5d9d8db3x0d54920a8df1e68b", "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733" } ], "removeFrom": [ { "roleId": "5d9d920dabdc1e6e8ec99342", "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b" } ] }, "assignBotTasks": [ { "botId": "st-xxx-xx-xxx-xxx-xxxx", "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"] } ], "canCreateBot": true, "isDeveloper": true } ] } '

サンプル応答

    • 成功例:
      { "msg": "ユーザーが正常に更新されました" };
OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Create a Simple Bot
SKILLS
Storyboard
Dialog Tasks
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Train
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Introduction
How to Configure Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Bot Versioning
Collaborative Development
Plan Management
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Create a Simple Bot
Create a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
RELEASE NOTES

Update User API

To update user details.

This API requires JWT generated by an application created only from Bot Admin Console.
To use this API, app needs the Admin API Scope of User Management under Security & Control.

PUT https://{{host}}/api/public/users

NOTE: This feature was introduced in ver7.1 of the platform.

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai

Body Parameters

Parameter Description
users The array of details for each user that need to be updated

userInfo.emailId

or userInfo.orgUserId

(mandatory)

Email Ids or the org user id of the user being updated
userInfo.firstName
(optional)
First name of the user if needs to be updated
userInfo.lastName
(optional)
Last name of the user if needs to be updated
userInfo.companyName
(optional)
Company to which the user if needs to be updated
userInfo.dept
(optional)
Department to which the user if needs to be updated
userInfo.companyContactPhone
(optional)
Contact Phone of the Company to which the user belongs if needs to be updated
userInfo.worknumber
(optional)
Work number of the user if needs to be updated
userInfo.street
(optional)
Street Address of the user if needs to be updated
userInfo.suiteNo
(optional)
Suite No Address of the user if needs to be updated
userInfo.city
(optional)
City Address of the user if needs to be updated
userInfo.zip
(optional)
Zip Address of the user if needs to be updated
userInfo.state
(optional)
State Address of the user if needs to be updated
userInfo.country
(optional)
Country Address of the user if needs to be updated
groups
(optional)
array of group ids to which the user needs to be addTo or removeFrom
roles
(optional)
array of roleId-botId combinations to which the user needs to be addTo or removeFrom
assignBotTasks
(optional)
array of bots that have to be assigned to the user. If not present, the current assignment will be retained.

botId Id of the Bot to be assigned to the user. If not given, all the previous assigned bots will be unassigned. That is, an entry for “assignBotTasks” without “botId” entry can be used to unassign the Bot tasks to the user.
dialogs Array of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned
canCreateBot
(optional)
Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
Default value is “true”.
isDeveloper
(optional)
Determines if the specified users can have access to Bot Builder. Set to true or false.
Default value is “true”.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X PUT \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "publicuser2@gmail.com" // or "orgUserId": <orgUserId>,
                "firstName": "user1",
                "lastName":"user1",
                "companyName":"company_name",
                "dept":"dept",
                "companyContactPhone":"12334444",
                "worknumber":"321",
                "street":"street",
                "suiteNo":"suite",
                "city":"city",
                "zip":"123123",
                "state":"state",
                "country":"country"
            },
            "groups": {
                "addTo": [
                    "e-f9c09c08-9310-52ff-b672-570ec7325215"
                ]
            },
            "roles": {
                "addTo": [
                    {
                        "roleId": "5d9d8db3x0d54920a8df1e68b",
                        "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                    }
                ],
                "removeFrom": [
                    {
                        "roleId": "5d9d920dabdc1e6e8ec99342",
                        "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                    }
                ]
            },
            "assignBotTasks": [
               {
                  "botId": "st-xxx-xx-xxx-xxx-xxxx",
                  "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
                 }
      	       ],
            "canCreateBot": true,
            "isDeveloper": true
        }
	]
}
'

Sample Response

    • For success case:
      {
              "msg": "Users are updated Successfully"
          };