Generate Relationship Insights Input

Input representation that contains the information required to generate relationship insights for a Salesforce record.

JSON Example

1{
2  "targetRecordId": "006xx0000001234AAA",
3  "targetObject": "Opportunity",
4  "useCaseApiName": "RRA_Default",
5  "regenerationMode": "REFRESH_IF_EXPIRED",
6  "generationOptions": {
7    "useDeepWebSearch": true,
8    "useRecordContext": true,
9    "generateSyntheticData": false
10  },
11  "maxRelationships": 12,
12  "requestMetadata": {
13    "clientId": "RRA_LAB_Component",
14    "correlationId": "f5a5c8c4-1234-5678-9abc-001122334455"
15  }
16}

Properties

Name	Type	Description	Required or Optional	Available Version
`generationOptions`	Generation Options Input[]	Optional settings that influence data sources and generation behavior, such as enabling deep web search, using record context, or generating synthetic data for demonstrations.	Optional	67.0
`maxRelationships`	Integer	Maximum number of relationships to retain in the generated insight graph. If not specified, the value defaults to the Relationship Research Agent configuration, for example, MAX_REL_PER_INSIGHT.	Optional	67.0
`regenerationMode`	String	Regeneration strategy for relationship insights. Possible values include ALWAYS_REGENERATE, REFRESH_IF_EXPIRED, and REUSE_IF_FRESH. This setting controls whether an existing insight is reused or regenerated.	Optional	67.0
`requestMetadata`	Map<String, Object>	Additional diagnostic or routing metadata, such as clientId or correlationId, used for observability, tracing, and debugging.	Optional	67.0
`targetObject`	String	API name of the target SObject type, such as Opportunity. If not provided, the value is derived from targetRecordId.	Optional	67.0
`targetRecordId`	String	Salesforce record ID for which relationship insights must be generated. For example, Opportunity, Account, Contact.	Required	67.0
`useCaseApiId`	String	ID of the relationship research insight use case applied during insight generation.	Optional	67.0
`useCaseApiName`	String	API name of the Relationship Research Agent use case configuration to apply. This value maps to the Template Config Definition in SDB. If not provided, the default org-level or object-level Relationship Research Agent configuration is used.	Optional	67.0