This is an automated email from the ASF dual-hosted git repository. stigahuang pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/impala.git
commit 37aa22a3429627e001eb575d71c7cc22c6979e86 Author: zhangyifan27 <[email protected]> AuthorDate: Tue Dec 30 21:34:52 2025 +0800 IMPALA-14649: Document impala_options parameter for AI functions Added documentation for impala_options parameter in ai_generate_text, including credential_type, api_standard, and payload configuration options. Change-Id: Ia0abd26215a3af274fdb0bb723780ab9a3036d31 Reviewed-on: http://gerrit.cloudera.org:8080/23813 Tested-by: Impala Public Jenkins <[email protected]> Reviewed-by: Peter Rozsa <[email protected]> --- docs/topics/impala_ai_functions.xml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/topics/impala_ai_functions.xml b/docs/topics/impala_ai_functions.xml index 3b093e05f..4b0b3ecdf 100644 --- a/docs/topics/impala_ai_functions.xml +++ b/docs/topics/impala_ai_functions.xml @@ -92,7 +92,7 @@ under the License. </dlentry> <dlentry> <dt>AI_GENERATE_TEXT</dt> - <dd>Syntax:<codeblock id="codeblock_qdg_zn4_tbc">ai_generate_text(ai_endpoint, prompt, ai_model, ai_api_key_jceks_secret, additional_params) + <dd>Syntax:<codeblock id="codeblock_qdg_zn4_tbc">ai_generate_text(ai_endpoint, prompt, ai_model, ai_api_key_jceks_secret, additional_params, impala_options) </codeblock></dd> </dlentry> </dl> @@ -124,6 +124,21 @@ under the License. <codeph>core-site</codeph> configuration for both the executor and coordinator.</li> <li><b>additional_params</b>: Additional parameters that the AI API offers that is provided to the built-in function as a JSON object.</li> + <li><b>impala_options</b>: Optional JSON object that controls Impala-specific behavior for + the AI function. This parameter supports the following fields: + <ul> + <li><b>credential_type</b>: Specifies how the API key credential is provided. Valid + values are <codeph>"plain"</codeph> (use the credential as plain text) or + <codeph>"jceks"</codeph> (fetch the API key from JCEKS keystore). Default is + <codeph>"jceks"</codeph>.</li> + <li><b>api_standard</b>: Specifies the API standard to use. Currently only + <codeph>"openai"</codeph> is supported.</li> + <li><b>payload</b>: Custom payload string to send to the AI API instead of the + auto-generated payload. Maximum size is 5MB. When specified, this overrides the + default payload construction.</li> + </ul> + Example: <codeph>{"credential_type":"plain","api_standard":"openai"}</codeph> + </li> </ul> </section> <section id="impala-built-in-ai-function">
