Jump to

• Request
• Response
• Examples

Chat with Ask Essbase

get

/essbase/rest/v1/ai/aiconnection/{aiConnectionName}/vectorindex/{vectorIndexName}/narrate/{profileName}

The AI prompt to interact with the Ask Essbase feature.

Request

Supported Media Types

• text/plain

Path Parameters

• aiConnectionName(required): string

  AI connection name.

• profileName(required): string

  Ask Essbase chat profile name.

• vectorIndexName(required): string

  Vector index name.

Query Parameters

• docDirName(required): string

  Name of the OCI object storage directory where documentation pointer files are kept.

• isConvStart(required): boolean

  Checks if the conversation is started or not.

• prompt(required): string

  The AI prompt.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

AI Narrate successful.

400 Response

Bad Request

Failed to perform AI Narrate.

Back to Top

Examples

The following example shows how to start interaction with Ask Essbase, using cURL to access the REST API from a Windows shell script.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

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%

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "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"
}

Back to Top