Newer Version Available

This content describes an older version of this product. View Latest

AIUsecaseFieldMapping

Represents information about the field mapping that’s used to save extracted features, prediction scores, insights about the predictions, and suggestions to improve the prediction scores. This object is available in API version 55.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

The AIUsecaseFieldMapping object is available when the admin settings for AI Accelerator and for the product related to the use case are enabled. The Salesforce org must have the CRM Plus license and the product’s CRM license.

Fields

Field Details
AiUsecaseDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Required. The ID of the use case definition that’s related to the field mapping.
This field is a relationship field.
Relationship Name
AiUsecaseDefinition
Relationship Type
Lookup
Refers To
AIUsecaseDefinition
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The developer name of the use case field mapping.
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The languages supported by the use case field mapping.
Possible values are:
  • da—Danish
  • de—German
  • en_US—English
  • es—Spanish
  • es_MX—Spanish (Mexico)
  • fi—Finnish
  • fr—French
  • it—Italian
  • ja—Japanese
  • ko—Korean
  • nl_NL—Dutch
  • no—Norwegian
  • pt_BR—Portuguese (Brazil)
  • ru—Russian
  • sv—Swedish
  • th—Thai
  • zh_CN—Chinese (Simplified)
  • zh_TW—Chinese (Traditional)
MappedFieldName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The name of the field where the scoring response is stored.
MappedFieldType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. Specifies the type of the mapped field.
Possible values are:
  • FEATURE
  • INSIGHT
  • PREDICTION_SCORE
  • SUGGESTION
The default value is FEATURE.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The label of the use case field mapping.
ResponseFieldName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The name of the response object’s field that’s mapped to the field storing the scoring response.
ResponseObject
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The object whose field is mapped to the field storing the scoring response. It’s either the PrimaryResponseObject or the SecondaryResponseObject specified in the AIUsecaseDefinition object.
SequenceNumber
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The sequence number for the information stored in the field mapping.

Usage

Use this object to define the mapping logic for saving extracted features, prediction scores, insights about the predictions, and suggestions to improve the prediction scores. Map the fields of the primary and secondary response objects, that are specified in the AIUsecaseDefinition object, with the fields that are storing these values.