# RAG

Knowledge base node related APIs

## GET /webapi/v2/highlights/{clue\_id}

> ハイライトを取得

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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":{"HighlightResponse":{"properties":{"bboxes":{"items":{"$ref":"#/components/schemas/BboxResponse"},"title":"Bboxes","type":"array"},"type":{"$ref":"#/components/schemas/AnswerType"}},"required":["bboxes","type"],"title":"HighlightResponse","type":"object"},"BboxResponse":{"properties":{"left":{"title":"Left","type":"number"},"top":{"title":"Top","type":"number"},"right":{"title":"Right","type":"number"},"bottom":{"title":"Bottom","type":"number"}},"required":["left","top","right","bottom"],"title":"BboxResponse","type":"object"},"AnswerType":{"description":"回答タイプ","enum":["PARAGRAPH","TABLE","IMAGE"],"title":"AnswerType","type":"string"}}},"paths":{"/webapi/v2/highlights/{clue_id}":{"get":{"operationId":"django_server_rag_views_rest_answer_highlight_api_get_highlight","summary":"ハイライトを取得","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"clue_id","schema":{"title":"Clue Id","type":"string"},"required":true}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HighlightResponse"}}}}},"tags":["RAG"]}}}}
```

## RAREステータス

> プロジェクトのRAREビルド/生成ステータスを取得します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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":{"RareStatusResponse":{"properties":{"build_status":{"title":"Build Status","type":"string"},"job_status":{"title":"Job Status","type":"string"},"job_type":{"title":"Job Type","type":"string"},"build_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Build Run Id"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"build_progress":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Build Progress"},"generate_progress":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Generate Progress"},"build_stats":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Build Stats"},"generate_stats":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Generate Stats"},"folder_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folder Ids"},"default_model":{"default":"","title":"Default Model","type":"string"},"generation_model":{"default":"","title":"Generation Model","type":"string"}},"required":["build_status","job_status","job_type"],"title":"RareStatusResponse","type":"object"}}},"paths":{"/webapi/v2/rare/status":{"get":{"operationId":"django_server_rag_views_rest_rare_api_rare_status","summary":"RAREステータス","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareStatusResponse"}}}}},"description":"プロジェクトのRAREビルド/生成ステータスを取得します。","tags":["RAG"]}}}}
```

## RAREビルド

> RAREビルドタスクを開始します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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":{"RareJobResponse":{"properties":{"message":{"title":"Message","type":"string"},"task_id":{"title":"Task Id","type":"string"}},"required":["message","task_id"],"title":"RareJobResponse","type":"object"},"RareBuildRequest":{"properties":{"language":{"default":"Korean","title":"Language","type":"string"},"default_model":{"default":"gpt54_nano","title":"Default Model","type":"string"},"similarity_threshold":{"default":0.5,"title":"Similarity Threshold","type":"number"},"top_k_per_chunk":{"default":1,"title":"Top K Per Chunk","type":"integer"},"max_similar_items":{"default":256,"title":"Max Similar Items","type":"integer"},"max_workers":{"default":100,"title":"Max Workers","type":"integer"},"folder_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folder Ids"}},"title":"RareBuildRequest","type":"object"}}},"paths":{"/webapi/v2/rare/build":{"post":{"operationId":"django_server_rag_views_rest_rare_api_rare_build","summary":"RAREビルド","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareJobResponse"}}}}},"description":"RAREビルドタスクを開始します。","tags":["RAG"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareBuildRequest"}}},"required":true}}}}}
```

## RARE生成

> RARE生成タスクを開始します。先にビルドが完了している必要があります。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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":{"RareJobResponse":{"properties":{"message":{"title":"Message","type":"string"},"task_id":{"title":"Task Id","type":"string"}},"required":["message","task_id"],"title":"RareJobResponse","type":"object"},"RareGenerateRequest":{"properties":{"num_samples":{"default":10,"title":"Num Samples","type":"integer"},"input_pool_size":{"default":50,"title":"Input Pool Size","type":"integer"},"num_questions":{"default":10,"title":"Num Questions","type":"integer"},"num_information":{"default":2,"title":"Num Information","type":"integer"},"language":{"default":"Korean","title":"Language","type":"string"},"default_model":{"default":"gpt54_nano","title":"Default Model","type":"string"},"generation_model":{"default":"gpt54","title":"Generation Model","type":"string"},"rare_user_prompt":{"default":"","title":"Rare User Prompt","type":"string"}},"title":"RareGenerateRequest","type":"object"}}},"paths":{"/webapi/v2/rare/generate":{"post":{"operationId":"django_server_rag_views_rest_rare_api_rare_generate","summary":"RARE生成","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareJobResponse"}}}}},"description":"RARE生成タスクを開始します。先にビルドが完了している必要があります。","tags":["RAG"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareGenerateRequest"}}},"required":true}}}}}
```

