ImageEmbedder class

Performs embedding extraction on images.

Signature:

  export 
  
 declare 
  
 class 
  
 ImageEmbedder 
  
 extends 
  
 VisionTaskRunner 
  
 

Extends: VisionTaskRunner

Methods

ImageEmbedder.cosineSimilarity()

Utility function to compute cosine similarity[1] between two Embedding objects.

[1]: https://en.wikipedia.org/wiki/Cosine_similarity

Signature:

  static 
  
 cosineSimilarity 
 ( 
 u 
 : 
  
 Embedding 
 , 
  
 v 
 : 
  
 Embedding 
 ) 
 : 
  
 number 
 ; 
 

Parameters

Returns:

number

Exceptions

if the embeddings are of different types(float vs. quantized), have different sizes, or have an L2-norm of 0.

ImageEmbedder.createFromModelBuffer()

Initializes the Wasm runtime and creates a new image embedder based on the provided model asset buffer.

Signature:

  static 
  
 createFromModelBuffer 
 ( 
 wasmFileset 
 : 
  
 WasmFileset 
 , 
  
 modelAssetBuffer 
 : 
  
 Uint8Array 
 ) 
 : 
  
 Promise<ImageEmbedder> 
 ; 
 

Parameters

Returns:

Promise< ImageEmbedder >

ImageEmbedder.createFromModelPath()

Initializes the Wasm runtime and creates a new image embedder based on the path to the model asset.

Signature:

  static 
  
 createFromModelPath 
 ( 
 wasmFileset 
 : 
  
 WasmFileset 
 , 
  
 modelAssetPath 
 : 
  
 string 
 ) 
 : 
  
 Promise<ImageEmbedder> 
 ; 
 

Parameters

Returns:

Promise< ImageEmbedder >

ImageEmbedder.createFromOptions()

Initializes the Wasm runtime and creates a new image embedder from the provided options.

Signature:

  static 
  
 createFromOptions 
 ( 
 wasmFileset 
 : 
  
 WasmFileset 
 , 
  
 imageEmbedderOptions 
 : 
  
 ImageEmbedderOptions 
 ) 
 : 
  
 Promise<ImageEmbedder> 
 ; 
 

Parameters

Returns:

Promise< ImageEmbedder >

ImageEmbedder.embed()

Performs embedding extraction on the provided single image and waits synchronously for the response. Only use this method when the ImageEmbedder is created with running mode image .

Signature:

  embed 
 ( 
 image 
 : 
  
 ImageSource 
 , 
  
 imageProcessingOptions? 
 : 
  
 ImageProcessingOptions 
 ) 
 : 
  
 ImageEmbedderResult 
 ; 
 

Parameters

Returns:

ImageEmbedderResult

ImageEmbedder.embedForVideo()

Performs embedding extraction on the provided video frame and waits synchronously for the response. Only use this method when the ImageEmbedder is created with running mode video .

Signature:

  embedForVideo 
 ( 
 imageFrame 
 : 
  
 ImageSource 
 , 
  
 timestamp 
 : 
  
 number 
 , 
  
 imageProcessingOptions? 
 : 
  
 ImageProcessingOptions 
 ) 
 : 
  
 ImageEmbedderResult 
 ; 
 

Parameters

Returns:

ImageEmbedderResult

ImageEmbedder.setOptions()

Sets new options for the image embedder.

Calling setOptions() with a subset of options only affects those options. You can reset an option back to its default value by explicitly setting it to undefined .

Signature:

  setOptions 
 ( 
 options 
 : 
  
 ImageEmbedderOptions 
 ) 
 : 
  
 Promise<void> 
 ; 
 

Parameters

Returns:

Promise<void>