activity (generateTextWithAi)

Parent: activity

Applies whentype = generateTextWithAi

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
Enter a name for the workflow activity.
typeenumYesdata type=string; lov=PLUGINS
Valid values: generateTextWithAi

Property Groups:

  • inputValue
  • useResponse
  • genAI
  • source
  • additionalData
  • deadline
  • layout
  • parallelFlow
  • advanced
  • comments
inputValue
PropertyTypeRequiredDefault ValueDetails
typeenumYesitemdata type=string; maxLen=4000; lov=STATIC
Valid values: expression onlySystemPrompt item sqlQuery functionBody
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies wheninput_value_type = ITEM
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql js-mle
Applies wheninput_value_type = EXPRESSION
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql js-mle
Applies wheninput_value_type = FUNCTION_BODY
plsqlExpressionstringYesdata type=string; maxLen=4000
Applies wheninput_value_type = EXPRESSION and input_value_expression_language = PLSQL
jsExpressionstringYesdata type=string; maxLen=4000
Applies wheninput_value_type = EXPRESSION and input_value_expression_language = JAVASCRIPT
plsqlFunctionBodystringYesdata type=string; maxLen=4000
Applies wheninput_value_type = FUNCTION_BODY and input_value_function_body_language = PLSQL
jsFunctionBodystringYesdata type=string; maxLen=4000
Applies wheninput_value_type = FUNCTION_BODY and input_value_function_body_language = JAVASCRIPT
sqlQuerystringYesdata type=string; maxLen=4000
Applies wheninput_value_type = SQL_QUERY
maxTokensintegerNodata type=integer
Applies wheninput_value_type = SQL_QUERY
inputValue {
  type: expression
  item: value
  language: plsql
  plsqlExpression: value
  jsExpression: value
  plsqlFunctionBody: value
  jsFunctionBody: value
  sqlQuery: value
  maxTokens: 42
}
useResponse
PropertyTypeRequiredDefault ValueDetails
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
useResponse {
  item: value
}
genAI
PropertyTypeRequiredDefault ValueDetails
enabledbooleanYesfalsedata type=boolean
agentreferenceNodata type=reference; lov=COMPONENT; references=aiAgent
Applies whenenabled = true
servicereferenceNodata type=reference; lov=COMPONENT; references=genAIService
Applies whenenabled = true
systemPromptmultiline stringNodata type=multiline string; maxLen=32767
Applies whenenabled = true
genAI {
  enabled: false
  agent: @component
  service: @component
  systemPrompt: ```
    value
  ```
}
source
PropertyTypeRequiredDefault ValueDetails
locationenumYeslocalDatabasedata type=string; lov=STATIC
Valid values: localDatabase restEnabledSql
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whenlocation = localDatabase
plsqlCodemultiline stringYesdata type=multiline string; maxLen=32767
Applies whenlocation = localDatabase and language = plsql
javaScriptCodemultiline stringYesdata type=multiline string; maxLen=32767
Applies whenlocation = localDatabase and language = javaScript-mle
remoteServerreferenceYesdata type=reference; lov=COMPONENT; references=restEnabledSqlDatabase
Applies whenlocation = restEnabledSql
plsqlCodemultiline stringYesdata type=multiline string; maxLen=32767
Applies whenlocation = restEnabledSql
Enter the PL/SQL code to be executed on the remote database.
source {
  location: localDatabase
  language: plsql
  plsqlCode: ```plsql
    value
  ```
  javaScriptCode: ```javascript-mle
    value
  ```
  remoteServer: @component
}
additionalData
PropertyTypeRequiredDefault ValueDetails
sqlQuerymultiline stringNodata type=multiline string; maxLen=4000

Enter a SQL query to read additional data.

The column names of the query can be used as bind variables and substitution strings to evaluate conditions or activity variables during the execution of the activity.

The result of the query should contain only one row.

If the query returns no result or more than one row then the activity fails during execution.

additionalData {
  sqlQuery: ```sql
    value
  ```
}
deadline
PropertyTypeRequiredDefault ValueDetails
dueOnTypeenumNodata type=string; lov=STATIC
Valid values: interval sqlQuery expression functionBody schedulerExpression
intervalstringYesdata type=string; maxLen=255
Applies whendueOnType = interval
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whendueOnType = sqlQuery
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whendueOnType = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whendueOnType = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whendueOnType = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whendueOnType = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whendueOnType = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whendueOnType = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whendueOnType = functionBody and language = javaScript-mle
schedulerExpressionmultiline stringYesdata type=multiline string; maxLen=255
Applies whendueOnType = schedulerExpression
deadline {
  dueOnType: interval
  interval: value
  sqlQuery: ```sql
    value
  ```
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  schedulerExpression: ```
    value
  ```
}
layout
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
layout {
  sequence: 42
}
parallelFlow
PropertyTypeRequiredDefault ValueDetails
branchreferenceNodata type=reference; lov=COMPONENT; references=branch
parallelFlow {
  branch: @component
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
labelstringNodata type=string; maxLen=4000
diagramstringNodata type=string; maxLen=32767
advanced {
  staticId: value
  label: value
  diagram: value
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

activity sample (
    name: value
    type: generateTextWithAi
    inputValue {
        type: expression
        item: value
        language: plsql
        plsqlExpression: value
        jsExpression: value
        plsqlFunctionBody: value
        jsFunctionBody: value
        sqlQuery: value
        maxTokens: 42
    }
    useResponse {
        item: value
    }
    genAI {
        enabled: false
        agent: @component
        service: @component
        systemPrompt: ```
          value
        ```
    }
    source {
        location: localDatabase
        language: plsql
        plsqlCode: ```plsql
          value
        ```
        javaScriptCode: ```javascript-mle
          value
        ```
        remoteServer: @component
    }
    additionalData {
        sqlQuery: ```sql
          value
        ```
    }
    deadline {
        dueOnType: interval
        interval: value
        sqlQuery: ```sql
          value
        ```
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        schedulerExpression: ```
          value
        ```
    }
    layout {
        sequence: 42
    }
    parallelFlow {
        branch: @component
    }
    advanced {
        staticId: value
        label: value
        diagram: value
    }
    comments {
        comments: ```
          value
        ```
    }
)