「Essbaseに質問」とのチャット
get
/essbase/rest/v1/ai/aiconnection/{aiConnectionName}/vectorindex/{vectorIndexName}/narrate/{profileName}
「Essbaseに質問」機能と対話するためのAIプロンプト。
リクエスト
サポートされているメディア・タイプ
- text/plain
パス・パラメータ
- aiConnectionName(required): string
AI接続名。
- profileName(required): string
「Essbaseに質問」のチャット・プロファイル名。
- vectorIndexName(required): string
ベクトル索引名。
問合せパラメータ
- docDirName(required): string
ドキュメント・ポインタ・ファイルが保持されるOCIオブジェクト・ストレージ・ディレクトリの名前。
- isConvStart(required): boolean
会話が開始されているかどうかをチェックします。
- prompt(required): string
AIプロンプト。
レスポンス
サポートされているメディア・タイプ
- application/json
- application/xml
200 レスポンス
OK
AI解説に成功しました。
400 レスポンス
不正なリクエスト
AI解説の実行に失敗しました。
例
次の例では、cURLでWindowsシェル・スクリプトからREST APIにアクセスして「Essbaseに質問」との対話を開始する方法を示します。
この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。
cURLコマンドを含むスクリプト
call properties.bat
curl -X GET -H "accept:application/json" "https://myserver.example.com:9001/essbase/rest/v1/ai/aiconnection/PHX-241080-GENAI/vectorindex/ASKESSBASE_VECTOR_INDEX_1760603912611/narrate/Chat1?docDirName=ASKESSBASE_DOC_1760603912611&prompt=what%20is%20mdx%3F&isConvStart=true" -u %User%:%Password%レスポンス本体の例
次の例では、レスポンス本体の内容をJSON形式で示します。
{
"MDX (Multidimensional Expressions) is a query language for multidimensional databases that can be used to analyze and extract Essbase data and metadata, define formulas on aggregate storage cubes, and more. It provides advanced data extraction and reporting capabilities, includes functions for identifying and manipulating specific subsets of data, and is a data-manipulation language that complements MaxL, a data-definition language for Essbase.\n\nMDX is used for:\n- Querying and reporting against data and metadata in Essbase cubes\n- Inserting data into an Essbase cube\n- Exporting data from an Essbase cube\n\nIt exhibits the following characteristics:\n1. Provides advanced data extraction capability.\n2. Provides advanced reporting capability.\n3. Includes functions for identifying and manipulating very specific subsets of data.\n4. Is a data-manipulation language, complementing MaxL (a data-definition language for Essbase).\n5. Utilizes the platform-independent XML for Analysis specification.\n\n"
}