# Knowledge\_bases
Knowledge base related APIs
## POST /webapi/v2/knowledge\_base\_diff
> ナレッジベースの差分を取得する
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseDiffResponse":{"properties":{"result":{"items":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDiffer"},"title":"Result","type":"array"}},"required":["result"],"title":"KnowledgeBaseDiffResponse","type":"object"},"KnowledgeBaseDiffResponseLineDiffer":{"properties":{"left":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDelta"},"right":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDelta"},"row":{"title":"Row","type":"integer"},"comment":{"title":"Comment","type":"string"}},"required":["left","right","row","comment"],"title":"KnowledgeBaseDiffResponseLineDiffer","type":"object"},"KnowledgeBaseDiffResponseLineDelta":{"properties":{"status":{"title":"Status","type":"string"},"page":{"title":"Page","type":"integer"},"line":{"title":"Line","type":"integer"},"text":{"title":"Text","type":"string"},"highlight":{"title":"Highlight","type":"string"}},"required":["status","page","line","text","highlight"],"title":"KnowledgeBaseDiffResponseLineDelta","type":"object"},"KnowledgeBaseDiffRequest":{"properties":{"leftId":{"description":"左のナレッジベースID","title":"Leftid","type":"string"},"rightId":{"description":"正しいナレッジベースID","title":"Rightid","type":"string"}},"required":["leftId","rightId"],"title":"KnowledgeBaseDiffRequest","type":"object"}}},"paths":{"/webapi/v2/knowledge_base_diff":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_diff_api_knowledge_base_diff","summary":"ナレッジベースの差分を取得する","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"正常に取得しました。","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponse"}}}}},"tags":["knowledge_bases"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDiffRequest"}}},"required":true}}}}}
```
## GET /download\_document\_by\_name/{project\_id}
> ファイル名でドキュメントをダウンロード
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/download_document_by_name/{project_id}":{"get":{"tags":["knowledge_bases"],"operationId":"downloadDocumentByName","summary":"ファイル名でドキュメントをダウンロード","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","description":"ダウンロードするドキュメント名"}}}}}},"responses":{"200":{"description":"ドキュメントファイルが正常にダウンロードされました。","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"複数のドキュメントが見つかりました。"},"401":{"description":"無許可"},"403":{"description":"禁止された"},"404":{"description":"ドキュメントが見つかりませんでした。"},"500":{"description":"内部サーバーエラー"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}}]}}}}
```
## 単一のドキュメントを取得
> これは、単一のドキュメントの詳細を取得する方法です。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/single_document":{"get":{"tags":["knowledge_bases"],"operationId":"getExactDocument","summary":"単一のドキュメントを取得","description":"これは、単一のドキュメントの詳細を取得する方法です。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"description":"ドキュメントのID。"}],"responses":{"200":{"description":"ドキュメントの詳細を正常に取得しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"ドキュメントのID。"},"documentName":{"type":"string","description":"ドキュメントのファイル名。"},"createdDate":{"type":"string","format":"date","description":"ドキュメントがアップロードされた日付。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"ドキュメントのために登録されたハッシュタグ。"},"agentFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"メンバーからの肯定的なフィードバックの数。"},"negativeCount":{"type":"integer","description":"メンバーからの否定的なフィードバックの数。"}},"description":"ユーザーによる肯定的および否定的評価の数。"},"userFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"ユーザーからの肯定的なフィードバックの数。"},"negativeCount":{"type":"integer","description":"ユーザーからの否定的なフィードバックの数。"}},"description":"ドキュメントに対するユーザーからのフィードバック。"}}}}}}}}}}}}}
```
## ドキュメントをアップロード
> このAPIを使用して、ドキュメントメニューにドキュメントをアップロードすることが可能です。 アップロード可能なファイル形式は、下記になります。\
> ファイル形式：.txt, .docx, .csv, .xls, .xlsx, .xlsm, .jpg, .jpeg, .png, .hwp, .hwpx, .pdf, .ppt, .pptx, .doc\
> 外部リンクが含まれるHTMLファイルをアップロードするには、アップロードする前に関連するリンク先のHTMLも含め、zipファイルに圧縮の上、アップロードしてください。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/upload_file":{"post":{"tags":["knowledge_bases"],"operationId":"uploadFile","summary":"ドキュメントをアップロード","description":"このAPIを使用して、ドキュメントメニューにドキュメントをアップロードすることが可能です。 アップロード可能なファイル形式は、下記になります。\nファイル形式：.txt, .docx, .csv, .xls, .xlsx, .xlsm, .jpg, .jpeg, .png, .hwp, .hwpx, .pdf, .ppt, .pptx, .doc\n外部リンクが含まれるHTMLファイルをアップロードするには、アップロードする前に関連するリンク先のHTMLも含め、zipファイルに圧縮の上、アップロードしてください。\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"ローカルファイルの場所"},"hashtags":{"type":"array","description":"アップロードファイルのためのハッシュタグ","items":{"type":"string"}},"footerTitle":{"type":"string","description":"アップロードされたファイルからの検索結果のフッターとして答えの情報源を入力できます。フッターテキストは検索結果の『From』の隣に表示されます。"},"footerUrl":{"type":"string","description":"リンクしたいURLをfooterTitleに入れることができます。"},"parentFolderId":{"type":"string","description":"アップロードする対象フォルダID。最上位レベルに挿入するにはヌル。"},"allowOtherAgentsView":{"type":"boolean","description":"このドキュメントを他のエージェントが閲覧できるようにするかどうか"},"allowOtherUsersView":{"type":"boolean","description":"他のユーザーがこのドキュメントを閲覧することを許可するかどうか"},"useLayout":{"type":"boolean","description":"ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。"},"useImageDescription":{"type":"boolean","description":"ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。"},"properties":{"type":"object","description":"ドキュメントに付与するメタデータ情報","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"ファイルのアップロードが成功しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"アップロードされたドキュメントのID"},"file_name":{"type":"string","description":"アップロードされたドキュメントのファイル名"},"hashtags":{"type":"array","description":"アップロードされたドキュメントに追加されたハッシュタグの配列","items":{"type":"string"}},"footer":{"type":"string","description":"アップロードされたドキュメントに追加されたフッター（出典）情報"}}}}}}}},"400":{"description":"無効なリクエストまたはファイル形式"},"413":{"description":"ファイルサイズが制限を超えています。"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## S3からドキュメントをアップロードする
> このAPIを使用すると、S3に保存されているドキュメントをAlliのドキュメントメニューに転送できます。利用可能なファイル形式は、アップロードドキュメントセクションと同じです。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/upload_from_s3":{"post":{"tags":["knowledge_bases"],"operationId":"uploadFromS3","summary":"S3からドキュメントをアップロードする","description":"このAPIを使用すると、S3に保存されているドキュメントをAlliのドキュメントメニューに転送できます。利用可能なファイル形式は、アップロードドキュメントセクションと同じです。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"ファイルのS3パス。ファイル名で終わる必要があります。バケット名を含めないでください。"},"secretKey":{"type":"string","description":"あなたのS3シークレットキー。"},"accessKey":{"type":"string","description":"あなたのS3アクセスキー。"},"bucket":{"type":"string","description":"ファイルを含むS3バケットの名前。"},"footerTitle":{"type":"string","description":"検索結果でのフッターテキストとして回答の出典を入力できます。フッターテキストは、検索結果の「出典」の横に表示されます。"},"footerUrl":{"type":"string","description":"リンクしたいURLをfooterTitleに入れることができます。"},"hashtags":{"type":"array","description":"ドキュメントのハッシュタグ。","items":{"type":"string"}},"parentFolderId":{"type":"string","description":"アップロード先のターゲットフォルダーID。最上位に挿入する場合は空にして下さい。"},"properties":{"type":"object","description":"ドキュメントに付与できるメタ情報です。","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"S3からファイルが正常にアップロードされました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"転送されたドキュメントのID。"},"file_name":{"type":"string","description":"転送された文書のファイル名。"},"hashtags":{"type":"array","description":"アップロードされたドキュメントに追加されたハッシュタグの配列。","items":{"type":"string"}},"footer":{"type":"string","description":"アップロードされた文書にフッター（ソース）情報が追加されました。"}}}}}}}},"400":{"description":"無効なリクエストパラメーター"},"404":{"description":"S3でファイルが見つかりません。"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## ドキュメントのステータスを確認
> APIを介してドキュメントをアップロードすると、変換、解析され、ベクトルとして埋め込まれます。このAPIは、アップロードされるドキュメントの処理状況を表示します。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/check_file_status":{"get":{"tags":["knowledge_bases"],"operationId":"checkFileStatus","summary":"ドキュメントのステータスを確認","description":"APIを介してドキュメントをアップロードすると、変換、解析され、ベクトルとして埋め込まれます。このAPIは、アップロードされるドキュメントの処理状況を表示します。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"description":"ステータスを確認するためのドキュメントID"}],"responses":{"200":{"description":"ファイルのステータスを正常に取得しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"確認中のドキュメントのID"},"status":{"type":"string","description":"ドキュメントのステータス（例：初期化中、処理中、完了、失敗）"},"errorName":{"type":"string","description":"ステータスが失敗を示している場合のエラー名"}}}}}}}},"400":{"description":"無効なタスクIDまたはファイルが見つかりません"}}}}}}
```
## ドキュメントの名前を変更 (ナレッジベース)
> このAPIを使用すると、ドキュメントメニューにアップロードされたドキュメントの名前を更新できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/update_kb_name":{"post":{"tags":["knowledge_bases"],"operationId":"updateKnowledgeBaseName","summary":"ドキュメントの名前を変更 (ナレッジベース)","description":"このAPIを使用すると、ドキュメントメニューにアップロードされたドキュメントの名前を更新できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"変更したいファイルのID。"},"filename":{"type":"string","description":"指定したファイルの新しい名前を入力。"}}}}}},"responses":{"200":{"description":"ファイルの名前が正常に更新されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"ファイル名が変更されたファイルのID。"},"filename":{"type":"string","description":"ファイルの新しい名前。"}}}}}}}},"400":{"description":"無効なパラメータ"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## タイトルでドキュメントを検索
> このAPIでは、ドキュメント名でドキュメントを検索することができます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/search_document_by_title":{"get":{"tags":["knowledge_bases"],"operationId":"searchDocumentByTitle","summary":"タイトルでドキュメントを検索","description":"このAPIでは、ドキュメント名でドキュメントを検索することができます。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"query","in":"query","required":true,"schema":{"type":"string"},"description":"ドキュメントタイトルの検索用語。"},{"name":"hashtags","in":"query","required":false,"schema":{"type":"string"},"description":"ドキュメントをフィルターするためのカンマ区切りのハッシュタグのリスト。"},{"name":"combinedHashtags","in":"query","required":false,"schema":{"type":"string"},"description":"グループをセミコロンで区切り、グループ内のタグをカンマで区切る複雑なハッシュタグフィルタリング(例:\"a,b;c,d\")。"},{"name":"excludingHashtags","in":"query","required":false,"schema":{"type":"string"},"description":"ドキュメントを除外するためのカンマ区切りのハッシュタグのリスト。"},{"name":"useVector","in":"query","required":false,"schema":{"type":"string"},"description":"セマンティックマッチングにベクトル検索を使用するには「true」、テキストベースの検索には「false」に設定します。"},{"name":"sortKey","in":"query","required":false,"schema":{"type":"string"},"description":"結果を並べ替えるプロパティフィールド。"},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]},"description":"結果をソートする方向(昇順または降順)。"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"ページネーションのためにスキップする結果の数。"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"返す結果の最大数。"}],"responses":{"200":{"description":"検索に成功しました","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ドキュメントのID。"},"file_name":{"type":"string","description":"ドキュメント名。"},"page_count":{"type":"integer","description":"ドキュメントのページ数。"},"download_url":{"type":"string","description":"ドキュメントをダウンロードするためのURL。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"ドキュメントに関連するハッシュタグ。"},"score":{"type":"number","description":"検索クエリの関連性スコア。"},"folder":{"type":"string","description":"ドキュメントを含むフォルダー。"},"agentEditor":{"type":"array","items":{"type":"string"},"description":"編集権限を持つエージェントのリスト。"},"agentViewer":{"type":"array","items":{"type":"string"},"description":"閲覧権限を持つ担当者のリスト。"}}}}}}}}}}}}}}
```
## ドキュメントを削除
> このAPIを使用すると、アップロードされたドキュメントを削除できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/delete_file":{"post":{"tags":["knowledge_bases"],"operationId":"deleteFile","summary":"ドキュメントを削除","description":"このAPIを使用すると、アップロードされたドキュメントを削除できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"配列形式で削除したいドキュメントIDを指定します。","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"ドキュメントが正常に削除されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"ok":{"type":"boolean","description":"true if the deletion completes successfully"}}},"errors":{"type":"object","nullable":true,"description":"削除が失敗した場合、ここにエラーメッセージが表示されます。"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## ドキュメントリストを取得
> アップロードされているドキュメントをリスト形式で取得します
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/knowledge_bases":{"get":{"tags":["knowledge_bases"],"operationId":"knowledgeBases","summary":"ドキュメントリストを取得","description":"アップロードされているドキュメントをリスト形式で取得します","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"hashtagsSearchOperator","in":"query","required":false,"schema":{"type":"string","enum":["AND","OR"],"default":"OR"},"description":"複数のハッシュタグを照合するために使用される論理演算子。AND または OR のいずれかを指定できます。デフォルトは OR です。"},{"name":"status","in":"query","required":false,"schema":{"type":"boolean"},"description":"リストをフィルタリングする対象ドキュメントのON/OFF状態"},{"name":"searchTerm","in":"query","required":false,"schema":{"type":"string"},"description":"リストを絞り込むためのキーワード検索クエリ。演算子を使用して高度な検索を実行できます。 AND検索には「TERM1 TERM2」、OR検索には「TERM1 OR TERM2」、完全一致検索には「TERM\\」を使用します。"},{"name":"hashtags","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"リストをフィルタリングするためのハッシュタグ情報。"},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["FILE_NAME_ASC","FILE_NAME_DESC","TYPE_ASC","TYPE_DESC","STATUS_ASC","STATUS_DESC","CREATED_AT_ASC","CREATED_AT_DESC"]},"description":"リストの並べ替え順。ファイル名にはFILE_NAME_ASC/DESC、ファイルタイプにはTYPE_ASC/DESC、オン/オフ状態にはSTATUS_ASC/DESC、アップロード日時にはCREATED_AT_ASC/DESCを使用します。"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0},"description":"オフセットを使用すると、ページ上の最初の項目の順位番号を指定できます。"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"limit を使用すると、1ページに表示されるオブジェクト数を設定できます。 最大値は100です。"}],"responses":{"200":{"description":"ドキュメントリストの取得に成功","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the listed document."},"fileName":{"type":"string","description":"The filename of the list document."},"hashtags":{"type":"array","items":{"type":"string"},"description":"The hashtags added on the document."},"autoHashtags":{"type":"array","items":{"type":"object"},"description":"The automatically generated hashtags added to the document."},"folder":{"type":"string","description":"The folder where the document is located."},"agentEditor":{"type":"array","items":{"type":"string"},"description":"List of agent emails with editor permissions."},"agentViewer":{"type":"array","items":{"type":"string"},"description":"List of agent emails with viewer permissions."},"userViewer":{"type":"object","properties":{"variables":{"type":"object"}},"description":"User viewer configuration with variables."},"allowOtherAgentsView":{"type":"boolean","description":"Whether other agents can view this document."},"allowOtherUsersView":{"type":"boolean","description":"Whether other users can view this document."}}}}}},"errors":{"type":"object","nullable":true,"description":"リクエスト処理が失敗した際のエラー情報を格納する"}}}}}}}}}}}
```
## ドキュメントのプレビューを確認
> アップロードされたドキュメントのプレビューを確認できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/knowledge_base_preview":{"get":{"tags":["knowledge_bases"],"operationId":"knowledgeBasePreview","summary":"ドキュメントのプレビューを確認","description":"アップロードされたドキュメントのプレビューを確認できます。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"description":"APIキーは、ダッシュボードの「設定」メニューの「一般」タブで確認できます。"},{"name":"pageNo","in":"query","required":true,"schema":{"type":"string"},"description":"プレビューを行うドキュメントID"}],"responses":{"200":{"description":"ドキュメントプレビューの取得に成功","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"totalPageCount":{"type":"integer","description":"ドキュメントの総ページ数"},"pageNo":{"type":"integer","description":"現在プレビュー中のページ番号"},"css":{"type":"string","nullable":true,"description":"ドキュメントのCSSスタイル設定"},"body":{"type":"string","nullable":true,"description":"ドキュメントのHTML本文コンテンツ"},"highlightIndexes":{"type":"array","items":{"type":"integer"},"description":"ハイライトインデックスの配列"},"exactAnswer":{"type":"string","nullable":true,"description":"正解の回答（回答がある場合）"},"pdf":{"type":"string","nullable":true,"description":"PDFコンテンツまたは「PDF」文字列。ページ番号が無効などのエラーが発生した場合、nullを返します"},"draftjs":{"type":"string","nullable":true,"description":"ドラフトJS形式のコンテンツ"},"highlights":{"type":"object","properties":{"indexes":{"type":"array","nullable":true,"items":{"type":"integer"},"description":"ハイライトインデックス"},"pageIndexes":{"type":"array","items":{"type":"integer"},"description":"ページ固有のハイライトインデックス"},"__typename":{"type":"string","description":"GraphQLのタイプ名"}},"description":"ドキュメントのハイライト情報"},"knowledgeBase":{"type":"object","properties":{"id":{"type":"string","description":"ドキュメントのID"},"title":{"type":"string","description":"ドキュメントのタイトル"},"__typename":{"type":"string","description":"GraphQLのタイプ名"}},"description":"ナレッジベース情報"},"__typename":{"type":"string","description":"GraphQLのタイプ名"}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報"}}}}}}}}}}}
```
## ドキュメント情報の更新
> このAPIでは、ドキュメントのハッシュタグ・フッタータイトル・フッターリンクを更新できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/update_document":{"post":{"tags":["knowledge_bases"],"operationId":"updateDocument","summary":"ドキュメント情報の更新","description":"このAPIでは、ドキュメントのハッシュタグ・フッタータイトル・フッターリンクを更新できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"更新したいドキュメントのID"},"footerTitle":{"type":"string","description":"アップロードしたファイルから生成された検索結果に出典(ソース)として表示されるフッターテキストを設定できます。検索結果の「From」の右側に表示されます。"},"footerUrl":{"type":"string","description":"footerTitleにリンクさせたいURLを指定します。"},"folder":{"type":"string","description":"ドキュメントをアップロードするときの保存先フォルダーを指定します。"},"followFolderPermission":{"type":"boolean","description":"フォルダの権限設定を引き継ぐかどうかを指定します。"},"agentsEditor":{"type":"array","items":{"type":"string"},"description":"このドキュメントに対して編集権限を持つメンバーを指定します。"},"agentsViewer":{"type":"array","items":{"type":"string"},"description":"このファイルに対して閲覧権限を持つメンバーを指定します。"},"userViewer":{"type":"object","description":"このドキュメントを閲覧する権限を持つユーザーを指定します。","properties":{"customer_id":{"type":"array","items":{"type":"string"}},"customer_group":{"type":"array","items":{"type":"string"}}}},"allowOtherAgentsView":{"type":"boolean","description":"閲覧者や編集者に指定されていないメンバーにも、このドキュメントの閲覧を許可するかどうかを指定します。"},"allowOtherUsersView":{"type":"boolean","description":"閲覧者や編集者として指定されていない一般ユーザーにも、このドキュメントの閲覧を許可するかどうかを指定します。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"ドキュメントに追加したいハッシュタグ(文字列)の一覧です。"},"properties":{"type":"object","description":"ドキュメントに紐づける任意のプロパティ(属性)を設定します。","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"ドキュメントが正常に更新されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"knowledgeBase":{"type":"object","properties":{"id":{"type":"string","description":"ハッシュタグ付与の更新がされたドキュメントのIDを示します。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"更新後にドキュメントへ付与されたハッシュタグ。"},"footer":{"type":"string","description":"アップロードされたドキュメントに追加されるフッター(出典)情報です。デフォルトのフッターか、footerTitle および footerUrl で指定した内容が反映されます。※HTML 形式で返されます。 "}}}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報です。"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## ナレッジベースのステータス変更
> このAPIでは、ナレッジベースの複数のドキュメントの\
> 公開・非公開(ON/OFF)ステータスをまとめて変更できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"knowledge_bases","description":"Knowledge base related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/toggle_documents":{"post":{"tags":["knowledge_bases"],"operationId":"toggleDocuments","summary":"ナレッジベースのステータス変更","description":"このAPIでは、ナレッジベースの複数のドキュメントの\n公開・非公開(ON/OFF)ステータスをまとめて変更できます。\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["use","ids"],"properties":{"use":{"type":"boolean","description":"全ての指定ドキュメントのステータスをON(true) にするか、OFF(false) にするかを指定します。true → すべて「ON」、false → すべて「OFF」"},"ids":{"type":"array","items":{"type":"string"},"description":"ステータスを切り替えたいドキュメントIDのリスト。"}}}}}},"responses":{"200":{"description":"ナレッジベースのステータスが正常に切り替えられました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"knowledgeBases":{"type":"array","description":"ステータスが切り替えられたドキュメントの一覧。","items":{"type":"object","properties":{"id":{"type":"string","description":"ドキュメントのID"},"status":{"type":"boolean","description":"ドキュメントの新しいステータス。true の場合はステータスが ON になっていることを意味します。"}}}}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報。"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```