@camera.ui/sdk / plugin / ClipDetectionInterface
Interface: ClipDetectionInterface
Defined in: plugin/interfaces.ts:289
Interface for plugins that provide CLIP embedding generation. Implement testClipEmbedding() to handle detection test requests from the UI.
Methods
clipSettings()?
optionalclipSettings():Promise<JsonSchema[] |undefined>
Defined in: plugin/interfaces.ts:297
Optional settings schema for CLIP detection configuration UI
Returns
Promise<JsonSchema[] | undefined>
detectClipEmbedding()?
optionaldetectClipEmbedding(frame,config?):Promise<ClipDetectionPluginResponse|undefined>
Defined in: plugin/interfaces.ts:293
Generate CLIP embeddings from a pre-processed frame. Used by automations/benchmarks.
Parameters
frame
config?
Record<string, unknown>
Returns
Promise<ClipDetectionPluginResponse | undefined>
getTextEmbedding()
getTextEmbedding(
text):Promise<ClipTextEmbeddingResult>
Defined in: plugin/interfaces.ts:295
Generate a CLIP text embedding for semantic search.
Parameters
text
string
Returns
Promise<ClipTextEmbeddingResult>
testClipEmbedding()
testClipEmbedding(
imageData,metadata,config):Promise<ClipDetectionPluginResponse|undefined>
Defined in: plugin/interfaces.ts:291
Generate CLIP embeddings for an image. Used by the UI for testing/previewing.
Parameters
imageData
Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
metadata
config
Record<string, unknown>
Returns
Promise<ClipDetectionPluginResponse | undefined>