diff --git a/harness/apple/embeddings.device.harness.ts b/harness/apple/embeddings.device.harness.ts index cd1ba1f4..8b610baf 100644 --- a/harness/apple/embeddings.device.harness.ts +++ b/harness/apple/embeddings.device.harness.ts @@ -17,6 +17,16 @@ function cosine(a: number[], b: number[]) { } describe('apple embeddings', () => { + it('describes the model for its language', async () => { + const model = apple.embeddingModel({ language: 'en' }) + await model.prepare() + + const info = await model.getModelInfo() + expect(info).toMatchObject({ hasAvailableAssets: true }) + expect(info.dimension).toBeGreaterThan(0) + expect(info.languages).toContain('en') + }) + it('embeds text so that similar texts are closer', async () => { const model = apple.embeddingModel({ language: 'en' }) await model.prepare() diff --git a/packages/apple-llm/ios/embeddings/AppleEmbeddings.mm b/packages/apple-llm/ios/embeddings/AppleEmbeddings.mm index 24ed4822..23e20353 100644 --- a/packages/apple-llm/ios/embeddings/AppleEmbeddings.mm +++ b/packages/apple-llm/ios/embeddings/AppleEmbeddings.mm @@ -44,8 +44,8 @@ + (NSString *)moduleName { return std::make_shared(params); } -- (void)getInfo:(nonnull NSString *)language resolve:(nonnull RCTPromiseResolveBlock)resolve reject:(nonnull RCTPromiseRejectBlock)reject { - [_embeddings getInfo:language resolve:resolve reject:reject]; +- (void)getModelInfo:(nonnull NSString *)language resolve:(nonnull RCTPromiseResolveBlock)resolve reject:(nonnull RCTPromiseRejectBlock)reject { + [_embeddings getModelInfo:language resolve:resolve reject:reject]; } - (void)prepare:(nonnull NSString *)language resolve:(nonnull RCTPromiseResolveBlock)resolve reject:(nonnull RCTPromiseRejectBlock)reject { diff --git a/packages/apple-llm/ios/embeddings/AppleEmbeddingsImpl.swift b/packages/apple-llm/ios/embeddings/AppleEmbeddingsImpl.swift index 3ccbc425..afb3c19a 100644 --- a/packages/apple-llm/ios/embeddings/AppleEmbeddingsImpl.swift +++ b/packages/apple-llm/ios/embeddings/AppleEmbeddingsImpl.swift @@ -14,7 +14,7 @@ import Accelerate @objc public class AppleEmbeddingsImpl: NSObject { @objc - public func getInfo(_ language: String, resolve: @escaping (Any?) -> Void, reject: @escaping (String, String, Error?) -> Void) { + public func getModelInfo(_ language: String, resolve: @escaping (Any?) -> Void, reject: @escaping (String, String, Error?) -> Void) { if #available(iOS 17.0, *) { guard let nlLanguage = try? convertToNLLanguage(language), let model = NLContextualEmbedding(language: nlLanguage) else { diff --git a/packages/apple-llm/src/NativeAppleEmbeddings.ts b/packages/apple-llm/src/NativeAppleEmbeddings.ts index 7d74b05b..ac972a7e 100644 --- a/packages/apple-llm/src/NativeAppleEmbeddings.ts +++ b/packages/apple-llm/src/NativeAppleEmbeddings.ts @@ -1,7 +1,7 @@ import type { TurboModule } from 'react-native' import { TurboModuleRegistry } from 'react-native' -export interface EmbeddingInfo { +export interface AppleEmbeddingModelInfo { hasAvailableAssets: boolean dimension: number languages: string[] @@ -12,7 +12,7 @@ export interface EmbeddingInfo { } export interface Spec extends TurboModule { - getInfo(language: string): Promise + getModelInfo(language: string): Promise prepare(language: string): Promise generateEmbeddings(values: string[], language: string): Promise } diff --git a/packages/apple-llm/src/ai-sdk.ts b/packages/apple-llm/src/ai-sdk.ts index 9d767e1c..02677477 100644 --- a/packages/apple-llm/src/ai-sdk.ts +++ b/packages/apple-llm/src/ai-sdk.ts @@ -1220,6 +1220,11 @@ class AppleTextEmbeddingModel implements EmbeddingModelV4 { this.prepared = true } + /** Assets, dimension and languages of the model for its language */ + getModelInfo() { + return NativeAppleEmbeddings.getModelInfo(this.language) + } + async doEmbed( options: EmbeddingModelV4CallOptions ): Promise { diff --git a/packages/apple-llm/src/index.ts b/packages/apple-llm/src/index.ts index 7424ba64..991c2855 100644 --- a/packages/apple-llm/src/index.ts +++ b/packages/apple-llm/src/index.ts @@ -26,6 +26,7 @@ export { } from './ai-sdk' export type { AppleLLMError, AppleLLMErrorCode } from './errors' export { AppleLLMErrorCodes } from './errors' +export type { AppleEmbeddingModelInfo } from './NativeAppleEmbeddings' export { default as AppleEmbeddings } from './NativeAppleEmbeddings' export { default as AppleFoundationModels } from './NativeAppleLLM' export type { diff --git a/website/src/docs/apple/embeddings.md b/website/src/docs/apple/embeddings.md index cd366e77..7de66e6a 100644 --- a/website/src/docs/apple/embeddings.md +++ b/website/src/docs/apple/embeddings.md @@ -97,29 +97,27 @@ For advanced use cases, you can access the embeddings API directly: ### AppleEmbeddings ```tsx -import { AppleEmbeddings } from '@react-native-ai/apple' +import { + AppleEmbeddings, + type AppleEmbeddingModelInfo, +} from '@react-native-ai/apple' + +const language = 'en' // Get embedding model information -const modelInfo: EmbeddingInfo = await AppleEmbeddings.getInfo(language: string) +const modelInfo: AppleEmbeddingModelInfo = + await AppleEmbeddings.getModelInfo(language) +// { hasAvailableAssets, dimension, languages, maximumSequenceLength, +// modelIdentifier, revision, scripts } // Prepare language assets -await AppleEmbeddings.prepare(language: string) - -// Generate embeddings -const embeddings = await AppleEmbeddings.generateEmbeddings( - values: string[], - language: string -): Promise - -export interface EmbeddingInfo { - hasAvailableAssets: boolean - dimension: number - languages: string[] - maximumSequenceLength: number - modelIdentifier: string - revision: number - scripts: string[] -} +await AppleEmbeddings.prepare(language) + +// Generate embeddings, one number[] per value +const embeddings: number[][] = await AppleEmbeddings.generateEmbeddings( + ['Hello world', 'How are you?'], + language +) ``` ## Benchmarks