## RAREをキャンセル

> 実行中のRAREジョブに対して協調的なキャンセルを要求します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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":{"RareJobResponse":{"properties":{"message":{"title":"Message","type":"string"},"task_id":{"title":"Task Id","type":"string"}},"required":["message","task_id"],"title":"RareJobResponse","type":"object"}}},"paths":{"/webapi/v2/rare/cancel":{"post":{"operationId":"django_server_rag_views_rest_rare_api_rare_cancel","summary":"RAREをキャンセル","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareJobResponse"}}}}},"description":"実行中のRAREジョブに対して協調的なキャンセルを要求します。","tags":["RAG"]}}}}
```

## RARE結果一覧

> プロジェクトの最近のRARE生成結果を一覧表示します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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":{"RareResultsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/RareResultItem"},"title":"Results","type":"array"}},"required":["results"],"title":"RareResultsResponse","type":"object"},"RareResultItem":{"properties":{"id":{"title":"Id","type":"string"},"created_at":{"title":"Created At","type":"string"},"n_samples":{"title":"N Samples","type":"integer"},"rare_config":{"title":"Rare Config","type":"string"},"result_file_url":{"title":"Result File Url","type":"string"}},"required":["id","created_at","n_samples","rare_config","result_file_url"],"title":"RareResultItem","type":"object"}}},"paths":{"/webapi/v2/rare/results":{"get":{"operationId":"django_server_rag_views_rest_rare_api_rare_results","summary":"RARE結果一覧","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RareResultsResponse"}}}}},"description":"プロジェクトの最近のRARE生成結果を一覧表示します。","tags":["RAG"]}}}}
```

## RARE結果を削除

> IDを指定してRARE生成結果を削除します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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/v2/rare/results/{result_id}":{"delete":{"operationId":"django_server_rag_views_rest_rare_api_rare_delete_result","summary":"RARE結果を削除","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"result_id","schema":{"title":"Result Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK"}},"description":"IDを指定してRARE生成結果を削除します。","tags":["RAG"]}}}}
```

## RARE CSV

> ストレージからRARE CSVファイルをプロキシします。ヘッダーと行を含むJSONを返します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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/v2/rare/csv":{"get":{"operationId":"django_server_rag_views_rest_rare_api_rare_csv","summary":"RARE CSV","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"query","name":"path","schema":{"default":"","title":"Path","type":"string"},"required":false}],"responses":{"200":{"description":"OK"}},"description":"ストレージからRARE CSVファイルをプロキシします。ヘッダーと行を含むJSONを返します。","tags":["RAG"]}}}}
```

## バルク処理を実行

