Einstein Platform Services

Release Notes

Find out what's new, changed, or deprecated in the Einstein Platform Services APIs.

December 12, 2019

NEW

Get More Detailed Error Messages for Einstein Object Detection Training API Calls. When you train an object detection dataset and the training process encounters an error, the API now returns more descriptive error messages. In most cases, the error message specifies the issue that caused the error and how to fix it.

How: The improved errors are returned for these API endpoints when the dataset type is image-detection.

  • Train a dataset—POST /v2/vision/train
  • Retrain a dataset—POST /v2/vision/retrain

November 21, 2019

NEW

Added Elements in Language API Model Metrics Response. New elements returned in the model metrics let you better understand the performance of your model. The response JSON for an Einstein Language API call that returns model metrics information contains three new elements: the macroF1 field, the precision array, and the recall array.

When: This change applies to all language models created after September 30, 2019. If you want to see these changes for models created
before that date, retrain the dataset and create a new model.

How: The new field and arrays appear in the response for these calls when the model type is text-intent or text-sentiment.

  • Get model metrics—GET /v2/language/models/<MODEL_ID>
  • Get model learning curve—GET /v2/language/models/<MODEL_ID>/lc

October 14, 2019

CHANGED

Text datasets can contain up to 3 million records. The maximum number of words in a text dataset is now 3 million. A text dataset is a dataset that has a type of text-intent or
text-sentiment.

How: You receive an error from the following calls when you train a text dataset that has more than 3 million words:

  • Train a dataset—POST /v2/language/datasets/train
  • Retrain a dataset—POST /v2/language/datasets/retrain

To avoid this error, be sure that when you create a dataset or add examples to a dataset, that it contains less than 3 million words across
all examples. For best results, we recommend that each example is around 100 words.

October 4, 2019

CHANGED

Object detection max image size increased. We increased the maximum size of an image you can add to an object detection dataset from 1 MB to 5 MB.

How: The new maximum image size applies to these calls when the dataset type is image-detection.

  • Create a dataset asynchronously—POST /v2/vision/datasets/upload
  • Create a dataset synchronously—POST /v2/vision/datasets/upload/sync
  • Create examples from a .zip file—PUT /v2/vision/datasets/<DATASET_ID>/upload
  • Create an example—POST /v2/vision/datasets/<DATASET_ID>/examples
  • Create a feedback example—POST /v2/vision/feedback
  • Create feedback examples from a .zip file—PUT /v2/vision/bulkfeedback

July 15, 2019

NEW

Intent API response JSON contains a new algorithm field. The response JSON for an Einstein Intent API call that returns model information now contains the algorithm field. The default return value is intent.

How: The algorithm field appears in the response for these calls when the dataset type or model type is text-intent.

  • Train a dataset—POST /v2/language/datasets/train
  • Retrain a dataset—POST /v2/language/datasets/retrain
  • Get training status—GET /v2/language/train/<MODEL_ID>
  • Get model metrics—GET /v2/language/models/<MODEL_ID>
  • Get all models for a dataset—GET /v2/language/datasets/<DATASET_ID>/models

July 3, 2019

NEW

API response JSON contains a new language field. The response JSON for an Einstein Vision API call that returns model information now contains the language field. When you train a dataset, the resulting model inherits the language of the dataset. For Einstein Vision datasets and models, the return value is N/A.

How: The language field appears in the response for these calls.

  • Train a dataset—POST /v2/vision/train
  • Retrain a dataset—POST /v2/vision/retrain
  • Get training status—GET /v2/vision/train/<MODEL_ID>
  • Get model metrics—GET /v2/vision/models/<MODEL_ID>
  • Get all models for a dataset—GET /v2/vision/datasets/<DATASET_ID>/models

NEW

API response JSON contains a new language field. The response JSON for an Einstein Language API call that returns model information now contains the language field. When you train a dataset, the resulting model inherits the language of the dataset. For Einstein Vision datasets and models, the return value is en_US.

