봇 API 가져오기 – Kore.ai Documentation

계정에서 사용할 수 있는 봇 목록을 검색합니다.

이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱은 역할 관리 아래에 있는 역할 관리의 관리자 API 범위가 필요합니다.

GET https://{{host}}/api/public/bots?offset=0&limit=50s

쿼리 매개 변수

매개 변수	필수/선택 사항	설명
host	필수	환경 URL(예: https://bots.kore.ai)
offset	선택 사항	계정에서 생성된 봇을 가져올 페이지 번호를 지정합니다. 지정되지 않은 경우, 봇 목록의 첫 페이지인 0부터 시작합니다.
limit	선택 사항	가져올 봇의 수입니다. 적용할 수 있는 최대 한도는 50입니다.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/json

샘플 요청

curl -X GET \
  'https://{{host}}/api/public/bots?offset=0&limit=50' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

샘플 응답

{
    "total": 69,
    "availableMore": true,
    "bots": [
        {
            "_id": "st-eb254250-d9ea-5dfb-a369-7e104a115e51",
            "purpose": "customer",
            "createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91",
            "defaultLanguage": "en",
            "accountId": "5c04ae921ad9976d311e9b4b",
            "type": "default",
            "resourceid": "btstreams",
            "status": "configured",
            "name": "GitHub Sample_1543832655266",
            "description": "Bot built using Github API’s to familiarize you with a few basic features of the platform. Provide the IDP  information and Trying the bot with your Git repo. Start exploring the configurations to know more about alert, action and knowledge tasks."
        },
        {
            "_id": "st-656dffde-34e7-58c6-885b-25a38112739d",
            "purpose": "employee",
            "createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91",
            "defaultLanguage": "en",
            "accountId": "5c04ae921ad9976d311e9b4b",
            "type": "default",
            "resourceid": "btstreams",
            "status": "configured",
            "name": "Travel Planning Sample_1543832655269",
            "description": "This sample bots holds the 5 task types that the platform offers. The bot is built using open APIs to get flight information,  location information and  weather details. Explore and train the bot for natural language to better respond to your intent."
        }
    ]
}

アカウントで利用可能なボットのリストを取得します。

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

GET https://{{host}}/api/public/bots?offset=0&limit=50s

クエリパラメータ

パラメータ	必須/任意	説明
ホスト	必須	環境URL（例： https://bots.kore.ai）
offset	任意	アカウントに、作成されたボットの取得を開始するページ番号を指定します。指定されていない場合は、ボットのリストの最初のページである0から開始されます。
limit	任意	取得するボット数です。最大値は50です。

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ 'https://{{host}}/api/public/bots?offset=0&limit=50' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

サンプル応答

{ "total": 69, "availableMore": true, "bots": [ { "_id": "st-eb254250-d9ea-5dfb-a369-7e104a115e51", "purpose": "customer", "createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91", "defaultLanguage": "en", "accountId": "5c04ae921ad9976d311e9b4b", "type": "default", "resourceid": "btstreams", "status": "configured", "name": "GitHub Sample_1543832655266", "description": 「プラットフォームのいくつかの基本的な機能に慣れるために、Github APIを使用して作成されたボットです。IDPの情報を提供し、Gitリポジトリを使用してボットを試行します。構成について探り、アラートタスク、アクションタスク、ナレッジタスクの詳細を知りましょう。」}, { "_id": "st-656dffde-34e7-58c6-885b-25a38112739d", "purpose": "employee", "createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91", "defaultLanguage": "en", "accountId": "5c04ae921ad9976d311e9b4b", "type": "default", "resourceid": "btstreams", "status": "configured", "name": "Travel Planning Sample_1543832655269", "description": 「このサンプルボットは、プラットフォームが提供する5つのタスクタイプを保持しています。このボットは、オープンAPIを使用して構築されており、フライト情報、位置情報、天気の詳細を取得します。あなたのインテントにより適切に応答するために、自然言語のボットを探り、トレーニングします。」} ] }

To retrieve the list of bots available in an account.

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 Role Management under Role Management.

GET https://{{host}}/api/public/bots?offset=0&limit=50s

Query Parameters

Parameter	Required/Optional	Description
host	Required	Environment URL, for example, https://bots.kore.ai
offset	Optional	Specify the page number from which to start fetching the bots created in the account. If unspecified, it starts from 0, which is the first page of the list of bots.
limit	Optional	The number of bots to fetch. The maximum applicable limit is 50.

Authorization

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

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X GET \
  'https://{{host}}/api/public/bots?offset=0&limit=50' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response

{
    "total": 69,
    "availableMore": true,
    "bots": [
        {
            "_id": "st-eb254250-d9ea-5dfb-a369-7e104a115e51",
            "purpose": "customer",
            "createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91",
            "defaultLanguage": "en",
            "accountId": "5c04ae921ad9976d311e9b4b",
            "type": "default",
            "resourceid": "btstreams",
            "status": "configured",
            "name": "GitHub Sample_1543832655266",
            "description": "Bot built using Github API’s to familiarize you with a few basic features of the platform. Provide the IDP  information and Trying the bot with your Git repo. Start exploring the configurations to know more about alert, action and knowledge tasks."
        },
        {
            "_id": "st-656dffde-34e7-58c6-885b-25a38112739d",
            "purpose": "employee",
            "createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91",
            "defaultLanguage": "en",
            "accountId": "5c04ae921ad9976d311e9b4b",
            "type": "default",
            "resourceid": "btstreams",
            "status": "configured",
            "name": "Travel Planning Sample_1543832655269",
            "description": "This sample bots holds the 5 task types that the platform offers. The bot is built using open APIs to get flight information,  location information and  weather details. Explore and train the bot for natural language to better respond to your intent."
        }
    ]
}