> バルク処理（GAまたはRAG）を開始します。\
> \
> 引数:\
>     file: question, model, search\_typeの列を含むCSVファイル。\
>           オプション: target\_answer, target\_clue, hashtag, folder。\
>     bulk\_type: "ga"（デフォルト）または "rag"

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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/v2/bulk_processing/run":{"post":{"operationId":"django_server_rag_views_rest_bulk_processing_api_run_bulk","summary":"バルク処理を実行","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"query","name":"bulk_type","schema":{"default":"ga","enum":["ga","rag"],"title":"Bulk Type","type":"string"},"required":false}],"responses":{"200":{"description":"OK"}},"description":"バルク処理（GAまたはRAG）を開始します。\n\n引数:\n    file: question, model, search_typeの列を含むCSVファイル。\n          オプション: target_answer, target_clue, hashtag, folder。\n    bulk_type: \"ga\"（デフォルト）または \"rag\"","tags":["RAG"],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","title":"File","type":"string"}},"required":["file"],"title":"FileParams","type":"object"}}},"required":true}}}}}
```

## 結果一覧

> バルク処理の結果（GA + RAG統合、ページネーション）を一覧表示します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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/v2/bulk_processing/results":{"get":{"operationId":"django_server_rag_views_rest_bulk_processing_api_list_results","summary":"結果一覧","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"query","name":"page","schema":{"default":1,"title":"Page","type":"integer"},"required":false}],"responses":{"200":{"description":"OK"}},"description":"バルク処理の結果（GA + RAG統合、ページネーション）を一覧表示します。","tags":["RAG"]}}}}
```

## 結果をダウンロード

> バルク処理の結果CSVをダウンロードします。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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/v2/bulk_processing/download":{"get":{"operationId":"django_server_rag_views_rest_bulk_processing_api_download_result","summary":"結果をダウンロード","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"query","name":"file_url","schema":{"title":"File Url","type":"string"},"required":true}],"responses":{"200":{"description":"OK"}},"description":"バルク処理の結果CSVをダウンロードします。","tags":["RAG"]}}}}
```

## 結果を削除

> IDを指定してバルク処理の結果（GAまたはRAG）を削除します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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/v2/bulk_processing/results/{result_id}":{"delete":{"operationId":"django_server_rag_views_rest_bulk_processing_api_delete_result","summary":"結果を削除","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"result_id","schema":{"title":"Result Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK"}},"description":"IDを指定してバルク処理の結果（GAまたはRAG）を削除します。","tags":["RAG"]}}}}
```

## 回答生成