How: The language field appears in the response for these calls.

  • Train a dataset—POST /v2/language/datasets/train
  • Retrain a dataset—POST /v2/language/datasets/retrain
  • Get training status—GET /v2/language/train/<MODEL_ID>
  • Get model metrics—GET /v2/language/models/<MODEL_ID>
  • Get all models for a dataset—GET /v2/language/datasets/<DATASET_ID>/models

NEW

Object Detection API response JSON contains a new algorithm field. The response JSON for an Einstein Vision API call that returns object detection model information now contains the algorithm field. The default return value is object-detection.

How: The algorithm field appears in the response for these calls when the dataset type or model type is image-detection.

  • Train a dataset—POST /v2/vision/train
  • Retrain a dataset—POST /v2/vision/retrain
  • Get training status—GET /v2/vision/train/<MODEL_ID>
  • Get model metrics—GET /v2/vision/models/<MODEL_ID>
  • Get all models for a dataset—GET /v2/vision/datasets/<DATASET_ID>/models

CHANGED

Einstein Language default language is now en-US. The default language changed to en_US from ENGLISH.

How: The language field now contains the value en_US in the response for these calls.

  • Create a dataset asynchronously—POST /v2/language/datasets/upload
  • Create a dataset synchronously—POST /v2/language/datasets/upload/sync
  • Get a dataset—GET /v2/language/datasets/<DATASET_ID>
  • Get all datasets—GET /v2/language/datasets
  • Create examples from a file—PUT /v2/language/datasets/<DATASET_ID>/upload

April 30, 2019

NEW

Einstein Vision and Language Model Builder just released. An AppExchange package that provides a UI for the Einstein Vision and Language deep learning APIs. You can easily create datasets, build models, and make predictions all right from Salesforce.

April 18, 2019

NEW

API response JSON contains a new numOfDuplicates field. The response JSON for any Einstein Vision API call that returns dataset information now includes the numOfDuplicates field. This field indicates the number of images not added to the dataset because they’re duplicates.

Why: When you create a dataset or add data to a dataset, duplicate images are omitted. The numOfDuplicates field appears in the response for these calls.

  • Create a dataset asynchronously—POST /v2/vision/datasets/upload
  • Create a dataset synchronously—POST /v2/vision/datasets/upload/sync
  • Create a dataset —POST /v2/vision/datasets
  • Get a dataset—GET /v2/vision/datasets/<DATASET_ID>
  • Get all datasets—GET /v2/vision/datasets
  • Create examples from a .zip file—PUT /v2/vision/datasets/<DATASET_ID>/upload
  • Create feedback examples from a .zip file—PUT /v2/vision/bulkfeedback

NEW

API response JSON contains a new numOfDuplicates field. The response JSON for any Einstein Language API call that returns dataset information now contains the numOfDuplicates field. This field indicates the number of text strings not added to the dataset because they’re duplicates.

Why: When you create a dataset or add data to a dataset, duplicate text strings are omitted. The language field appears in the response for these calls.

  • Create a dataset asynchronously—POST /v2/language/datasets/upload
  • Create a dataset synchronously—POST /v2/language/datasets/upload/sync
  • Get a dataset—GET /v2/language/datasets/<DATASET_ID>
  • Get all datasets—GET /v2/language/datasets
  • Create examples from a file—PUT /v2/language/datasets/<DATASET_ID>/upload

March 27, 2019

CHANGED

Maximum image dataset size increased to 2 GB. We doubled the maximum size of an image dataset from 1 GB to 2 GB.

CHANGED

Maximum text dataset size increased to 2 GB. We doubled the maximum size of a text dataset from 1 GB to 2 GB.

March 21, 2019

CHANGED

Number of API calls to return examples is limited to 30 calls per month. Each Einstein Platform Services account is now limited to 30 calls per calendar month to Einstein Vision and Einstein Language endpoints that return examples.

