RAG

Knowledge base node related APIs

ハイライトを取得

get

/webapi/v2/highlights/{clue_id}

Retrieve bounding box coordinates for answer highlights in a knowledge base document page.

Authorizations

API-KEYstringRequired

認証用のAPIキー

Path parameters

clue_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

成功

application/json

typestring · enumRequired

回答タイプ

Possible values:

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/highlights/{clue_id}

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

{
  "bboxes": [
    {
      "left": 1,
      "top": 1,
      "right": 1,
      "bottom": 1
    }
  ],
  "type": "PARAGRAPH"
}

Highlight Retrieval Result

post

/webapi/v2/retrieval/highlight

Return highlight bboxes for a single Retrieval result resolved straight from the retrieved page chunk (kbId + pageNo + subTextIndex), without a generative-answer clue id.

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

kbIdstring · min: 1Required

pageNointeger · min: 1Required

subTextIndexintegerOptionalDefault: 1

passageTextstring · nullableOptional

Responses

200

application/json

typestring · enumRequired

回答タイプ

Possible values:

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/retrieval/highlight

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

{
  "kbId": "text",
  "pageNo": 1,
  "subTextIndex": 1,
  "passageText": "text"
}

{
  "bboxes": [
    {
      "left": 1,
      "top": 1,
      "right": 1,
      "bottom": 1
    }
  ],
  "type": "PARAGRAPH"
}

RAREステータス

get

/webapi/v2/rare/status

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

application/json

build_statusstringRequired

job_statusstringRequired

job_typestringRequired

build_run_idstring · nullableOptional

error_messagestring · nullableOptional

folder_idsstring[] · nullableOptional

default_modelstringOptionalDefault: ""

generation_modelstringOptionalDefault: ""

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/rare/status

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

{
  "build_status": "text",
  "job_status": "text",
  "job_type": "text",
  "build_run_id": "text",
  "error_message": "text",
  "build_progress": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "generate_progress": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "build_stats": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "generate_stats": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "folder_ids": [
    "text"
  ],
  "default_model": "",
  "generation_model": ""
}

RAREビルド

post

/webapi/v2/rare/build

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

languagestringOptionalDefault: Korean

default_modelstringOptionalDefault: gpt54_nano

similarity_thresholdnumberOptionalDefault: 0.5

top_k_per_chunkintegerOptionalDefault: 1

max_similar_itemsintegerOptionalDefault: 256

max_workersintegerOptionalDefault: 100

folder_idsstring[] · nullableOptional

Responses

200

application/json

messagestringRequired

task_idstringRequired

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/rare/build

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

{
  "language": "Korean",
  "default_model": "gpt54_nano",
  "similarity_threshold": 0.5,
  "top_k_per_chunk": 1,
  "max_similar_items": 256,
  "max_workers": 100,
  "folder_ids": [
    "text"
  ]
}

{
  "message": "text",
  "task_id": "text"
}

RARE生成

post

/webapi/v2/rare/generate

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

num_samplesintegerOptionalDefault: 10

input_pool_sizeintegerOptionalDefault: 50

num_questionsintegerOptionalDefault: 10

num_informationintegerOptionalDefault: 2

languagestringOptionalDefault: Korean

default_modelstringOptionalDefault: gpt54_nano

generation_modelstringOptionalDefault: gpt54

rare_user_promptstringOptionalDefault: ""

Responses

200

application/json

messagestringRequired

task_idstringRequired

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/rare/generate

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

{
  "num_samples": 10,
  "input_pool_size": 50,
  "num_questions": 10,
  "num_information": 2,
  "language": "Korean",
  "default_model": "gpt54_nano",
  "generation_model": "gpt54",
  "rare_user_prompt": ""
}

{
  "message": "text",
  "task_id": "text"
}

RAREをキャンセル

post

/webapi/v2/rare/cancel

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

application/json

messagestringRequired

task_idstringRequired

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/rare/cancel

POST /webapi/v2/rare/cancel HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "task_id": "text"
}

RARE結果一覧

get

/webapi/v2/rare/results

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

application/json

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/rare/results

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

{
  "results": [
    {
      "id": "text",
      "created_at": "text",
      "n_samples": 1,
      "rare_config": "text",
      "result_file_url": "text"
    }
  ]
}