> 非構造化テキストドキュメント、Q\&A、複雑な表などから、さまざまな情報を統合して、ユーザーの問い合わせに対する包括的な回答を生成します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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/generative_answer":{"post":{"tags":["RAG"],"operationId":"getGenerativeAnswer","summary":"回答生成","description":"非構造化テキストドキュメント、Q&A、複雑な表などから、さまざまな情報を統合して、ユーザーの問い合わせに対する包括的な回答を生成します。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","required":true,"description":"クエリ(質問文)"},"model":{"type":"string","description":"回答生成に利用するプロンプトを指定。デフォルトモデルはGPT4o。利用可能なオプションについてはドキュメントをご参照ください。"},"answerFormat":{"type":"string","description":"応答のフォーマットを決定します。指定できる値はDRAFTJSまたはMARKDOWNです。デフォルトのフォーマットはDRAFTJSです。"},"isStateful":{"type":"boolean","description":"フォローアップ質問を使用するには、以前の会話履歴が必要です。会話履歴はthreadIdによって管理されます。isStatefulオプションをTrueに設定し、threadIdを入力すると、クエリは以前の会話履歴を参照して書き換えられます。デフォルトはFalseです。"},"threadId":{"type":"string","format":"uuid","description":"threadIdはisStatefulがTrueの場合に使用されます。最初に会話を開始するときは、空のまま送信し、次のクエリ以降は出力からのthreadIdを使用して送信します。最初からthreadIdを設定したい場合は、UUIDとして記入し送信します。例: UUID - 36e7bb2b-1063-47ec-。デフォルト = None。"},"promptGroupId":{"type":"string","description":"回答生成に使用するプロジェクトのグループプロンプトを選択します。この設定は、デフォルトで準備されたグループプロンプトから変更を行い利用している場合などに有効です。\nIDはプロジェクト設定>プロンプト管理>回答生成タブの選択します。使用するグループプロンプトを選択した際に表示されるURLからIDが確認できます。\n例:https://app.alli.ai/projects/UHJvamVjdDo2NDljYTRjZDMzMGY2MDZkYWRjOPOjNjE=/settings/prompt-management/generative-answer/groups/TExNUHJvbXB0R3JvdXA6NjUzNzc3MzA5GHUyMGE2ZjlhM2Q5OTIw\n"},"mode":{"type":"string","description":"'データをsyncかstreamのどちらで出力するか設定します。(Default = sync)\nstreamモードの場合、syncと同じ出力形式のjson文字列がstreamとして出力されます。\n"},"clueText":{"type":"boolean","description":"clueTextはclues=Trueの時に利用できるオプションです。\nclueに用いたドキュメントのテキスト情報を含めるかどうか設定できます。(Default = False)\n"},"clues":{"type":"boolean","description":"回答を生成するために使用されたclueを出力に含めるかどうか設定できます。(Default = False)"},"includeCitations":{"type":"boolean","description":"回答に詳細な引用情報を含めるかの有無。回答の生成に使用されたソース文書を参照します。デフォルトはFalseです。\n"},"hashtags":{"type":"object","description":"ハッシュタグを使用してドキュメントとFAQの検索範囲を指定できます。 特定のハッシュタグを含めたり除外したり、選択したハッシュタグのオプションを指定することができます。\n例： { \"qnaInclude\" : [\"hash name\", \"hash name2\"], \"qnaIncludeOption\" : \"and\"/\"or\", \"qnaExclude\" : [\"hash name\", \"hash name2\"], \"qnaExcludeOption\" : \"and\"/\"or\", \"docsInclude\" : [\"hash name\", \"hash name2\"], \"docsIncludeOption\" : \"and\"/\"or\", \"docsExclude\" : [\"hash name\", \"hash name2\"], \"docsExcludeOption\" : \"and\"/\"or\", }\n","properties":{"qnaInclude":{"type":"array","items":{"type":"string"},"description":"検索に含めるFAQハッシュタグ"},"qnaIncludeOption":{"type":"string","enum":["and","or"],"default":"or","description":"FAQのハッシュタグにAND条件/OR条件を含む"},"qnaExclude":{"type":"array","items":{"type":"string"},"description":"検索から除外するFAQハッシュタグ"},"qnaExcludeOption":{"type":"string","enum":["and","or"],"default":"or","description":"検索から除外するFAQハッシュタグにAND条件/OR条件を含む"},"docsInclude":{"type":"array","items":{"type":"string"},"description":"検索に含めるドキュメントハッシュタグ"},"docsIncludeOption":{"type":"string","enum":["and","or"],"default":"or","description":"ドキュメントのハッシュタグにAND条件/OR条件を含む"},"docsExclude":{"type":"array","items":{"type":"string"},"description":"検索から除外するドキュメントハッシュタグ"},"docsExcludeOption":{"type":"string","enum":["and","or"],"default":"or","description":"検索から除外するドキュメントハッシュタグにAND条件/OR条件を含む"}}},"search_from":{"type":"array","items":{"type":"string"},"description":"回答生成時に検索するソース データの範囲を指定します。現在使用可能な値は、web、qna、document、およびリスト形式でのデータ入力です。\n例：[\"web\", \"qna\"]\n"},"temperature":{"type":"number","description":"出力のランダム性を制御します。値が高いほど、出力はよりランダムになります。デフォルト = 0。"},"source":{"type":"object","description":"Source configuration for knowledge bases and folders. This is the preferred way to specify search scope. Use this instead of the legacy knowledgeBaseIds/folderIds parameters.\n","properties":{"sharedKnowledgeBaseNodeIds":{"type":"array","items":{"type":"string"},"description":"List of shared knowledge base or folder node IDs (global IDs) to search. Use empty array [] to search all shared documents. Use null to exclude shared documents from search.\n"},"personalKnowledgeBaseNodeIds":{"type":"array","items":{"type":"string"},"description":"List of personal knowledge base or folder node IDs (global IDs) to search. Use empty array [] to search all personal documents. Use null to exclude personal documents from search.\n"},"webSites":{"type":"array","items":{"type":"string"},"description":"List of web sites to search."}}},"knowledgeBaseIds":{"type":"array","items":{"type":"string"},"description":"検索を特定のナレッジベースノード(ドキュメントやフォルダ)IDに限定します。"},"folderIds":{"type":"array","items":{"type":"string"},"description":"検索を特定のドキュメントフォルダーIDに限定します。"}}}}}},"responses":{"200":{"description":"回答が生成されました","content":{"application/json":{"schema":{"type":"object","properties":{"answer":{"type":"object","description":"にアップロードされたドキュメントから生成された回答内容。answerFormatパラメータに従ってフォーマットされています。"},"answerHash":{"type":"string","description":"フィードバックを提供またはキャンセルするための回答を特定するために使用されます。"},"confidence":{"type":"number","description":"AIモデルからの信頼度を示しています。0と1の間の数値として表示されます。"},"effectiveConfidence":{"type":"number","description":"クエリ結果にフィードバックを提供すると、それが自動的にAIモデルをトレーニングします。効果的な信頼度は、これらのユーザーとエージェントのフィードバックで調整されたスコアです。0から1の数値として表示されます。"},"documentId":{"type":"string","description":"回答生成に利用したドキュメントのID。"},"documentName":{"type":"string","description":"回答生成に利用したドキュメントの名前。"},"hashtags":{"type":"array","description":"ドキュメントに付けられたハッシュタグ。"},"pageNo":{"type":"integer","description":"回答生成に利用したドキュメントのページ番号。"},"createdDate":{"type":"string","format":"date","description":"ドキュメントがアップロードされた日付。"},"agentFeedback":{"type":"object","description":"このドキュメントに関するエージェントからのフィードバック(ダッシュボードおよびRESTコールを通じて行われたフィードバック)。"},"userFeedback":{"type":"object","description":"このドキュメントに関するユーザーからのフィードバック。"},"body":{"type":"string","description":"リクエストでreturnPreviewがtrueの場合、ドキュメント検索プレビューのHTMLボディが表示されます。"},"css":{"type":"string","description":"リクエストでreturnPreviewがtrueの場合、ドキュメント検索プレビューのCSSが表示されます。"},"pdfPreview":{"type":"string","description":"リクエストでreturnPdfPreviewがtrueの場合、回答がハイライトされたドキュメントのPDFプレビューへのURLが表示されます。URLは、ダウンロードIP許可リスト設定を使用して制限することができる点に注意してください。"},"folder":{"type":"string","description":"ドキュメントデータベース内のフォルダから見つかった場合、フォルダ名が記載されます。"},"editor":{"type":"array","items":{"type":"string"},"description":"ドキュメントに編集者アクセスを持つエージェントのメールのリスト。"},"viewer":{"type":"array","items":{"type":"string"},"description":"ドキュメントの閲覧アクセス権を持つエージェントのメールのリスト。"},"threadId":{"type":"string","description":"isStatefulがtrueの場合にフォローアップクエスチョンに使用できるUUID。"},"fuQuestion":{"type":"string","description":"isStatefulがtrueの場合、ユーザーへの推奨フォローアップ質問。"},"intent":{"type":"string","description":"クエリの検出されたインテント。"},"clues":{"type":"array","description":"リクエストで手がかりが真の場合、回答を生成するために使用されたソースがここに返されます。"},"citations":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"回答本文中で[1]、[2]などで参照される引用番号。"},"clueId":{"type":"string","description":"一意のソース識別子"},"source":{"type":"string","description":"ソースの種類(ドキュメント、FAQ、WEB)"},"title":{"type":"string","description":"ソースドキュメントまたはFAQのタイトル"},"pageNo":{"type":"integer","description":"ソース文書のページ番号"},"knowledgeBaseId":{"type":"string","description":"ナレッジベースのドキュメントのID"},"faqId":{"type":"string","description":"FAQのID"},"url":{"type":"string","description":"WEBソースのURL"},"text":{"type":"string","description":"原文の抜粋(500文字以内)"}}},"description":"リクエストのincludeCitationsがtrueの場合、構造化された引用情報が返されます。各引用は、回答テキスト内の[number]に対応します。\n"}}}}}},"400":{"description":"不正なリクエスト","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string","description":"エラーメッセージ"}}}}}},"401":{"description":"無許可","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string","description":"エラーメッセージ"}}}}}},"429":{"description":"レート制限を超えました。","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string","description":"レート制限超過"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## Alli Retrieval API

