Class DecoLensClient

The main client for interacting with the DecoLens API.

Index

Constructors

Methods

analyzeRoom search similarArtworks

Constructors

constructor

new DecoLensClient(apiKey: string, baseUrl?: string): DecoLensClient
Creates a new DecoLensClient instance.
Parameters
- apiKey: string
  Your DecoLens API key. Make sure this is the "client" API key generated via the admin console.
- baseUrl: string = 'https://api.decolens.com/api/v1'
  Optional. The base URL of the DecoLens API endpoint, if you need to override the default.
Returns DecoLensClient
- Defined in src/index.ts:179

Methods

analyzeRoom

analyzeRoom(
    imageUrl: string,
    preferences?: Preferences,
    callback: AnalysisCallback,
): Promise<AbortController>
Analyzes an image of a room/space to determine its purpose and aesthetics, and provide artwork recommendations.
Parameters
- imageUrl: string
  The URL or data URI of the image to analyze.
- preferences: Preferences = {}
  User preferences for the analysis. Optional.
- callback: AnalysisCallback
  Callback functions to handle partial, complete, and error events.
Returns Promise<AbortController>
An AbortController that can be used to cancel the analysis.
- Defined in src/index.ts:306

search

search(
    query: string,
    maxCount?: number,
    tags?: string[],
): Promise<{ artworkIds: string[] }>
Searches for artworks based on a natural language query. Query must be at least 3 characters.
Parameters
- query: string
  The search query.
- maxCount: number = 5
  The maximum number of results to return (default: 5).
- tags: string[] = []
  Array of tags to filter by. Artworks will be returned if they match ANY of the tags specified. Optional.
Returns Promise<{ artworkIds: string[] }>
A Promise that resolves to an array of artwork IDs.
- Defined in src/index.ts:389

similarArtworks

similarArtworks(
    artworkId: string,
    maxCount?: number,
    tags?: string[],
): Promise<{ artworkIds: string[] }>
Finds artworks similar to a given artwork.
Parameters
- artworkId: string
  The ID of the artwork to find similar artworks for.
- maxCount: number = 5
  The maximum number of results to return (default: 5).
- tags: string[] = []
  Array of tags to filter by. Artworks will be returned if they match ANY of the tags specified. Optional.
Returns Promise<{ artworkIds: string[] }>
A Promise that resolves to an array of artwork IDs.
- Defined in src/index.ts:411