Knowledge_bases
Knowledge base related APIs
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
左のナレッジベースID
正しいナレッジベースID
正常に取得しました。
POST /webapi/v2/knowledge_base_diff HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"leftId": "text",
"rightId": "text"
}正常に取得しました。
{
"result": [
{
"left": {
"status": "text",
"page": 1,
"line": 1,
"text": "text",
"highlight": "text"
},
"right": {
"status": "text",
"page": 1,
"line": 1,
"text": "text",
"highlight": "text"
},
"row": 1,
"comment": "text"
}
]
}認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ダウンロードするドキュメント名
ドキュメントファイルが正常にダウンロードされました。
複数のドキュメントが見つかりました。
無許可
禁止された
ドキュメントが見つかりませんでした。
内部サーバーエラー
GET /download_document_by_name/{project_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"filename": "text"
}binaryこれは、単一のドキュメントの詳細を取得する方法です。
認証用のAPIキー
ドキュメントのID。
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ドキュメントの詳細を正常に取得しました。
GET /webapi/single_document?id=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
ドキュメントの詳細を正常に取得しました。
{
"result": {
"id": "text",
"documentName": "text",
"createdDate": "2025-12-07",
"hashtags": [
"text"
],
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
}このAPIを使用して、ドキュメントメニューにドキュメントをアップロードすることが可能です。 アップロード可能なファイル形式は、下記になります。 ファイル形式：.txt, .docx, .csv, .xls, .xlsx, .xlsm, .jpg, .jpeg, .png, .hwp, .hwpx, .pdf, .ppt, .pptx, .doc 外部リンクが含まれるHTMLファイルをアップロードするには、アップロードする前に関連するリンク先のHTMLも含め、zipファイルに圧縮の上、アップロードしてください。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ローカルファイルの場所
アップロードファイルのためのハッシュタグ
アップロードされたファイルからの検索結果のフッターとして答えの情報源を入力できます。フッターテキストは検索結果の『From』の隣に表示されます。
リンクしたいURLをfooterTitleに入れることができます。
アップロードする対象フォルダID。最上位レベルに挿入するにはヌル。
このドキュメントを他のエージェントが閲覧できるようにするかどうか
他のユーザーがこのドキュメントを閲覧することを許可するかどうか
ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。
ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。
ファイルのアップロードが成功しました。
無効なリクエストまたはファイル形式
ファイルサイズが制限を超えています。
POST /webapi/upload_file HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 248
{
"file": "binary",
"hashtags": [
"text"
],
"footerTitle": "text",
"footerUrl": "text",
"parentFolderId": "text",
"allowOtherAgentsView": true,
"allowOtherUsersView": true,
"useLayout": true,
"useImageDescription": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"result": {
"id": "text",
"file_name": "text",
"hashtags": [
"text"
],
"footer": "text"
}
}このAPIを使用すると、S3に保存されているドキュメントをAlliのドキュメントメニューに転送できます。利用可能なファイル形式は、アップロードドキュメントセクションと同じです。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ファイルのS3パス。ファイル名で終わる必要があります。バケット名を含めないでください。
あなたのS3シークレットキー。
あなたのS3アクセスキー。
ファイルを含むS3バケットの名前。
検索結果でのフッターテキストとして回答の出典を入力できます。フッターテキストは、検索結果の「出典」の横に表示されます。
リンクしたいURLをfooterTitleに入れることができます。
ドキュメントのハッシュタグ。
アップロード先のターゲットフォルダーID。最上位に挿入する場合は空にして下さい。
S3からファイルが正常にアップロードされました。
無効なリクエストパラメーター
S3でファイルが見つかりません。
POST /webapi/upload_from_s3 HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 201
{
"path": "text",
"secretKey": "text",
"accessKey": "text",
"bucket": "text",
"footerTitle": "text",
"footerUrl": "text",
"hashtags": [
"text"
],
"parentFolderId": "text",
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"result": {
"id": "text",
"file_name": "text",
"hashtags": [
"text"
],
"footer": "text"
}
}APIを介してドキュメントをアップロードすると、変換、解析され、ベクトルとして埋め込まれます。このAPIは、アップロードされるドキュメントの処理状況を表示します。
認証用のAPIキー
ステータスを確認するためのドキュメントID
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ファイルのステータスを正常に取得しました。
無効なタスクIDまたはファイルが見つかりません
GET /webapi/check_file_status?id=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"id": "text",
"status": "text",
"errorName": "text"
}
}このAPIを使用すると、ドキュメントメニューにアップロードされたドキュメントの名前を更新できます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
変更したいファイルのID。
指定したファイルの新しい名前を入力。
ファイルの名前が正常に更新されました。
無効なパラメータ
POST /webapi/update_kb_name HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"id": "text",
"filename": "text"
}{
"result": {
"id": "text",
"filename": "text"
}
}このAPIでは、ドキュメント名でドキュメントを検索することができます。
認証用のAPIキー
ドキュメントタイトルの検索用語。
ドキュメントをフィルターするためのカンマ区切りのハッシュタグのリスト。
グループをセミコロンで区切り、グループ内のタグをカンマで区切る複雑なハッシュタグフィルタリング(例:"a,b;c,d")。
ドキュメントを除外するためのカンマ区切りのハッシュタグのリスト。
セマンティックマッチングにベクトル検索を使用するには「true」、テキストベースの検索には「false」に設定します。
結果を並べ替えるプロパティフィールド。
結果をソートする方向(昇順または降順)。
ページネーションのためにスキップする結果の数。
返す結果の最大数。
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
検索に成功しました
GET /webapi/search_document_by_title?query=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
検索に成功しました
{
"result": [
{
"id": "text",
"file_name": "text",
"page_count": 1,
"download_url": "text",
"hashtags": [
"text"
],
"score": 1,
"folder": "text",
"agentEditor": [
"text"
],
"agentViewer": [
"text"
]
}
]
}このAPIを使用すると、アップロードされたドキュメントを削除できます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
配列形式で削除したいドキュメントIDを指定します。
ドキュメントが正常に削除されました。
POST /webapi/delete_file HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"ids": [
"text"
]
}ドキュメントが正常に削除されました。
{
"result": {
"ok": true
},
"errors": {}
}アップロードされているドキュメントをリスト形式で取得します
認証用のAPIキー
複数のハッシュタグを照合するために使用される論理演算子。AND または OR のいずれかを指定できます。デフォルトは OR です。
ORPossible values: リストをフィルタリングする対象ドキュメントのON/OFF状態
リストを絞り込むためのキーワード検索クエリ。演算子を使用して高度な検索を実行できます。 AND検索には「TERM1 TERM2」、OR検索には「TERM1 OR TERM2」、完全一致検索には「TERM\」を使用します。
リストをフィルタリングするためのハッシュタグ情報。
リストの並べ替え順。ファイル名にはFILE_NAME_ASC/DESC、ファイルタイプにはTYPE_ASC/DESC、オン/オフ状態にはSTATUS_ASC/DESC、アップロード日時にはCREATED_AT_ASC/DESCを使用します。
オフセットを使用すると、ページ上の最初の項目の順位番号を指定できます。
limit を使用すると、1ページに表示されるオブジェクト数を設定できます。 最大値は100です。
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ドキュメントリストの取得に成功
GET /webapi/knowledge_bases HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
ドキュメントリストの取得に成功
{
"result": {
"items": [
{
"id": "text",
"fileName": "text",
"hashtags": [
"text"
],
"autoHashtags": [
{}
],
"folder": "text",
"agentEditor": [
"text"
],
"agentViewer": [
"text"
],
"userViewer": {
"variables": {}
},
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}
]
},
"errors": {}
}アップロードされたドキュメントのプレビューを確認できます。
認証用のAPIキー
APIキーは、ダッシュボードの「設定」メニューの「一般」タブで確認できます。
プレビューを行うドキュメントID
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ドキュメントプレビューの取得に成功
GET /webapi/knowledge_base_preview?id=text&pageNo=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
ドキュメントプレビューの取得に成功
{
"result": {
"totalPageCount": 1,
"pageNo": 1,
"css": "text",
"body": "text",
"highlightIndexes": [
1
],
"exactAnswer": "text",
"pdf": "text",
"draftjs": "text",
"highlights": {
"indexes": [
1
],
"pageIndexes": [
1
],
"__typename": "text"
},
"knowledgeBase": {
"id": "text",
"title": "text",
"__typename": "text"
},
"__typename": "text"
},
"errors": {}
}このAPIでは、ドキュメントのハッシュタグ・フッタータイトル・フッターリンクを更新できます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
更新したいドキュメントのID
アップロードしたファイルから生成された検索結果に出典(ソース)として表示されるフッターテキストを設定できます。検索結果の「From」の右側に表示されます。
footerTitleにリンクさせたいURLを指定します。
ドキュメントをアップロードするときの保存先フォルダーを指定します。
フォルダの権限設定を引き継ぐかどうかを指定します。
このドキュメントに対して編集権限を持つメンバーを指定します。
このファイルに対して閲覧権限を持つメンバーを指定します。
閲覧者や編集者に指定されていないメンバーにも、このドキュメントの閲覧を許可するかどうかを指定します。
閲覧者や編集者として指定されていない一般ユーザーにも、このドキュメントの閲覧を許可するかどうかを指定します。
ドキュメントに追加したいハッシュタグ(文字列)の一覧です。
ドキュメントが正常に更新されました。
POST /webapi/update_document HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 334
{
"id": "text",
"footerTitle": "text",
"footerUrl": "text",
"folder": "text",
"followFolderPermission": true,
"agentsEditor": [
"text"
],
"agentsViewer": [
"text"
],
"userViewer": {
"customer_id": [
"text"
],
"customer_group": [
"text"
]
},
"allowOtherAgentsView": true,
"allowOtherUsersView": true,
"hashtags": [
"text"
],
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}ドキュメントが正常に更新されました。
{
"result": {
"knowledgeBase": {
"id": "text",
"hashtags": [
"text"
],
"footer": "text"
}
},
"errors": {}
}このAPIでは、ナレッジベースの複数のドキュメントの 公開・非公開(ON/OFF)ステータスをまとめて変更できます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
全ての指定ドキュメントのステータスをON(true) にするか、OFF(false) にするかを指定します。true → すべて「ON」、false → すべて「OFF」
ステータスを切り替えたいドキュメントIDのリスト。
ナレッジベースのステータスが正常に切り替えられました。
POST /webapi/toggle_documents HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"use": true,
"ids": [
"text"
]
}ナレッジベースのステータスが正常に切り替えられました。
{
"result": {
"knowledgeBases": [
{
"id": "text",
"status": true
}
]
},
"errors": {}
}Last updated
Was this helpful?