Conversations

Conversation related APIs

利用履歴の会話を取得

get

会話リストを取得します。会話はデフォルトで最後のチャット時間を基準に降順で並べ替えられています。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

userIdsany ofOptional

or

nullOptional

llmAppIdany ofOptional

stringOptional

or

nullOptional

categoryIdany ofOptional

stringOptional

or

nullOptional

startedAtany ofOptional

指定された値以降の最後のチャット時間を検索

numberOptional

or

nullOptional

endAtany ofOptional

指定された値以前の最後のチャット時間を検索

numberOptional

or

nullOptional

firstChatStartedAtany ofOptional

指定された値以降の最初のチャット時間を検索

numberOptional

or

nullOptional

firstChatEndAtany ofOptional

指定された値以前の最初のチャット時間を検索

numberOptional

or

nullOptional

searchTermany ofOptional

stringOptional

or

nullOptional

cursorany ofOptional

stringOptional

or

nullOptional

variablesany ofOptional

string[]Optional

or

nullOptional

pageSizeinteger · min: 1 · max: 50OptionalDefault: 50

activeOnlybooleanOptionalDefault: false

backgroundRunningany ofOptional

booleanOptional

or

nullOptional

orderall ofOptionalDefault: LAST_CHAT_TIME_DESC

string · enumOptionalPossible values:

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

成功

application/json

get

/webapi/v2/conversations

HTTPcURLJavaScriptPython

GET /webapi/v2/conversations HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

成功

{
  "conversations": [
    {
      "id": "text",
      "title": "text",
      "user": {
        "userId": "text",
        "firstName": "text",
        "lastName": "text"
      },
      "createdAt": 1,
      "lastChatTime": 1,
      "isEnd": true,
      "categories": [
        "text"
      ],
      "memo": "text",
      "chats": [
        {
          "id": "text",
          "sender": "USER",
          "message": "text",
          "source": {
            "knowledgeBaseIds": [
              "text"
            ],
            "folderIds": [
              "text"
            ],
            "webSites": [
              "text"
            ],
            "searchAllSharedDocument": false,
            "searchAllPersonalDocument": false,
            "includingHashtags": [
              "text"
            ],
            "excludingHashtags": [
              "text"
            ],
            "includingHashtagsOperator": "text",
            "excludingHashtagsOperator": "text",
            "sharedKnowledgeBases": [
              {
                "id": "text",
                "name": "text"
              }
            ],
            "sharedFolders": [
              {
                "id": "text",
                "name": "text"
              }
            ],
            "personalKnowledgeBases": [
              {
                "id": "text",
                "name": "text"
              }
            ],
            "personalFolders": [
              {
                "id": "text",
                "name": "text"
              }
            ]
          },
          "timestamp": 1,
          "citations": [
            {
              "clueId": "text",
              "source": "text",
              "title": "text",
              "knowledgeBaseId": "text",
              "pageNo": 1,
              "url": "text",
              "text": "text"
            }
          ],
          "rating": true,
          "agentRating": true
        }
      ],
      "chatCount": 1,
      "llmApp": {
        "id": "text",
        "name": "text",
        "description": "text"
      },
      "variables": {}
    }
  ],
  "cursor": "text"
}

会話を更新する

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

userIdsany ofOptional

フィルタリング対象のユーザーID

string[]Optional

or

nullOptional

llmAppIdsany ofOptional

フィルタリング対象のllmアプリID

string[]Optional

or

nullOptional

categoryIdsany ofOptional

フィルタリング対象のの会話カテゴリID

string[]Optional

or

nullOptional

conversationIdsany ofOptional

フィルタリング対象の会話ID

string[]Optional

or

nullOptional

Responses

200

正常に更新されました。

No content

post

/webapi/v2/conversations/bulk_update

HTTPcURLJavaScriptPython

POST /webapi/v2/conversations/bulk_update HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "userIds": [
    "text"
  ],
  "llmAppIds": [
    "text"
  ],
  "categoryIds": [
    "text"
  ],
  "conversationIds": [
    "text"
  ],
  "conversationInfo": {
    "state": "no",
    "assignee": "text",
    "categoryIds": [
      "text"
    ],
    "title": "text"
  }
}

200

正常に更新されました。

No content

会話IDから会話内容を取得

get

指定の会話IDに紐づく会話内容を取得します。 取得できるメッセージは、最新の20件までです。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

conversation_idstringRequired

Query parameters

variablesany ofOptional

Comma separated list of variables to include in the response

string[]Optional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

正常に取得しました。

