RAG
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
成功
回答タイプ
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
1OK
回答タイプ
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
""""Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Koreangpt54_nano0.51256100OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
1050102Koreangpt54_nanogpt54""OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
No content
認証用のAPIキー
""任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
No content
認証用のAPIキー
gaPossible values: 任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
No content
認証用のAPIキー
1任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
No content
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
No content
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
No content
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
クエリ(質問文)
回答生成に利用するプロンプトを指定。デフォルトモデルはGPT4o。利用可能なオプションについてはドキュメントをご参照ください。
応答のフォーマットを決定します。指定できる値はDRAFTJSまたはMARKDOWNです。デフォルトのフォーマットはDRAFTJSです。
フォローアップ質問を使用するには、以前の会話履歴が必要です。会話履歴はthreadIdによって管理されます。isStatefulオプションをTrueに設定し、threadIdを入力すると、クエリは以前の会話履歴を参照して書き換えられます。デフォルトはFalseです。
threadIdはisStatefulがTrueの場合に使用されます。最初に会話を開始するときは、空のまま送信し、次のクエリ以降は出力からのthreadIdを使用して送信します。最初からthreadIdを設定したい場合は、UUIDとして記入し送信します。例: UUID - 36e7bb2b-1063-47ec-。デフォルト = None。
回答生成に使用するプロジェクトのグループプロンプトを選択します。この設定は、デフォルトで準備されたグループプロンプトから変更を行い利用している場合などに有効です。 IDはプロジェクト設定>プロンプト管理>回答生成タブの選択します。使用するグループプロンプトを選択した際に表示されるURLからIDが確認できます。 例:https://app.alli.ai/projects/UHJvamVjdDo2NDljYTRjZDMzMGY2MDZkYWRjOPOjNjE=/settings/prompt-management/generative-answer/groups/TExNUHJvbXB0R3JvdXA6NjUzNzc3MzA5GHUyMGE2ZjlhM2Q5OTIw
'データをsyncかstreamのどちらで出力するか設定します。(Default = sync) streamモードの場合、syncと同じ出力形式のjson文字列がstreamとして出力されます。
clueTextはclues=Trueの時に利用できるオプションです。 clueに用いたドキュメントのテキスト情報を含めるかどうか設定できます。(Default = False)
回答を生成するために使用されたclueを出力に含めるかどうか設定できます。(Default = False)
回答に詳細な引用情報を含めるかの有無。回答の生成に使用されたソース文書を参照します。デフォルトはFalseです。
回答生成時に検索するソース データの範囲を指定します。現在使用可能な値は、web、qna、document、およびリスト形式でのデータ入力です。 例:["web", "qna"]
出力のランダム性を制御します。値が高いほど、出力はよりランダムになります。デフォルト = 0。
検索を特定のナレッジベースノード(ドキュメントやフォルダ)IDに限定します。
検索を特定のドキュメントフォルダーIDに限定します。
回答が生成されました
にアップロードされたドキュメントから生成された回答内容。answerFormatパラメータに従ってフォーマットされています。
フィードバックを提供またはキャンセルするための回答を特定するために使用されます。
AIモデルからの信頼度を示しています。0と1の間の数値として表示されます。
クエリ結果にフィードバックを提供すると、それが自動的にAIモデルをトレーニングします。効果的な信頼度は、これらのユーザーとエージェントのフィードバックで調整されたスコアです。0から1の数値として表示されます。
回答生成に利用したドキュメントのID。
回答生成に利用したドキュメントの名前。
ドキュメントに付けられたハッシュタグ。
回答生成に利用したドキュメントのページ番号。
ドキュメントがアップロードされた日付。
このドキュメントに関するエージェントからのフィードバック(ダッシュボードおよびRESTコールを通じて行われたフィードバック)。
このドキュメントに関するユーザーからのフィードバック。
リクエストでreturnPreviewがtrueの場合、ドキュメント検索プレビューのHTMLボディが表示されます。
リクエストでreturnPreviewがtrueの場合、ドキュメント検索プレビューのCSSが表示されます。
リクエストでreturnPdfPreviewがtrueの場合、回答がハイライトされたドキュメントのPDFプレビューへのURLが表示されます。URLは、ダウンロードIP許可リスト設定を使用して制限することができる点に注意してください。
ドキュメントデータベース内のフォルダから見つかった場合、フォルダ名が記載されます。
ドキュメントに編集者アクセスを持つエージェントのメールのリスト。
ドキュメントの閲覧アクセス権を持つエージェントのメールのリスト。
isStatefulがtrueの場合にフォローアップクエスチョンに使用できるUUID。
isStatefulがtrueの場合、ユーザーへの推奨フォローアップ質問。
クエリの検出されたインテント。
リクエストで手がかりが真の場合、回答を生成するために使用されたソースがここに返されます。
不正なリクエスト
無許可
Access denied. The project is inactive or the request IP is not allowed.
レート制限を超えました。
Internal server error.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ドキュメントベースで検索する質問
関連ページを取得する数を決定します。デフォルト値は3です。
これはキーワード検索の重みです。この値が高いほど、キーワードスコアがより反映されます。0から9の間の値が適切であり、値が0の場合はキーワード検索が使用されないことを意味します。デフォルト値は9です。
これは文書内容に対するセマンティック検索の重みです。この値が高いほど、より多く反映されます。0から9の値が適切で、値が0の場合は文書内容に対するセマンティック検索が使用されません。デフォルト値は1です。
これは文書タイトルに対するセマンティック検索の重みです。同様に、0から9の間の値が適切であり、値が0の場合は文書タイトルに対するセマンティック検索が使用されないことを意味します。デフォルト値は0です。
これらのハッシュタグが含まれるドキュメントのみ結果をフィルタリングしてください
ハッシュタグの論理演算子(デフォルトは「または」)
これらのハッシュタグを含むドキュメントを除外するために結果をフィルタリングしてください。
除外ハッシュタグの論理演算子(デフォルトは「または」)
検索対象フォルダ名
検索対象のフォルダーのID
特定のナレッジベース内を検索するためのID
検索のためのキーワードを抽出して使用するかどうか
検索結果を改善するためにフィードバックデータを使用するかどうか
Overrides the project's cognitive_config.use_reranker for this request. When omitted, the project config value is used.
Overrides the number of candidate pages passed to the reranker. Only effective when reranking is enabled. Defaults to 16 when omitted.
Overrides the maximum token length per candidate sent to the reranker. Only effective when reranking is enabled. Defaults to 1024 when omitted.
結果を正常に取得しました
無効なパラメーター
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
内部サーバーエラー
Last updated