> Retrieval APIは、Alliにアップロードされたドキュメントから質問に関連する上位N件のページ情報を取得できます。このAPIはキーワード検索と意味検索を組み合わせ、クエリに最も関連性の高いドキュメントページを提供します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"RAG","description":"Knowledge base node related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"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/retrieval":{"post":{"tags":["RAG"],"operationId":"retrievalPost","summary":"Alli Retrieval API","description":"Retrieval APIは、Alliにアップロードされたドキュメントから質問に関連する上位N件のページ情報を取得できます。このAPIはキーワード検索と意味検索を組み合わせ、クエリに最も関連性の高いドキュメントページを提供します。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string","description":"ドキュメントベースで検索する質問","required":true},"maxDocumentClues":{"type":"integer","description":"関連ページを取得する数を決定します。デフォルト値は3です。"},"bm25_score_weight":{"type":"number","format":"float","description":"これはキーワード検索の重みです。この値が高いほど、キーワードスコアがより反映されます。0から9の間の値が適切であり、値が0の場合はキーワード検索が使用されないことを意味します。デフォルト値は9です。"},"text_vector_score_weight":{"type":"number","format":"float","description":"これは文書内容に対するセマンティック検索の重みです。この値が高いほど、より多く反映されます。0から9の値が適切で、値が0の場合は文書内容に対するセマンティック検索が使用されません。デフォルト値は1です。"},"title_vector_score_weight":{"type":"number","format":"float","description":"これは文書タイトルに対するセマンティック検索の重みです。同様に、0から9の間の値が適切であり、値が0の場合は文書タイトルに対するセマンティック検索が使用されないことを意味します。デフォルト値は0です。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"これらのハッシュタグが含まれるドキュメントのみ結果をフィルタリングしてください"},"hashtags_operator":{"type":"string","enum":["and","or"],"description":"ハッシュタグの論理演算子(デフォルトは「または」)"},"exclude_hashtags":{"type":"array","items":{"type":"string"},"description":"これらのハッシュタグを含むドキュメントを除外するために結果をフィルタリングしてください。"},"exclude_hashtags_operator":{"type":"string","enum":["and","or"],"description":"除外ハッシュタグの論理演算子(デフォルトは「または」)"},"targetFolders":{"type":"array","items":{"type":"string"},"description":"検索対象フォルダ名"},"folderIds":{"type":"array","items":{"type":"string"},"description":"検索対象のフォルダーのID"},"knowledgeBaseIds":{"type":"array","items":{"type":"string"},"description":"特定のナレッジベース内を検索するためのID"},"use_keywords":{"type":"boolean","description":"検索のためのキーワードを抽出して使用するかどうか"},"use_clue_feedback":{"type":"boolean","description":"検索結果を改善するためにフィードバックデータを使用するかどうか"},"use_reranker":{"type":"boolean","description":"Overrides the project's cognitive_config.use_reranker for this request. When omitted, the project config value is used.\n"},"reranker_candidates_num":{"type":"integer","description":"Overrides the number of candidate pages passed to the reranker. Only effective when reranking is enabled. Defaults to 16 when omitted.\n"},"reranker_max_tokens":{"type":"integer","description":"Overrides the maximum token length per candidate sent to the reranker. Only effective when reranking is enabled. Defaults to 1024 when omitted.\n"}}}}}},"responses":{"200":{"description":"結果を正常に取得しました","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"ranking":{"type":"integer","description":"質問に関連するページのランク"},"title":{"type":"string","description":"質問に関連する文書のタイトル"},"text":{"type":"string","description":"質問に関連するページの内容"},"pageNo":{"type":"integer","description":"ページ番号"},"kb_id":{"type":"string","description":"ナレッジベース文書のID"}}}}}}}}},"400":{"description":"無効なパラメーター","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string"}}}}}},"500":{"description":"内部サーバーエラー","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.allganize.ai/api-reference/ja-1/rag.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.