AiBrow
  • Welcome
  • AiBrow web API
    • Getting started
    • Feature comparison
  • AiBrow Extension
    • Getting started
    • Web polyfill
    • Helping users install the AiBrow extension
    • Remove the on-device helper or models
  • Examples
    • CoreModel API
    • Embedding API
    • LanguageDetector API
    • LanguageModel API
    • Rewriter API
    • Summarizer API
    • Translator API
    • Writer API
    • Using different models
    • Model download feedback
    • Getting JSON output
  • API Reference
    • AI
      • AiBrowAI
      • BrowserAI
      • WebAI
    • AiBrow
      • CoreModelFactory
        • CoreModel
        • CoreModelCapabilities
      • EmbeddingFactory
        • Embedding
        • EmbeddingCapabilities
      • LanguageDetectorFactory
        • LanguageDetector
        • LanguageDectectorCapabilities
      • LanguageModelFactory
        • LanguageModel
        • LanguageModelCapabilities
      • RewriterFactory
        • Rewriter
        • RewriterCapabilities
      • SummarizerFactory
        • Summarizer
        • SummarizerCapabilities
      • TranslatorFactory
        • Translator
        • TranslatorCapabilities
      • WriterFactory
        • Writer
        • WriterCapabilities
    • Types
      • AICapabilityAvailability
      • AICapabilityGpuEngine
      • AICreateMonitor
      • AILanguageDetectorDetectResult
      • AIRewriterFormat
      • AIRewriterLength
      • AIRewriterTone
      • AISummarizerFormat
      • AISummarizerLength
      • AISummarizerType
      • AIWriterFormat
      • AIWriterLength
      • AIWriterTone
      • AIModelDtype
    • Models
Powered by GitBook
On this page
  • Properties
  • topK
  • topP
  • temperature
  • repeatPenality
  • flashAttention
  • contextSize
  • Methods
  • get
  • calculateCosineSimilarity
  • findSimilar
  1. API Reference
  2. AiBrow
  3. EmbeddingFactory

Embedding

Only available on the extension & web implementations

Properties

topK

number

topP

number

temperature

number

repeatPenality

number

flashAttention

boolean

contextSize

number


Methods

get

(input, options) => number[] | number[][]

Creates a new vector from the provided input

Input

A string or strings[] to generate a vector(s) from

Options (optional)

signal optional AbortSignal

Returns the vector or vectors from the language model

calculateCosineSimilarity

(vectorA, vectorB) => number

Calculates the cosine similarity between two embeddings. Only compare embeddings created by the same model

vectorA

A number[] vector to compare

vectorB

A number[] vector to compare

Returns a value between 0 and 1 representing the similarity. 1 being the most similar

findSimilar

(embeddings, target) => any[]

Finds and sorts similar vectors

embeddings

An Array<{ id: any, vector: number[] }> array of objects, each with id and vector

target

A number[] vector to use as the search target

Returns a list of ids, sorted by the most similar to the least similar

PreviousEmbeddingFactoryNextEmbeddingCapabilities

Last updated 3 months ago