例外にタグを付ける

/api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions

必要な権限: ストリームの利用、ソースの表示

• bash

  curl -X PUT 'https://<my_api_endpoint>/api/v1/datasets/project1/collateral/streams/dispute/exceptions' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "exceptions": [
      {
        "metadata": {
          "type": "No Prediction"
        },
        "uid": "18ba5ce699f8da1f.abcdef0123456789"
      },
      {
        "metadata": {
          "type": "Wrong Prediction"
        },
        "uid": "18ba5ce699f8da1f.0123456789abcdef"
      }
    ]
  }'

• ノード

  const request = require("request");
  
  request.put(
    {
      url: "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/streams/dispute/exceptions",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        exceptions: [
          {
            metadata: { type: "No Prediction" },
            uid: "18ba5ce699f8da1f.abcdef0123456789",
          },
          {
            metadata: { type: "Wrong Prediction" },
            uid: "18ba5ce699f8da1f.0123456789abcdef",
          },
        ],
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.put(
      "https://<my_api_endpoint>/api/v1/datasets/project1/collateral/streams/dispute/exceptions",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "exceptions": [
              {
                  "uid": "18ba5ce699f8da1f.abcdef0123456789",
                  "metadata": {"type": "No Prediction"},
              },
              {
                  "uid": "18ba5ce699f8da1f.0123456789abcdef",
                  "metadata": {"type": "Wrong Prediction"},
              },
          ]
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• レスポンス

  {
    "status": "ok"
  }

このエンドポイントを使用すると、プラットフォーム内のコメント を例外 としてタグ付けできるため、モデルのトレーナーがコメントを確認してラベル付けし、モデルを改善できます。モデルが予測を返さなかったコメントと、モデルが誤った予測を返したコメントにはタグを付けることをお勧めします。

名前	型	必須	説明
exceptions	array<Exception>	○	例外の一覧。

ここで Exception の形式は次のとおりです。

名前	型	必須	説明
uid	string	○	例外としてタグ付けする必要があるコメントの uid 。
metadata	メタデータ	○	例外メタデータを含むオブジェクト。

ここで Metadata の形式は次のとおりです。

名前	型	必須	説明
type	string	○	例外の種類は、Communications Mining™ の UI でフィルター プロパティとして使用できます。値には任意の文字列を指定できます。「予測なし」「間違った予測」など、短くてわかりやすい文字列を選択してください。