抽出に関する質問を取得 – KG

ナレッジグラフの抽出に関する質問のリストを取得します。

このAPIを使用するために、アプリは [KnowlegdeGraph] の管理APIスコープを必要とします。

GET https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=&offset=

パスパラメータ

パラメータ	必須/任意	説明
ホスト	必須	環境URL（例： https://bots.kore.ai）
streamId	必須	ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。
ExtractionId	必須	質問を取得する必要がある場所からのExtractionIdです。

クエリパラメータ

パラメータ	必須/任意	説明
limit	任意	指定されていない場合、取得されるレコード数は50に設定されます。
offset	任意	指定されていない場合、スキップされるレコード数は0に設定されます。

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=20&offset=0 \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json'

サンプル応答

{ "extractions": [ { "_id": "qna-647d1b55-af75-5e51-b286-ea3f70041d2a", "status": true, "question": "Am I going to be charged for this security feature?", "answer": "As of now, this service is free of charge and is a security measure for your online account safety.", "language": "en", "kEId": "ke-xxxxx-xxx-xxx-xxx-xxxxx", "createdBy": "u-xxxxx-xxx-xxxx-xxx-xxxxx", "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "createdOn": "2020-01-03T06:59:19.472Z", "modifiedOn": "2020-01-03T06:59:19.472Z", "__v": 0 } ] }

On this Page

Get Extraction Questions – KG

To get a Get KG Extraction Questions.

To use this API, app needs the Admin API Scope of KnowlegdeGraph.

GET https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=&offset=

Path Parameters

Parameter	Required/Optional	Description
host	Required	Environment URL, for example, https://bots.kore.ai
streamId	Required	Bot ID or Stream ID. You can access it from the General Settings page of the bot.
ExtractionId	Required	ExtractionId from where the questions need to be fetched.

Query Parameters

Parameter	Required/Optional	Description
limit	Optional	Number of records to be fetched, if not given set to 50.
offset	Optional	Number of records to be skipped, if not given set to 0.

Authorization

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

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X POST \
  https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=20&offset=0 \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json'

Sample Response

{
    "extractions": [
        {
            "_id": "qna-647d1b55-af75-5e51-b286-ea3f70041d2a",
            "status": true,
            "question": "Am I going to be charged for this security feature?",
            "answer": "As of now, this service is free of charge and is a security measure for your online account safety.",
            "language": "en",
            "kEId": "ke-xxxxx-xxx-xxx-xxx-xxxxx",
            "createdBy": "u-xxxxx-xxx-xxxx-xxx-xxxxx",
            "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
            "createdOn": "2020-01-03T06:59:19.472Z",
            "modifiedOn": "2020-01-03T06:59:19.472Z",
            "__v": 0
        }
]
}

On this Page