Class: AWS.LookoutVision
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.LookoutVision
- Identifier:
- lookoutvision
- API Version:
- 2020-11-20
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, data types, common parameters, and common errors.
Amazon Lookout for Vision enables you to find visual defects in industrial products, accurately and at scale. It uses computer vision to identify missing components in an industrial product, damage to vehicles or structures, irregularities in production lines, and even minuscule defects in silicon wafers — or any other physical item where quality is important such as a missing capacitor on printed circuit boards.
Sending a Request Using LookoutVision
var lookoutvision = new AWS.LookoutVision();
lookoutvision.createDataset(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the LookoutVision object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var lookoutvision = new AWS.LookoutVision({apiVersion: '2020-11-20'});
You can also set the API version globally in AWS.config.apiVersions
using
the lookoutvision service identifier:
AWS.config.apiVersions = {
lookoutvision: '2020-11-20',
// other service API versions
};
var lookoutvision = new AWS.LookoutVision();
Constructor Summary collapse
-
new AWS.LookoutVision(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createDataset(params = {}, callback) ⇒ AWS.Request
Creates a new dataset in an Amazon Lookout for Vision project.
-
createModel(params = {}, callback) ⇒ AWS.Request
Creates a new version of a model within an an Amazon Lookout for Vision project.
-
createProject(params = {}, callback) ⇒ AWS.Request
Creates an empty Amazon Lookout for Vision project.
-
deleteDataset(params = {}, callback) ⇒ AWS.Request
Deletes an existing Amazon Lookout for Vision dataset.
-
deleteModel(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Lookout for Vision model.
-
deleteProject(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Lookout for Vision project.
-
describeDataset(params = {}, callback) ⇒ AWS.Request
Describe an Amazon Lookout for Vision dataset.
-
describeModel(params = {}, callback) ⇒ AWS.Request
Describes a version of an Amazon Lookout for Vision model.
-
describeProject(params = {}, callback) ⇒ AWS.Request
Describes an Amazon Lookout for Vision project.
-
detectAnomalies(params = {}, callback) ⇒ AWS.Request
Detects anomalies in an image that you supply.
-
listDatasetEntries(params = {}, callback) ⇒ AWS.Request
Lists the JSON Lines within a dataset.
-
listModels(params = {}, callback) ⇒ AWS.Request
Lists the versions of a model in an Amazon Lookout for Vision project.
-
listProjects(params = {}, callback) ⇒ AWS.Request
Lists the Amazon Lookout for Vision projects in your AWS account.
-
startModel(params = {}, callback) ⇒ AWS.Request
Starts the running of the version of an Amazon Lookout for Vision model.
-
stopModel(params = {}, callback) ⇒ AWS.Request
Stops a running model.
-
updateDatasetEntries(params = {}, callback) ⇒ AWS.Request
Adds one or more JSON Line entries to a dataset.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.LookoutVision(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
createDataset(params = {}, callback) ⇒ AWS.Request
Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset
can create a training or a test dataset from a valid dataset source (DatasetSource
).
If you want a single dataset project, specify train
for the value of DatasetType
.
To have a project with separate training and test datasets, call CreateDataset
twice. On the first call, specify train
for the value of DatasetType
. On the second call, specify test
for the value of DatasetType
. of dataset with
createModel(params = {}, callback) ⇒ AWS.Request
Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel
is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.
To get the current status, check the Status
field returned in the response from DescribeModel.
If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.
After training completes, the evaluation metrics are stored at the location specified in OutputConfig
.
createProject(params = {}, callback) ⇒ AWS.Request
Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling CreateDataset.
deleteDataset(params = {}, callback) ⇒ AWS.Request
Deletes an existing Amazon Lookout for Vision dataset
.
If your the project has a single dataset, you must create a new dataset before you can create a model.
If you project has a training dataset and a test dataset consider the following.
-
If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.
-
If you delete the training dataset, you must create a training dataset before you can create a model.
It might take a while to delete the dataset. To check the current status, check the Status
field in the response from a call to DescribeDataset.
deleteModel(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation.
deleteProject(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Lookout for Vision project.
To delete a project, you must first delete each version of the model associated with the project. To delete a model use the DeleteModel operation.
The training and test datasets are deleted automatically for you. The images referenced by the training and test datasets aren't deleted.
describeModel(params = {}, callback) ⇒ AWS.Request
Describes a version of an Amazon Lookout for Vision model.
describeProject(params = {}, callback) ⇒ AWS.Request
Describes an Amazon Lookout for Vision project.
detectAnomalies(params = {}, callback) ⇒ AWS.Request
Detects anomalies in an image that you supply.
The response from DetectAnomalies
includes a boolean prediction that the image contains one or more anomalies and a confidence value for the prediction.
DetectAnomalies
, you must first start your model with the StartModel operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your model uses. If you are not using a model, use the StopModel operation to stop your model. listDatasetEntries(params = {}, callback) ⇒ AWS.Request
Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.
listModels(params = {}, callback) ⇒ AWS.Request
Lists the versions of a model in an Amazon Lookout for Vision project.
listProjects(params = {}, callback) ⇒ AWS.Request
Lists the Amazon Lookout for Vision projects in your AWS account.
startModel(params = {}, callback) ⇒ AWS.Request
Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use DescribeModel.
Once the model is running, you can detect custom labels in new images by calling DetectAnomalies.
stopModel(params = {}, callback) ⇒ AWS.Request
Stops a running model. The operation might take a while to complete. To check the current status, call DescribeModel.
updateDatasetEntries(params = {}, callback) ⇒ AWS.Request
Adds one or more JSON Line entries to a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model. The following is an example JSON Line.
Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and check the Status
field in the response.