application/json

get

/webapi/v2/conversations/{conversation_id}

HTTPcURLJavaScriptPython

GET /webapi/v2/conversations/{conversation_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に取得しました。

{
  "id": "text",
  "title": "text",
  "user": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  },
  "createdAt": 1,
  "lastChatTime": 1,
  "isEnd": true,
  "categories": [
    "text"
  ],
  "memo": "text",
  "chats": [
    {
      "id": "text",
      "sender": "USER",
      "message": "text",
      "source": {
        "knowledgeBaseIds": [
          "text"
        ],
        "folderIds": [
          "text"
        ],
        "webSites": [
          "text"
        ],
        "searchAllSharedDocument": false,
        "searchAllPersonalDocument": false,
        "includingHashtags": [
          "text"
        ],
        "excludingHashtags": [
          "text"
        ],
        "includingHashtagsOperator": "text",
        "excludingHashtagsOperator": "text",
        "sharedKnowledgeBases": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "sharedFolders": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "personalKnowledgeBases": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "personalFolders": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "timestamp": 1,
      "citations": [
        {
          "clueId": "text",
          "source": "text",
          "title": "text",
          "knowledgeBaseId": "text",
          "pageNo": 1,
          "url": "text",
          "text": "text"
        }
      ],
      "rating": true,
      "agentRating": true
    }
  ],
  "chatCount": 1,
  "llmApp": {
    "id": "text",
    "name": "text",
    "description": "text"
  },
  "variables": {}
}

会話を設定

patch

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

conversation_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

stateany ofOptional

会話の状態

string · enumOptionalPossible values:

or

nullOptional

assigneeany ofOptional

会話の担当者

stringOptional

or

nullOptional

categoryIdsany ofOptional

カテゴリのID

string[]Optional

or

nullOptional

titleany ofOptional

会話のタイトル

stringOptional

or

nullOptional

Responses

200

正常に設定されました。

application/json

patch

/webapi/v2/conversations/{conversation_id}

HTTPcURLJavaScriptPython

PATCH /webapi/v2/conversations/{conversation_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "state": "no",
  "assignee": "text",
  "categoryIds": [
    "text"
  ],
  "title": "text"
}

200

正常に設定されました。

{
  "id": "text",
  "title": "text",
  "user": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  },
  "createdAt": 1,
  "lastChatTime": 1,
  "isEnd": true,
  "categories": [
    "text"
  ],
  "memo": "text",
  "chats": [
    {
      "id": "text",
      "sender": "USER",
      "message": "text",
      "source": {
        "knowledgeBaseIds": [
          "text"
        ],
        "folderIds": [
          "text"
        ],
        "webSites": [
          "text"
        ],
        "searchAllSharedDocument": false,
        "searchAllPersonalDocument": false,
        "includingHashtags": [
          "text"
        ],
        "excludingHashtags": [
          "text"
        ],
        "includingHashtagsOperator": "text",
        "excludingHashtagsOperator": "text",
        "sharedKnowledgeBases": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "sharedFolders": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "personalKnowledgeBases": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "personalFolders": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "timestamp": 1,
      "citations": [
        {
          "clueId": "text",
          "source": "text",
          "title": "text",
          "knowledgeBaseId": "text",
          "pageNo": 1,
          "url": "text",
          "text": "text"
        }
      ],
      "rating": true,
      "agentRating": true
    }
  ],
  "chatCount": 1,
  "llmApp": {
    "id": "text",
    "name": "text",
    "description": "text"
  },
  "variables": {}
}

会話内のチャットの一覧を取得する

get

会話内のチャットの一覧を取得します。チャットはタイムスタンプによって昇順に並べ替えられています。

チャットページのサイズは100です。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

conversation_idstringRequired

Query parameters

pageNointeger · min: 1OptionalDefault: 1

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

成功

application/json

get

/webapi/v2/conversations/{conversation_id}/chats

HTTPcURLJavaScriptPython

GET /webapi/v2/conversations/{conversation_id}/chats HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

成功

{
  "chats": [
    {
      "id": "text",
      "sender": "USER",
      "message": "text",
      "source": {
        "knowledgeBaseIds": [
          "text"
        ],
        "folderIds": [
          "text"
        ],
        "webSites": [
          "text"
        ],
        "searchAllSharedDocument": false,
        "searchAllPersonalDocument": false,
        "includingHashtags": [
          "text"
        ],
        "excludingHashtags": [
          "text"
        ],
        "includingHashtagsOperator": "text",
        "excludingHashtagsOperator": "text",
        "sharedKnowledgeBases": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "sharedFolders": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "personalKnowledgeBases": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "personalFolders": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "timestamp": 1,
      "citations": [
        {
          "clueId": "text",
          "source": "text",
          "title": "text",
          "knowledgeBaseId": "text",
          "pageNo": 1,
          "url": "text",
          "text": "text"
        }
      ],
      "rating": true,
      "agentRating": true
    }
  ],
  "pageNo": 1,
  "totalCount": 1
}

会話IDで会話の状態を取得

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

conversation_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

正常に取得しました。

application/json

get

/webapi/v2/conversations/{conversation_id}/running

HTTPcURLJavaScriptPython

GET /webapi/v2/conversations/{conversation_id}/running HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に取得しました。

{
  "isRunning": true
}

会話を終了する

post

進行中の会話を終了する。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

conversation_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

正常に完了しました。

No content

post

/webapi/v2/conversations/{conversation_id}/stop

HTTPcURLJavaScriptPython

POST /webapi/v2/conversations/{conversation_id}/stop HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に完了しました。

No content

IDで会話チャットを削除

delete

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

conversation_idstringRequired

chat_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

成功

No content

delete

/webapi/v2/conversations/{conversation_id}/chats/{chat_id}

HTTPcURLJavaScriptPython

DELETE /webapi/v2/conversations/{conversation_id}/chats/{chat_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

成功

No content

会話のタイトルを更新

put

会話のタイトルを設定します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

conversation_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

titlestringRequired

会話のタイトル。

Responses

200

成功

application/json

put

/webapi/v2/conversations/{conversation_id}/title

HTTPcURLJavaScriptPython

PUT /webapi/v2/conversations/{conversation_id}/title HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

200

成功

{
  "id": "text",
  "title": "text",
  "user": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  },
  "createdAt": 1,
  "lastChatTime": 1,
  "isEnd": true,
  "categories": [
    "text"
  ],
  "memo": "text",
  "chats": [
    {
      "id": "text",
      "sender": "USER",
      "message": "text",
      "source": {
        "knowledgeBaseIds": [
          "text"
        ],
        "folderIds": [
          "text"
        ],
        "webSites": [
          "text"
        ],
        "searchAllSharedDocument": false,
        "searchAllPersonalDocument": false,
        "includingHashtags": [
          "text"
        ],
        "excludingHashtags": [
          "text"
        ],
        "includingHashtagsOperator": "text",
        "excludingHashtagsOperator": "text",
        "sharedKnowledgeBases": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "sharedFolders": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "personalKnowledgeBases": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "personalFolders": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "timestamp": 1,
      "citations": [
        {
          "clueId": "text",
          "source": "text",
          "title": "text",
          "knowledgeBaseId": "text",
          "pageNo": 1,
          "url": "text",
          "text": "text"
        }
      ],
      "rating": true,
      "agentRating": true
    }
  ],
  "chatCount": 1,
  "llmApp": {
    "id": "text",
    "name": "text",
    "description": "text"
  },
  "variables": {}
}

フィードバックを投稿する

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

conversation_idstringRequired

chat_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

ratingany ofOptional

チャットの評価

booleanOptional

or

nullOptional

feedbackSelectionany ofOptional

フィードバック選択

or

nullOptional

suggestedAnswerany ofOptional

提案された回答

stringOptional

or

nullOptional

Responses

200

成功

application/json

post

/webapi/v2/conversations/{conversation_id}/chats/{chat_id}/feedback

HTTPcURLJavaScriptPython

POST /webapi/v2/conversations/{conversation_id}/chats/{chat_id}/feedback HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "rating": true,
  "feedbackSelection": [
    "not_relevant"
  ],
  "suggestedAnswer": "text"
}

200

成功

{
  "conversationId": "text",
  "chatId": "text",
  "rating": true
}

毎日の会話数

get

指定した範囲の1日あたりの会話の総数を取得します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

startDatestringOptional

開始日をYYYY-MM-DD形式で範囲指定

endDatestringOptional

End of range of dates to query in YYYY-MM-DD format.

Responses

200

成功

application/json

get

/webapi/conversation_daily_count

HTTPcURLJavaScriptPython

GET /webapi/conversation_daily_count HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "startDate": "text",
  "endDate": "text"
}

200

成功

{
  "result": {
    "dailyTotalCount": [
      {
        "date": "text",
        "activeCount": 1
      }
    ],
    "state": "text",
    "campaignCount": 1
  },
  "errors": {}
}