スキルセット回答の作成

Classic/VPC環境で利用できます。

特定スキルセットの APIを呼び出し、適切な回答を作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

ヘッダ

ヘッダの説明は次の通りです。

パスパラメータ

パラメータについての説明は、次の通りです。

ボディ

リクエストボディの各フィールドの説明は、次の通りです。

構文

構文例は次の通りです。

curl --location --request POST 'https://clovastudio.stream.ntruss.com/testapp/v1/skillsets/{skillset-id}/versions/{version}/final-answer' \
--header 'X-NCP-CLOVASTUDIO-API-KEY: <X-NCP-CLOVASTUDIO-API-KEY>' \
--header 'X-NCP-APIGW-API-KEY: <X-NCP-APIGW-API-KEY>' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <X-NCP-CLOVASTUDIO-REQUEST-ID>' \
--header 'Content-Type: application/json'
--data '{  
    "query": "明日ソウルの天気はどう?",
    "tokenStream": true
    "chatHistory": [
                                {
                                    "role": "user",
                                    "content" : "今日の天気はどう?"
                                 },
                                {
                                    "role": "assistant",
                                    "content" : "嵐の前夜です。"
                                 }
                             ]
    }'

レスポンス

レスポンス形式を説明します。

ヘッダ

ヘッダの説明は次の通りです。

ボディ

ボディの各フィールドの説明は次の通りです。

構文

構文例は次の通りです。

{
  "status": {
    "code": "20000",
    "message": "OK"
  },
  "result": {
    "finalAnswer": "明日のソウルの天気は晴れで、温度は約27度と予想されます。",
    "tokenCount": 1032,
    "apiResult": [
      {
        "url": "http://api.kcisa.kr/openapi/service/rest/convergence/conver8?serviceKey=247c5de7-556d-41bf-af3e-875e039e4f5c&numOfRows=1&keyword=판교",
        "requestBody": "string",
        "responseBody": "string",
        "apiOrder": 1,
        "operationId": "searchHotel",
        "nameForHuman": "V1ReviewSearch"
      }
    ]
  }
}

レスポンスストリーム

各イベントを1つずつ出力するようレスポンスストリーミングを使用できます。レスポンスストリーミング形式について説明します。

ヘッダ

ヘッダの説明は次の通りです。

ボディ

ボディの各フィールドの説明は次の通りです。

Token Event

トークンストリーミングを使用する場合、Token Dataの説明は次の通りです。

構文

構文例は次の通りです。

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "finalAnswer": "ソウルにあるホテルをお勧めいたします。\n\n1. Luxury Hotel(4.0) - ソウル中浪区ジェイル洞13-1\n2. Grand Resort(5.0) - ソウル中区文安洞12-1\n3. Movenpick Hotel(4.0) - ソウル広津区ウォーカーヒル路120",
        "apiResult": [
            {
                "url": "https://free-api-0601.herokuapp.com/search_reviews_get?address=서울",
                "requestBody": "address=서울",
                "responseBody": "{\"hotels\": [{\"review_id\": 1, \"review_date\": \"20230811\", \"reviewer\": \"JohnDoe\", \"rating\": 4.0, \"content\": \"ホテルはいいけど、変な臭いがします。\", \"hotel_name\": \"Luxury Hotel\", \"address\": \"ソウル中浪区ジェイル洞13-1\", \"room_name\": \"Deluxe Suite\", \"good_cnt\": 10, \"bad_cnt\": 2, \"rating_service\": 5.0, \"rating_clean\": 4.0, \"rating_room\": 4.0}, {\"review_id\": 2, \"review_date\": \"20230810\", \"reviewer\": \"JaneSmith\", \"rating\": 5.0, \"content\": \"部屋の中にコーヒーポットもなく、周りにコーヒーを売っているところもありません。それ以外は満足です。\", \"hotel_name\": \"Grand Resort\", \"address\": \"ソウル中区文安洞12-1\", \"room_name\": \"Ocean View Room\", \"good_cnt\": 15, \"bad_cnt\": 0, \"rating_service\": 5.0, \"rating_clean\": 5.0, \"rating_room\": 5.0}, {\"review_id\": 5, \"review_date\": \"20230809\", \"reviewer\": \"ClaudeCalder\", \"rating\": 4.0, \"content\": \"サウナ、プールなどの施設がなくて残念だったけど、値段が安かったので良かったです。近くに地下鉄やコンビニもあってアクセスが良いです。しばらく滞在するのにぴったりです。\", \"hotel_name\": \"Movenpick Hotel\", \"address\": \"ソウル広津区ウォーカーヒル路120\", \"room_name\": \"City View\", \"good_cnt\": 9, \"bad_cnt\": 0, \"rating_service\": 3.0, \"rating_clean\": 4.0, \"rating_room\": 4.0}], \"test\": \"test\"}",
                "operationId": "searchHotel",
                "nameForHuman": "V1ReviewSearch",
                "apiOrder": 1
            }
        ],
        "useTask": false,
        "tokenCount": 3524
    }
}