AmazonAIIdentifyPredictionsProvider | amplify-js

Hierarchy

AbstractIdentifyPredictionsProvider
- AmazonAIIdentifyPredictionsProvider

Index

Constructors

constructor

Properties

_config

Methods

Constructors

constructor

new AmazonAIIdentifyPredictionsProvider(): AmazonAIIdentifyPredictionsProvider

- Defined in packages/predictions/src/Providers/AmazonAIIdentifyPredictionsProvider.ts:61
Returns AmazonAIIdentifyPredictionsProvider

Properties

Protected _config

_config: PredictionsOptions

Methods

configure

configure(config: PredictionsOptions): PredictionsOptions

Inherited from AbstractPredictionsProvider.configure
- Defined in packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:11
Parameters
- config: PredictionsOptions
Returns PredictionsOptions

getCategory

getCategory(): string

Inherited from AbstractIdentifyPredictionsProvider.getCategory

Overrides AbstractPredictionsProvider.getCategory
- Defined in packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:19
Returns string

getProviderName

getProviderName(): string

Overrides AbstractPredictionsProvider.getProviderName
- Defined in packages/predictions/src/Providers/AmazonAIIdentifyPredictionsProvider.ts:67
Returns string

identify

identify(input: IdentifyTextInput | IdentifyLabelsInput | IdentifyEntitiesInput): Promise<IdentifyTextOutput | IdentifyLabelsOutput | IdentifyEntitiesOutput>

Inherited from AbstractIdentifyPredictionsProvider.identify
- Defined in packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:23
Parameters
- input: IdentifyTextInput | IdentifyLabelsInput | IdentifyEntitiesInput
Returns Promise<IdentifyTextOutput | IdentifyLabelsOutput | IdentifyEntitiesOutput>

Protected identifyEntities

identifyEntities(input: IdentifyEntitiesInput): Promise<IdentifyEntitiesOutput>

Overrides AbstractIdentifyPredictionsProvider.identifyEntities
- Defined in packages/predictions/src/Providers/AmazonAIIdentifyPredictionsProvider.ts:346
Identify faces within an image that is provided as input, and match faces from a collection or identify celebrities.

Parameters
- input: IdentifyEntitiesInput
  
  object containing the source image and face match options.
Returns Promise<IdentifyEntitiesOutput>

Promise resolving to identify results.

Protected identifyLabels

identifyLabels(input: IdentifyLabelsInput): Promise<IdentifyLabelsOutput>

Overrides AbstractIdentifyPredictionsProvider.identifyLabels
- Defined in packages/predictions/src/Providers/AmazonAIIdentifyPredictionsProvider.ts:232
Identify instances of real world entities from an image and if it contains unsafe content.

Parameters
- input: IdentifyLabelsInput
  
  Object containing the source image and entity type to identify.
Returns Promise<IdentifyLabelsOutput>
- Promise resolving to an array of identified entities.

Protected identifyText

identifyText(input: IdentifyTextInput): Promise<IdentifyTextOutput>

Overrides AbstractIdentifyPredictionsProvider.identifyText
- Defined in packages/predictions/src/Providers/AmazonAIIdentifyPredictionsProvider.ts:131
Recognize text from real-world images and documents (plain text, forms and tables). Detects text in the input image and converts it into machine-readable text.

Parameters
- input: IdentifyTextInput
Returns Promise<IdentifyTextOutput>
- Promise resolving to object containing identified texts.