Consumer Goods Cloud Developer Guide

Consumer Goods Standard Objects
Sync Management Custom Objects
Retail Execution Custom Objects
Trade Promotion Management Custom Objects
Custom Objects for Retail Execution and Trade Promotion Management
Custom Objects for Future Use
Consumer Goods Cloud Associated Objects
Consumer Goods Metadata APIs
Consumer Goods Business APIs
Einstein Object Detection Standard Objects
AiDataset
AiImageDetectedObject
AiImageTrainingObject
AiVisionModel
AiVisionModelMetric
AiVisionModelObjectMetric
Image
Einstein Object Detection REST APIs
Einstein Visit Recommendation Standard Objects
Einstein Visit Recommendation Recommendation Associated Objects
Einstein Visit Recommendation Recommendation Actions
Einstein Visit Activity Recommendation Standard Objects
Einstein Visit Task Recommendation Associated Objects
API End-of-Life
PDF

Newer Version Available

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

AiVisionModel

Represents model used to detect objects in images. This object is available in API version 47.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AiDatasetId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unique identifier of the dataset used to build the model.
ErrorMessage
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Details of why the model didn’t built. This field is available in API v49.0 and later.
ExternalModel
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unique identifier generated by external machine-learning service for the model.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the model is enabled or disabled. The default value is false. This field is available in API versions 48.0 and later.
IterationCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Count of the iterations used to build the neural network. The valid values are between 1 and 1,000. This field is optional.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed this record.
LearningRate
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Rate at which a model is built or updated. The valid rates are between 0.0001 and 0.01.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the model.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Unique identifier of the record owner.
Progress
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Percentage of building completed for the model.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Status of the model. The default value is QUEUED
Possible values are:
  • DATASET_UPDATING
  • FAILED
  • QUEUED
  • RETRAIN_FAILED
  • RETRAIN_QUEUED
  • RETRAIN_RUNNING
  • RUNNING
  • SUCCEEDED
TrainingParameters
Type
textarea
Properties
Create, Nillable, Update
Description
A JSON file containing the parameters that govern how the model is created.
TrainingStatistics
Type
textarea
Properties
Create, Nillable, Update
Description
Statistics generated after model is trained successfully or if the training has failed.
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Type of data that’s used to build or update the model.

Only Images is supported in API version 47.0.

Note