aiAgent

Parent: app

Children: tool

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
Enter a name of the AI Agent.

Property Groups:

  • genAI
  • responseFormat
  • advanced
  • subscription
  • comments
genAI
PropertyTypeRequiredDefault ValueDetails
servicereferenceNodata type=reference; lov=COMPONENT; references=genAIService
systemPromptmultiline stringNodata type=multiline string; maxLen=32767
welcomeMessagemultiline stringNodata type=multiline string; maxLen=32767
 
genAI {
  service: @component
  systemPrompt: ```
    value
  ```
  welcomeMessage: ```html
    value
  ```
}
responseFormat
PropertyTypeRequiredDefault ValueDetails
typeenumYestextdata type=string; lov=STATIC
Valid values: text jsonObject
jsonSchemamultiline stringYesdata type=multiline string; maxLen=32767
Applies whentype = jsonObject
 
responseFormat {
  type: text
  jsonSchema: ```json
    value
  ```
}
advanced
PropertyTypeRequiredDefault ValueDetails
reasoningEffortenumNodata type=string; lov=STATIC
Valid values: none minimal low medium high xhigh max
temperaturenumberNodata type=number; maxLen=22
staticIdstringYesdata type=string; maxLen=255
Use the Static ID to reference the AI Agent in API Calls.
 
advanced {
  reasoningEffort: none
  temperature: 42
  staticId: value
}
subscription
PropertyTypeRequiredDefault ValueDetails
masterreferenceNodata type=reference; lov=COMPONENT; references=aiAgent
 
subscription {
  master: @component
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
 
comments {
  comments: ```
    value
  ```
}

APEXlang Example

aiAgent sample (
    name: value
    genAI {
        service: @component
        systemPrompt: ```
          value
        ```
        welcomeMessage: ```html
          value
        ```
    }
    responseFormat {
        type: text
        jsonSchema: ```json
          value
        ```
    }
    advanced {
        reasoningEffort: none
        temperature: 42
        staticId: value
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)