コメント

コメントを追加または更新する

/api/v1/sources/<project>/<source_name>/sync

必要な権限:「 メッセージの編集」

重要:

請求対象の操作

作成されたコメント 1 件につき、または (一意の ID に基づいて) 更新されたコメント 1 件につき、1 AI ユニットが請求されます。

• bash

  curl -X POST 'https://<my_api_endpoint>/api/v1/sources/<project>/<source>/sync' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "comments": [
      {
        "id": "0123456789abcdef",
        "messages": [
          {
            "body": {
              "text": "Alice,\n\nHere are the figures for today.\n\nRegards,\nBob"
            },
            "from": "[e-mail]",
            "sent_at": "2011-12-11T11:05:10.000000+00:00",
            "subject": {
              "text": "Today'"'"'s figures"
            },
            "to": [
              "[e-mail]"
            ]
          }
        ],
        "timestamp": "2011-12-11T11:05:10.000000+00:00",
        "user_properties": {
          "string:Recipient Domain": "company.com",
          "string:Sender Domain": "organisation.org"
        }
      },
      {
        "id": "abcdef0123456789",
        "messages": [
          {
            "body": {
              "text": "Hi Bob,\n\nI think these are the wrong numbers - could you check?\n\nThanks again,\nAlice"
            },
            "from": "[e-mail]",
            "sent_at": "2011-12-11T11:18:43.000000+00:00",
            "subject": {
              "text": "Today'"'"'s figures"
            },
            "to": [
              "[e-mail]"
            ]
          }
        ],
        "timestamp": "2011-12-11T11:18:43.000000+00:00",
        "user_properties": {
          "string:Recipient Domain": "organisation.org",
          "string:Sender Domain": "company.com"
        }
      }
    ]
  }'

• ノード

  const request = require("request");
  
  request.post(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>/<source>/sync",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        comments: [
          {
            id: "0123456789abcdef",
            messages: [
              {
                body: {
                  text: "Alice,\n\nHere are the figures for today.\n\nRegards,\nBob",
                },
                from: "[e-mail]",
                sent_at: "2011-12-11T11:05:10.000000+00:00",
                subject: { text: "Today's figures" },
                to: ["[e-mail]"],
              },
            ],
            timestamp: "2011-12-11T11:05:10.000000+00:00",
            user_properties: {
              "string:Recipient Domain": "company.com",
              "string:Sender Domain": "organisation.org",
            },
          },
          {
            id: "abcdef0123456789",
            messages: [
              {
                body: {
                  text: "Hi Bob,\n\nI think these are the wrong numbers - could you check?\n\nThanks again,\nAlice",
                },
                from: "[e-mail]",
                sent_at: "2011-12-11T11:18:43.000000+00:00",
                subject: { text: "Today's figures" },
                to: ["[e-mail]"],
              },
            ],
            timestamp: "2011-12-11T11:18:43.000000+00:00",
            user_properties: {
              "string:Recipient Domain": "organisation.org",
              "string:Sender Domain": "company.com",
            },
          },
        ],
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.post(
      "https://<my_api_endpoint>/api/v1/sources/<project>/<source>/sync",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "comments": [
              {
                  "id": "0123456789abcdef",
                  "timestamp": "2011-12-11T11:05:10.000000+00:00",
                  "messages": [
                      {
                          "from": "[e-mail]",
                          "to": ["[e-mail]"],
                          "sent_at": "2011-12-11T11:05:10.000000+00:00",
                          "subject": {"text": "Today's figures"},
                          "body": {
                              "text": "Alice,\n\nHere are the figures for today.\n\nRegards,\nBob"
                          },
                      }
                  ],
                  "user_properties": {
                      "string:Sender Domain": "organisation.org",
                      "string:Recipient Domain": "company.com",
                  },
              },
              {
                  "id": "abcdef0123456789",
                  "timestamp": "2011-12-11T11:18:43.000000+00:00",
                  "messages": [
                      {
                          "from": "[e-mail]",
                          "to": ["[e-mail]"],
                          "sent_at": "2011-12-11T11:18:43.000000+00:00",
                          "subject": {"text": "Today's figures"},
                          "body": {
                              "text": "Hi Bob,\n\nI think these are the wrong numbers - could you check?\n\nThanks again,\nAlice"
                          },
                      }
                  ],
                  "user_properties": {
                      "string:Sender Domain": "company.com",
                      "string:Recipient Domain": "organisation.org",
                  },
              },
          ]
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• レスポンス

  {
    "new": 2,
    "status": "ok",
    "unchanged": 0,
    "updated": 0
  }

コメントの ID により、ソース内でコメントを一意に識別します。指定したコメント ID がソースに存在しない場合は、新しいコメントが作成されます。 存在する場合は、既存のコメントが更新されます。

名前	型	必須	説明
comments	array<Cmment>	○	コメントの参照セクションに記載されている形式の、最大 16384 件のコメントのバッチです。大きなバッチは小さなバッチよりも (コメント単位で) 高速です。

割り当てられた一般フィールド

割り当てられた一般フィールドは、テキストが大幅に変更されない限り保持されます。 割り当てられたラベルが破棄されることはありません。

大きな要求

要求が大きい場合、このエンドポイントは応答に時間がかかる場合があります。クライアントのタイムアウト値を増やす必要があります。

未加工のメールからコメントを追加または更新する

/api/v1/sources/<project>/<source_name>/sync-raw-emails

必要な権限:「メッセージの編集」

重要:

請求対象の操作

作成されたコメント 1 件につき、またはテキストが変更された場合は更新されたコメント 1 件 (メールのメッセージ ID に基づく) につき、1 AI ユニットが消費されます。

• bash

  curl -X POST 'https://<my_api_endpoint>/api/v1/sources/<project>/<source>/sync-raw-emails' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "documents": [
      {
        "raw_email": {
          "body": {
            "plain": "Hi Bob,\n\nCould you send me today'"'"'s figures?\n\nThanks,\nAlice"
          },
          "headers": {
            "parsed": {
              "Date": "Thu, 09 Jan 2020 16:34:45 +0000",
              "From": "[e-mail]",
              "Message-ID": "[e-mail]",
              "References": "<[e-mail]> <[e-mail]>",
              "Subject": "Figures Request",
              "To": "[e-mail]"
            }
          }
        },
        "user_properties": {
          "number:Deal Value": 12000,
          "string:City": "London"
        }
      }
    ],
    "include_comments": true,
    "transform_tag": "name.0.ABCD1234"
  }'