This limit applies across all APIs that return examples. If you exceed this limit, you receive an error message.

How: These API endpoints return examples.

  • Get all Einstein Vision examples—GET /v2/vision/datasets/<DATASET_ID>/examples
  • Get all Einstein Vision examples for a label—GET /v2/vision/examples?labelId=<LABEL_ID>
  • Get all Einstein Language examples —GET /v2/language/datasets/<DATASET_ID>/examples
  • Get all Einstein Language examples for a label—GET /v2/language/examples?labelId=<LABEL_ID>

March 8, 2019

NEW

API response JSON contains a new language field. The response JSON for any Einstein Vision API call that returns dataset information now contains the language field. The return value is N/A.
How: The language field appears in the response for these calls.

  • Create a dataset asynchronously—POST /v2/vision/datasets/upload
  • Create a dataset synchronously—POST /v2/vision/datasets/upload/sync
  • Create a dataset —POST /v2/vision/datasets
  • Get a dataset—GET /v2/vision/datasets/<DATASET_ID>
  • Get all datasets—GET /v2/vision/datasets
  • Create examples from a .zip file—PUT /v2/vision/datasets/<DATASET_ID>/upload
  • Create feedback examples from a .zip file—PUT /v2/vision/bulkfeedback

NEW

Use the optional language parameter when creating a text dataset. When creating a text dataset, you can now specify a language with the new language parameter. The default is ENGLISH. We created this parameter for future use, so you don’t need to do anything now.
How: The language parameter is available in these calls.

  • Create a dataset asynchronously—POST /v2/language/datasets/upload
  • Create a dataset synchronously—POST /v2/language/datasets/upload/sync

NEW

API response JSON contains a new language field. The response JSON for any Einstein Language API call that returns dataset information now contains the language field. The return value for existing datasets is ENGLISH.
How: The language field appears in the response for these calls.

  • Create a dataset asynchronously—POST /v2/language/datasets/upload
  • Create a dataset synchronously—POST /v2/language/datasets/upload/sync
  • Get a dataset—GET /v2/language/datasets/<DATASET_ID>
  • Get all datasets—GET /v2/language/datasets
  • Create examples from a file—PUT /v2/language/datasets/<DATASET_ID>/upload

January 24, 2019

CHANGED

Exceeding the maximum dataset size returns an error. When you create a dataset (using the POST call) or add data to a dataset (using the PUT call), if the resulting dataset exceeds the maximum dataset size of 1 GB, the call fails and an error is returned. This change applies to Einstein Vision and Einstein Language.

See Create a Dataset From a Zip File Asynchronously (Vision) and Create Examples From a Zip File (Vision).

See Create a Dataset From a File Asynchronously (Language) and Create Examples From a File (Language).

CHANGED

Training requests from customers on a paid plan are prioritized. Training requests from customers on a paid plan are prioritized before training requests made by customers on a free plan. A training request is any call to the /train or /retrain resources.

Use the API usage call to find out what kind of plan you have. See Get API Usage.

curl -X GET -H "Authorization: Bearer <TOKEN>" -H "Cache-Control: no-cache" https://api.einstein.ai/v2/apiusage

The following is a list of the plans. The free plan has a value of STARTER.

  • HEROKU
    • STARTER—2,000 predictions per calendar month.
    • BRONZE—10,000 predictions per calendar month.
    • SILVER—250,000 predictions per calendar month.
    • GOLD—One million predictions per calendar month.
  • SALESFORCE
    • STARTER—2,000 predictions per calendar month.
    • SFDC_1M_EDITION—One million predictions per calendar month.

You might see a delay in training if you're on the free tier of service and there are other training requests in the queue. This change applies to Einstein Vision and Einstein Language.

For previous year's release notes, see Release Notes Archive.

Updated 3 minutes ago

Release Notes


Find out what's new, changed, or deprecated in the Einstein Platform Services APIs.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.