Einstein Vision and Einstein Language
Provided by [Salesforce](https://www.einstein-hub.com/) � Copyright 2000�2020 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark…
AI & machine learning#openapi#text
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Provided by Salesforce � Copyright 2000�2020 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc., as are other names and marks. Other marks appearing herein may be trademarks of their respective owners. Last updated: Aug 17, 2020
Endpoints 45
Check API Usage
- GETGet API Isage
/v2/apiusageReturns prediction usage on a monthly basis for the current calendar month and future months. Each apiusage object in the response corresponds to a calendar…
Authorization
- POSTGenerate an OAuth Token
/v2/oauth2/tokenReturns an OAuth access token or a refresh token. You must pass a valid access token in the header of each API call. - DELETEDelete a Refresh Token
/v2/oauth2/tokens/:token
Vision Datasets
- GETGet All Datasets
/v2/vision/datasets?offset=0&count=25&global=falseReturns a list of datasets and their labels that were created by the current user. The response is sorted by dataset ID. - POSTCreate a Dataset
/v2/vision/datasetsCreates a dataset and labels, if they're specified. - POSTCreate a Dataset From a Zip File Asynchronously
/v2/vision/datasets/uploadCreates a dataset, labels, and examples from the specified .zip file. The call returns immediately and continues to upload the images in the background. - POSTCreate a Dataset From a Zip File Synchronously
/v2/vision/datasets/upload/syncCreates a dataset, labels, and examples from the specified .zip file. The call returns after the dataset is created and all of the images are uploaded. - GETGet a Dataset
/v2/vision/datasets/:datasetIdReturns a single dataset. - DELETEDelete a Dataset
/v2/vision/datasets/:datasetIdDeletes the specified dataset and associated labels and examples. - GETGet Deletion Status
/v2/vision/deletion/:idReturns the status of an image dataset or model deletion. When you delete a dataset or model, the deletion may not occur immediately. Use this call to find…
Vision Examples
- PUTCreate Feedback Examples From a Zip File
/v2/vision/bulkfeedbackAdds feedback examples to the dataset associated with the specified object detection model. - GETGet All Examples
/v2/vision/datasets/:datasetId/examples?offset=0&count=100&source=allReturns all the examples for the specified dataset. By default, returns examples created by uploading them from a .zip file. - POSTCreate an Example
/v2/vision/datasets/:datasetId/examplesAdds an example with the specified label to a dataset. - PUTCreate Examples From a Zip File
/v2/vision/datasets/:datasetId/uploadAdds examples from a .zip file to a dataset. You can use this call only with a dataset that was created from a .zip file. - GETGet All Examples for Label
/v2/vision/examples?labelId=SomeLabelId&offset=0&count=100Returns all the examples for the specified label. Returns both uploaded examples and feedback examples. - POSTCreate a Feedback Example
/v2/vision/feedbackAdds a feedback example to the dataset associated with the specified model.
Vision Training
- POSTRetrain a Dataset
/v2/vision/retrainRetrains a dataset and updates a model. Use this API call when you want to update a model and keep the model ID instead of creating a new model. - POSTTrain a Dataset
/v2/vision/trainTrains a dataset and creates a model. - GETGet Training Status
/v2/vision/train/:modelIdReturns the status of a model's training process. Use the progress field to determine how far the training has progressed. When training completes…
Vision Models
- GETGet All Models
/v2/vision/datasets/:datasetId/models?offset=0&count=100Returns all models for the specified dataset. - GETGet Model Metrics
/v2/vision/models/:modelIdReturns the metrics for a model - DELETEDelete a Model
/v2/vision/models/:modelIdDeletes the specified model. - GETGet Model Learning Curve
/v2/vision/models/:modelId/lc?offset=0&count=25Returns the metrics for each epoch in a model.
Vision Prediction
- POSTDetection with Image File
/v2/vision/detectReturns labels, probabilities, and bounding box coordinates for items detected in the specified local image file. - POSTDetect Text
/v2/vision/ocrReturns a prediction from an OCR model for the specified image URL or local image file. - POSTMake Prediction
/v2/vision/predictReturns a prediction from an image or multi-label model for the specified image.
Language Datasets
- GETGet All Datasets
/v2/language/datasets?offset=0&count=25&global=falseReturns a list of datasets and their labels that were created by the current user. The response is sorted by dataset ID. - POSTCreate a Dataset From a File Asynchronously
/v2/language/datasets/uploadCreates a dataset, labels, and examples from the specified .csv, .tsv, or .json file. The call returns immediately and continues to upload data in the… - POSTCreate a Dataset From a File Synchronously
/v2/language/datasets/upload/syncCreates a dataset, labels, and examples from the specified .csv, .tsv, or .json file. The call returns after the dataset is created and all of the data is… - GETGet a Dataset
/v2/language/datasets/:datasetIdReturns a single dataset. - DELETEDelete a Dataset
/v2/language/datasets/:datasetIdDeletes the specified dataset and associated labels and examples. - GETGet Deletion Status
/v2/language/deletion/:idReturns the status of a language dataset or model deletion. When you delete a dataset or model, the deletion may not occur immediately. Use this call to find…
Language Examples
- GETGet All Examples
/v2/language/datasets/:datasetId/examples?offset=0&count=100&source=allReturns all the examples for the specified dataset, - PUTCreate Examples From a File
/v2/language/datasets/:datasetId/uploadAdds examples from a .csv, .tsv, or .json file to a dataset. - GETGet All Examples for Label
/v2/language/examples?labelId=SomeLabelId&offset=0&count=100Returns all the examples for the specified label. Returns both uploaded examples and feedback examples. - POSTCreate a Feedback Example
/v2/language/feedbackAdds a feedback example to the dataset associated with the specified model.
Language Training
- POSTRetrain a Dataset
/v2/language/retrainRetrains a dataset and updates a model. Use this API call when you want to update a model and keep the model ID instead of creating a new model. - POSTTrain a Dataset
/v2/language/trainTrains a dataset and creates a model. - GETGet Training Status
/v2/language/train/:modelIdReturns the status of a model's training process. Use the progress field to determine how far the training has progressed. When training completes…
Language Models
- GETGet All Models
/v2/language/datasets/:datasetId/models?offset=0&count=100Returns all models for the specified dataset. - GETGet Model Metrics
/v2/language/models/:modelIdReturns the metrics for a model - DELETEDelete a Model
/v2/language/models/:modelIdDeletes the specified model. - GETGet Model Learning Curve
/v2/language/models/:modelId/lc?offset=0&count=25Returns the metrics for each epoch in a model.
Language Prediction
- POSTPrediction for Intent
/v2/language/intentReturns an intent prediction for the given string. - POSTPrediction for Sentiment
/v2/language/sentimentReturns a sentiment prediction for the given string.
API details
- Base URL
http://salesforce.local- Authentication
- A bearer token in the Authorization header
- Operations
- 45 operations on 39 pathsGET 19POST 18DELETE 5PUT 3
- Main resources
- Vision Datasets 7Language Datasets 6Vision Examples 6Language Examples 4Language Models 4Vision Models 4Language Training 3Vision Prediction 3Vision Training 3Authorization 2
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
2.0.1 - Links
- Documentation · OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Einstein Vision and Einstein Language in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Einstein Vision and Einstein Language collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get API Isage” (GET /v2/apiusage), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Einstein Vision and Einstein Language?
Provided by [Salesforce](https://www.einstein-hub.com/) � Copyright 2000�2020 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark… It is listed under AI & machine learning and has 45 endpoints.
Who publishes the Einstein Vision and Einstein Language?
It is listed from Salesforce's public API description (an OpenAPI document), not published by Salesforce on Swastik Codes. Anyone who controls salesforce.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Einstein Vision and Einstein Language?
Requests go to http://salesforce.local. Endpoint paths are added to this base URL.
How do I authenticate with the Einstein Vision and Einstein Language?
With A bearer token in the Authorization header.
How many endpoints does the Einstein Vision and Einstein Language have?
45 operations on 39 paths (19 GET, 18 POST, 5 DELETE, 3 PUT). The largest groups are Vision Datasets, Language Datasets, Vision Examples, Language Examples.
Is forking the Einstein Vision and Einstein Language free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.