RARE結果を削除

delete

/webapi/v2/rare/results/{result_id}

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Path parameters

result_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

delete/webapi/v2/rare/results/{result_id}

DELETE /webapi/v2/rare/results/{result_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

RARE CSV

get

/webapi/v2/rare/csv

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Query parameters

pathstringOptionalDefault: ""

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/rare/csv

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

No content

バルク処理を実行

post

/webapi/v2/bulk_processing/run

バルク処理（GAまたはRAG）を開始します。

引数: file: question, model, search_typeの列を含むCSVファイル。オプション: target_answer, target_clue, hashtag, folder。 bulk_type: "ga"（デフォルト）または "rag"

Authorizations

API-KEYstringRequired

認証用のAPIキー

Query parameters

bulk_typestring · enumOptionalDefault: gaPossible values:

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

filestring · binaryRequired

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/bulk_processing/run

POST /webapi/v2/bulk_processing/run HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

No content

結果一覧

get

/webapi/v2/bulk_processing/results

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Query parameters

pageintegerOptionalDefault: 1

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/bulk_processing/results

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

No content

結果をダウンロード

get

/webapi/v2/bulk_processing/download

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Query parameters

file_urlstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/bulk_processing/download

GET /webapi/v2/bulk_processing/download?file_url=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

結果を削除

delete

/webapi/v2/bulk_processing/results/{result_id}

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Path parameters

result_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

delete/webapi/v2/bulk_processing/results/{result_id}

DELETE /webapi/v2/bulk_processing/results/{result_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

回答生成

post

/webapi/generative_answer

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

querystringOptional

クエリ(質問文)

modelstringOptional

回答生成に利用するプロンプトを指定。デフォルトモデルはGPT4o。利用可能なオプションについてはドキュメントをご参照ください。

answerFormatstringOptional

応答のフォーマットを決定します。指定できる値はDRAFTJSまたはMARKDOWNです。デフォルトのフォーマットはDRAFTJSです。

isStatefulbooleanOptional

フォローアップ質問を使用するには、以前の会話履歴が必要です。会話履歴はthreadIdによって管理されます。isStatefulオプションをTrueに設定し、threadIdを入力すると、クエリは以前の会話履歴を参照して書き換えられます。デフォルトはFalseです。

threadIdstring · uuidOptional

threadIdはisStatefulがTrueの場合に使用されます。最初に会話を開始するときは、空のまま送信し、次のクエリ以降は出力からのthreadIdを使用して送信します。最初からthreadIdを設定したい場合は、UUIDとして記入し送信します。例: UUID - 36e7bb2b-1063-47ec-。デフォルト = None。

promptGroupIdstringOptional

回答生成に使用するプロジェクトのグループプロンプトを選択します。この設定は、デフォルトで準備されたグループプロンプトから変更を行い利用している場合などに有効です。 IDはプロジェクト設定>プロンプト管理>回答生成タブの選択します。使用するグループプロンプトを選択した際に表示されるURLからIDが確認できます。例:https://app.alli.ai/projects/UHJvamVjdDo2NDljYTRjZDMzMGY2MDZkYWRjOPOjNjE=/settings/prompt-management/generative-answer/groups/TExNUHJvbXB0R3JvdXA6NjUzNzc3MzA5GHUyMGE2ZjlhM2Q5OTIw

modestringOptional

'データをsyncかstreamのどちらで出力するか設定します。(Default = sync) streamモードの場合、syncと同じ出力形式のjson文字列がstreamとして出力されます。

clueTextbooleanOptional

clueTextはclues=Trueの時に利用できるオプションです。 clueに用いたドキュメントのテキスト情報を含めるかどうか設定できます。(Default = False)

cluesbooleanOptional

回答を生成するために使用されたclueを出力に含めるかどうか設定できます。(Default = False)

includeCitationsbooleanOptional

回答に詳細な引用情報を含めるかの有無。回答の生成に使用されたソース文書を参照します。デフォルトはFalseです。

search_fromstring[]Optional

回答生成時に検索するソースデータの範囲を指定します。現在使用可能な値は、web、qna、document、およびリスト形式でのデータ入力です。例：["web", "qna"]

temperaturenumberOptional

出力のランダム性を制御します。値が高いほど、出力はよりランダムになります。デフォルト = 0。

knowledgeBaseIdsstring[]Optional

検索を特定のナレッジベースノード(ドキュメントやフォルダ)IDに限定します。

folderIdsstring[]Optional

検索を特定のドキュメントフォルダーIDに限定します。

Responses

200

回答が生成されました

application/json

answerobjectOptional

にアップロードされたドキュメントから生成された回答内容。answerFormatパラメータに従ってフォーマットされています。

answerHashstringOptional

フィードバックを提供またはキャンセルするための回答を特定するために使用されます。

confidencenumberOptional

AIモデルからの信頼度を示しています。0と1の間の数値として表示されます。

effectiveConfidencenumberOptional

クエリ結果にフィードバックを提供すると、それが自動的にAIモデルをトレーニングします。効果的な信頼度は、これらのユーザーとエージェントのフィードバックで調整されたスコアです。0から1の数値として表示されます。

documentIdstringOptional

回答生成に利用したドキュメントのID。

documentNamestringOptional

回答生成に利用したドキュメントの名前。

hashtagsarrayOptional

ドキュメントに付けられたハッシュタグ。

pageNointegerOptional

回答生成に利用したドキュメントのページ番号。

createdDatestring · dateOptional

ドキュメントがアップロードされた日付。

agentFeedbackobjectOptional

このドキュメントに関するエージェントからのフィードバック(ダッシュボードおよびRESTコールを通じて行われたフィードバック)。

userFeedbackobjectOptional

このドキュメントに関するユーザーからのフィードバック。

bodystringOptional

リクエストでreturnPreviewがtrueの場合、ドキュメント検索プレビューのHTMLボディが表示されます。

cssstringOptional

リクエストでreturnPreviewがtrueの場合、ドキュメント検索プレビューのCSSが表示されます。

pdfPreviewstringOptional

リクエストでreturnPdfPreviewがtrueの場合、回答がハイライトされたドキュメントのPDFプレビューへのURLが表示されます。URLは、ダウンロードIP許可リスト設定を使用して制限することができる点に注意してください。

folderstringOptional

ドキュメントデータベース内のフォルダから見つかった場合、フォルダ名が記載されます。

editorstring[]Optional

ドキュメントに編集者アクセスを持つエージェントのメールのリスト。

viewerstring[]Optional

ドキュメントの閲覧アクセス権を持つエージェントのメールのリスト。

threadIdstringOptional

isStatefulがtrueの場合にフォローアップクエスチョンに使用できるUUID。

fuQuestionstringOptional

isStatefulがtrueの場合、ユーザーへの推奨フォローアップ質問。

intentstringOptional

クエリの検出されたインテント。

cluesarrayOptional

リクエストで手がかりが真の場合、回答を生成するために使用されたソースがここに返されます。

400

不正なリクエスト

application/json

401

無許可

application/json

403

Access denied. The project is inactive or the request IP is not allowed.

429

レート制限を超えました。

application/json

500

Internal server error.

post/webapi/generative_answer

POST /webapi/generative_answer HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 609

{
  "query": "text",
  "model": "text",
  "answerFormat": "text",
  "isStateful": true,
  "threadId": "123e4567-e89b-12d3-a456-426614174000",
  "promptGroupId": "text",
  "mode": "text",
  "clueText": true,
  "clues": true,
  "includeCitations": true,
  "hashtags": {
    "qnaInclude": [
      "text"
    ],
    "qnaIncludeOption": "or",
    "qnaExclude": [
      "text"
    ],
    "qnaExcludeOption": "or",
    "docsInclude": [
      "text"
    ],
    "docsIncludeOption": "or",
    "docsExclude": [
      "text"
    ],
    "docsExcludeOption": "or"
  },
  "search_from": [
    "text"
  ],
  "temperature": 1,
  "source": {
    "sharedKnowledgeBaseNodeIds": [
      "text"
    ],
    "personalKnowledgeBaseNodeIds": [
      "text"
    ],
    "webSites": [
      "text"
    ]
  },
  "knowledgeBaseIds": [
    "text"
  ],
  "folderIds": [
    "text"
  ]
}

{
  "answer": {},
  "answerHash": "text",
  "confidence": 1,
  "effectiveConfidence": 1,
  "documentId": "text",
  "documentName": "text",
  "hashtags": [],
  "pageNo": 1,
  "createdDate": "2026-07-22",
  "agentFeedback": {},
  "userFeedback": {},
  "body": "text",
  "css": "text",
  "pdfPreview": "text",
  "folder": "text",
  "editor": [
    "text"
  ],
  "viewer": [
    "text"
  ],
  "threadId": "text",
  "fuQuestion": "text",
  "intent": "text",
  "clues": [],
  "citations": [
    {
      "index": 1,
      "clueId": "text",
      "source": "text",
      "title": "text",
      "pageNo": 1,
      "knowledgeBaseId": "text",
      "faqId": "text",
      "url": "text",
      "text": "text"
    }
  ]
}

Alli Retrieval API

post

/webapi/retrieval

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

Authorizations

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

questionstringOptional

ドキュメントベースで検索する質問

maxDocumentCluesintegerOptional

関連ページを取得する数を決定します。デフォルト値は3です。

bm25_score_weightnumber · floatOptional

これはキーワード検索の重みです。この値が高いほど、キーワードスコアがより反映されます。0から9の間の値が適切であり、値が0の場合はキーワード検索が使用されないことを意味します。デフォルト値は9です。

text_vector_score_weightnumber · floatOptional

これは文書内容に対するセマンティック検索の重みです。この値が高いほど、より多く反映されます。0から9の値が適切で、値が0の場合は文書内容に対するセマンティック検索が使用されません。デフォルト値は1です。

title_vector_score_weightnumber · floatOptional

これは文書タイトルに対するセマンティック検索の重みです。同様に、0から9の間の値が適切であり、値が0の場合は文書タイトルに対するセマンティック検索が使用されないことを意味します。デフォルト値は0です。

hashtagsstring[]Optional

これらのハッシュタグが含まれるドキュメントのみ結果をフィルタリングしてください

hashtags_operatorstring · enumOptional

ハッシュタグの論理演算子(デフォルトは「または」)

Possible values:

exclude_hashtagsstring[]Optional

これらのハッシュタグを含むドキュメントを除外するために結果をフィルタリングしてください。

exclude_hashtags_operatorstring · enumOptional

除外ハッシュタグの論理演算子(デフォルトは「または」)

Possible values:

targetFoldersstring[]Optional

検索対象フォルダ名

folderIdsstring[]Optional

検索対象のフォルダーのID

knowledgeBaseIdsstring[]Optional

特定のナレッジベース内を検索するためのID

use_keywordsbooleanOptional

検索のためのキーワードを抽出して使用するかどうか

use_clue_feedbackbooleanOptional

検索結果を改善するためにフィードバックデータを使用するかどうか

use_rerankerbooleanOptional

Overrides the project's cognitive_config.use_reranker for this request. When omitted, the project config value is used.

reranker_candidates_numintegerOptional

Overrides the number of candidate pages passed to the reranker. Only effective when reranking is enabled. Defaults to 16 when omitted.

reranker_max_tokensintegerOptional

Overrides the maximum token length per candidate sent to the reranker. Only effective when reranking is enabled. Defaults to 1024 when omitted.

Responses

200

結果を正常に取得しました

application/json

400

無効なパラメーター

application/json

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

内部サーバーエラー

application/json

post/webapi/retrieval

POST /webapi/retrieval HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 420

{
  "question": "text",
  "maxDocumentClues": 1,
  "bm25_score_weight": 1,
  "text_vector_score_weight": 1,
  "title_vector_score_weight": 1,
  "hashtags": [
    "text"
  ],
  "hashtags_operator": "and",
  "exclude_hashtags": [
    "text"
  ],
  "exclude_hashtags_operator": "and",
  "targetFolders": [
    "text"
  ],
  "folderIds": [
    "text"
  ],
  "knowledgeBaseIds": [
    "text"
  ],
  "use_keywords": true,
  "use_clue_feedback": true,
  "use_reranker": true,
  "reranker_candidates_num": 1,
  "reranker_max_tokens": 1
}

{
  "result": [
    {
      "ranking": 1,
      "title": "text",
      "text": "text",
      "pageNo": 1,
      "kb_id": "text"
    }
  ]
}

PreviousKnowledge Base NextApp Market

Last updated 14 days ago