• ノード

  const request = require("request");
  
  request.post(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>/<source>/sync-raw-emails",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        documents: [
          {
            raw_email: {
              body: {
                plain:
                  "Hi Bob,\n\nCould you send me today's figures?\n\nThanks,\nAlice",
              },
              headers: {
                parsed: {
                  Date: "Thu, 09 Jan 2020 16:34:45 +0000",
                  From: "[e-mail]",
                  "Message-ID": "[e-mail]",
                  References: "<[e-mail]> <[e-mail]>",
                  Subject: "Figures Request",
                  To: "[e-mail]",
                },
              },
            },
            user_properties: {
              "number:Deal Value": 12000,
              "string:City": "London",
            },
          },
        ],
        include_messages: true,
        transform_tag: "name.0.ABCD1234",
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.post(
      "https://<my_api_endpoint>/api/v1/sources/<project>/<source>/sync-raw-emails",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "transform_tag": "name.0.ABCD1234",
          "documents": [
              {
                  "raw_email": {
                      "headers": {
                          "parsed": {
                              "Message-ID": "[e-mail]",
                              "Date": "Thu, 09 Jan 2020 16:34:45 +0000",
                              "Subject": "Figures Request",
                              "From": "[e-mail]",
                              "To": "[e-mail]",
                              "References": "<[e-mail]> <[e-mail]>",
                          }
                      },
                      "body": {
                          "plain": "Hi Bob,\n\nCould you send me today's figures?\n\nThanks,\nAlice"
                      },
                  },
                  "user_properties": {
                      "string:City": "London",
                      "number:Deal Value": 12000,
                  },
              }
          ],
          "include_comments": True,
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• レスポンス

  {
    "comments": [
      {
        "attachments": [],
        "id": "61626364656640636f6d70616e792e636f6d",
        "messages": [
          {
            "body": {
              "text": "Hi Bob,\n\nCould you send me today's figures?"
            },
            "from": "[e-mail]",
            "sent_at": "2020-01-09T16:34:45Z",
            "signature": {
              "text": "Thanks,\nAlice"
            },
            "subject": {
              "text": "Figures Request"
            },
            "to": ["[e-mail]"]
          }
        ],
        "source_id": "c1fb849b855841de",
        "text_format": "plain",
        "thread_id": "3c303132333440636f6d70616e792e636f6d3e",
        "timestamp": "2020-01-09T16:34:45Z",
        "uid": "c1fb849b855841de.61626364656640636f6d70616e792e636f6d",
        "user_properties": {
          "number:Deal Value": 12000,
          "number:Participant Count": 2,
          "number:Position in Thread": 3,
          "number:Recipient Count": 1,
          "string:City": "London",
          "string:Has Signature": "Yes",
          "string:Message ID": "[e-mail]",
          "string:Sender": "[e-mail]",
          "string:Sender Domain": "company.com",
          "string:Thread": "<[e-mail]>"
        }
      }
    ],
    "new": 1,
    "status": "ok",
    "unchanged": 0,
    "updated": 0
  }

各未加工のメールは、Communications Mining のコメントに変換されます。Communications Mining は、メールの「Message-ID」ヘッダーに基づいてコメントの ID を生成します。このコメント ID を持つコメントがソースに存在しない場合は、新しいコメントが作成されます。存在する場合は、既存のコメントが更新されます。

未加工のメールがコメントに変換されるとき、メール本文はクリーニングされ、メール ヘッダーからメタデータが生成されます。include_comments を true に設定すると、生成されたコメントを応答に含めることができます。コメントは、「コメント」に記載されている形式で返されます。

名前	型	必須	説明
transform_tag	string	○	データを送信するメール連携を識別するタグ。このタグは、連携の設定をセットアップするときに受け取っているはずです。
documents	array<Document>	○	以下に記載されている形式の、最大 16384 個のドキュメントのバッチです。 大きなバッチは小さなバッチよりも (ドキュメント単位で) 高速です。
include_comments	Boolean	×	true に設定すると、メールから解析されたコメントが応答の本文で返されます。
override_user_properties	array<string>	×	ユーザー名がこのリストに含まれる場合、documents に指定されているユーザー プロパティが、自動生成されたユーザー プロパティより優先されます。このリストのユーザー プロパティ名は、型を示すプレフィックスを付けずに指定する必要があります。たとえば、string:My Property ではなく、My Property とします。

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

名前	型	必須	説明
raw_email	RawEmail	○	コメント参照に記載されている形式の電子メールデータ。
comment_id	string	×	コメントを一意に識別します。コメント ID が指定されていない場合は、メールのメッセージ ID からコメント ID が生成されます。形式については、コメントの参照セクションをご覧ください。
user_properties	map<string, string | number>	×	コメントに適用されるユーザー定義のメタデータです。形式については、「コメントの参照」をご覧ください。 手記： 一部のユーザー プロパティは、電子メールの内容に基づいて生成されます。 これらがアップロードされたユーザー プロパティと競合する場合、要求は 422 Unprocessable Entityで失敗します。

警告:

割り当てられた一般フィールド

Communications Mining は、指定された変換タグを考慮して、生のメール本文と生のメール ヘッダーのサブセットからコメントの "メッセージ" の内容を生成します。 割り当てられた一般フィールドは、テキストが大幅に変更されない限り保持されます。 割り当てられたラベルが破棄されることはありません。

重要:

大きな要求

要求が大きい場合、このエンドポイントは応答に時間がかかる場合があります。クライアントのタイムアウト値を増やす必要があります。

コメントを削除する

/api/v1/sources/<project>/<source_name>/comments?id=<comment_id0>[&id=<comment_id1>...]

必要な権限:「メッセージの編集」

• bash

  curl -X DELETE 'https://<my_api_endpoint>/api/v1/sources/<project>/<source_name>/comments?id=abcdef0123456789' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• ノード

  const request = require("request");
  
  request.delete(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>/<source_name>/comments?id=abcdef0123456789",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.delete(
      "https://<my_api_endpoint>/api/v1/sources/<project>/<source_name>/comments?id=abcdef0123456789",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• レスポンス

  {
    "status": "ok"
  }

個々のコメントは、コメント の追加時に指定された ID を使用して、ソースから削除できます。

このコメントに関連付けられているすべてのデータ は完全に削除されます。

ID でコメントを取得する

/api/v1/sources/<project>/<source_name>/comments/<comment_id>

必要な権限: ソースを表示

• bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/sources/<project>/<source>/comments/0123456789abcdef' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• ノード

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>/<source>/comments/0123456789abcdef",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.get(
      "https://<my_api_endpoint>/api/v1/sources/<project>/<source>/comments/0123456789abcdef",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• レスポンス

  {
    "comment": {
      "context": "1596721237668",
      "created_at": "2020-08-06T13:20:28.531000Z",
      "id": "0123456789abcdef",
      "last_modified": "2020-08-06T13:40:37.668000Z",
      "messages": [
        {
          "body": {
            "text": "Alice,\n\nHere are the figures for today.\n\nRegards,\nBob"
          },
          "from": "[e-mail]",
          "sent_at": "2011-12-11T11:05:10Z",
          "subject": {
            "text": "Today's figures"
          },
          "to": ["[e-mail]"]
        }
      ],
      "source_id": "47194279497e141e",
      "text_format": "plain",
      "timestamp": "2011-12-11T11:05:10Z",
      "uid": "47194279497e141e.0123456789abcdef",
      "user_properties": {
        "string:Recipient Domain": "company.com",
        "string:Sender Domain": "organisation.org"
      }
    },
    "status": "ok"
  }

コメントは、「コメント」に記載されている形式で返されます。

スレッド ID でコメントを取得する

/api/v1/sources/<project>/<source_name>/threads?id=<thread_id0>[&id=<thread_id1>...]

必要な権限: ソースを表示

• bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/sources/<project>/<source>/threads?id=185521538102&id=81745162' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• ノード

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>/<source>/threads?id=185521538102&id=81745162",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.get(
      "https://<my_api_endpoint>/api/v1/sources/<project>/<source>/threads?id=185521538102&id=81745162",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• レスポンス

  {
    "status": "ok",
    "threads": [
      {
        "messages": ["4321dcba.1234", "4321dcba.2345", "4321dcba.3456"],
        "thread_id": "185521538102"
      },
      {
        "messages": [],
        "thread_id": "81745162"
      }
    ]
  }

指定されたスレッド ID ごとに、応答には、そのスレッドに属するコメント UID のリスト ( source_id.comment_idの形式) が含まれます。 存在しないスレッド ID を指定してもエラーは発生しないことに注意してください。代わりに、応答内の対応するコメントのリストは空になります。