BlueForge Docs

client.storage.search

Semantic search across stored assets.

Signature

class Client {
  storage: {
    search(query: string, opts?: { limit?: number }): Promise<StorageSearchResult[]>
  }
}

Parameters

NameTypeRequiredNotes
query
stringyesNatural-language query
limit
numbernoMax results (default 20)

Examples

const results = await bf.storage.search('red sports car', { limit: 5 })
for (const r of results) {
  console.log(`${r.key} — score: ${r.score}`)
}

Throws

ErrorCondition
ApiError
API request failed
NetworkError
Network issue

Pitfalls

  • Requires embeddings — objects must have been uploaded with
    generateEmbedding: true
    or have had embeddings generated separately
  • Cold results — newly uploaded objects may take a few seconds to appear in search results

See also

{auto-injected}

Tested against

{auto-injected}