cosineSimilarity function

double cosineSimilarity(
  1. Embedding first,
  2. Embedding second
)

Cosine similarity of two embeddings of the same representation and size, computed in Dart so every platform gives the same answer. Quantized bytes are read as signed 8-bit values, as Google's APIs do.

Implementation

double cosineSimilarity(Embedding first, Embedding second) {
  final floating = first.floatEmbedding != null;
  if (floating != (second.floatEmbedding != null)) {
    throw ArgumentError('Embedding representations must match.');
  }
  final left = floating
      ? first.floatEmbedding!
      : [for (final v in first.quantizedEmbedding!) v.toSigned(8).toDouble()];
  final right = floating
      ? second.floatEmbedding!
      : [for (final v in second.quantizedEmbedding!) v.toSigned(8).toDouble()];
  if (left.isEmpty || left.length != right.length) {
    throw ArgumentError('Embedding dimensions must be nonzero and equal.');
  }
  var dot = 0.0;
  var normLeft = 0.0;
  var normRight = 0.0;
  for (var i = 0; i < left.length; i++) {
    if (!left[i].isFinite || !right[i].isFinite) {
      throw ArgumentError('Embeddings must contain finite values.');
    }
    dot += left[i] * right[i];
    normLeft += left[i] * left[i];
    normRight += right[i] * right[i];
  }
  if (normLeft == 0 ||
      normRight == 0 ||
      !dot.isFinite ||
      !normLeft.isFinite ||
      !normRight.isFinite) {
    throw ArgumentError('Embedding norms must be finite and nonzero.');
  }
  return (dot / math.sqrt(normLeft) / math.sqrt(normRight)).clamp(-1.0, 1.0);
}