afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/GenAiFunctionDefinition.json

80 lines
3.0 KiB
JSON

{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields"
],
"title": "GenAiFunctionDefinition - Tooling API",
"description": "Represents an agent action. This object is available in API version 60.0 and later.",
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
"supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Description": {
"type": "textarea",
"properties": "Nillable",
"description": "A description explaining the general purpose and domain of the action."
},
"DeveloperName": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "The unique name for this object."
},
"FullName": {
"type": "string",
"properties": "Create, Group, Nillable",
"description": "The full name of the associated object in Metadata API. The full name can include a namespace prefix."
},
"InvocationTarget": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "Target invocation used by invocation operations."
},
"InvocationTargetType": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "Invocable action types used by invocation operations. Possible values are: apex flow generatePromptResponse"
},
"IsConfirmationRequired": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether confirmation is required for this action. The default value is false."
},
"IsIncludeInProgressIndicator": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the ProgressIndicatorMessage is displayed."
},
"Language": {
"type": "picklist",
"properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The language of the GenAiFunctionDefinition. The value for this field is the language value of the org."
},
"MasterLabel": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "The master label for the generative AI action."
},
"Metadata": {
"type": "complexvalue",
"properties": "Create, Nillable, Update",
"description": "Provides access to the associated type."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace of the GenAiFunctionDefinition."
},
"ProgressIndicatorMessage": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "Message displayed when an action is taking longer than expected to execute."
}
}
}