From a19d9b2a8b0c12f48728001c483d5cc2ecb02cc4 Mon Sep 17 00:00:00 2001 From: Mike Grabowski Date: Mon, 26 Oct 2026 15:49:38 +0400 Subject: [PATCH 1/3] feat(apple): name embedding model info getModelInfo The language and transcription models report their details with getModelInfo(), while embeddings used getInfo(). AppleEmbeddings and the embedding model now have getModelInfo(), and getInfo() is a deprecated alias. Co-Authored-By: Claude Opus 5.5 --- harness/apple/embeddings.device.harness.ts | 10 +++++++++ .../apple-llm/src/NativeAppleEmbeddings.ts | 21 ++++++++++++++++--- packages/apple-llm/src/ai-sdk.ts | 5 +++++ packages/apple-llm/src/index.ts | 4 ++++ website/src/docs/apple/embeddings.md | 6 +++--- 5 files changed, 40 insertions(+), 6 deletions(-) diff --git a/harness/apple/embeddings.device.harness.ts b/harness/apple/embeddings.device.harness.ts index cd1ba1f43..8b610bafb 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/src/NativeAppleEmbeddings.ts b/packages/apple-llm/src/NativeAppleEmbeddings.ts index 7d74b05be..c100f4003 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[] @@ -11,10 +11,25 @@ export interface EmbeddingInfo { scripts: string[] } +/** @deprecated Use `AppleEmbeddingModelInfo` */ +export type EmbeddingInfo = AppleEmbeddingModelInfo + export interface Spec extends TurboModule { - getInfo(language: string): Promise + getInfo(language: string): Promise prepare(language: string): Promise generateEmbeddings(values: string[], language: string): Promise } -export default TurboModuleRegistry.getEnforcing('NativeAppleEmbeddings') +const NativeAppleEmbeddings = TurboModuleRegistry.getEnforcing( + 'NativeAppleEmbeddings' +) + +export default { + // Named like the language and transcription models' getModelInfo + getModelInfo: (language: string) => NativeAppleEmbeddings.getInfo(language), + /** @deprecated Use `getModelInfo` */ + getInfo: (language: string) => NativeAppleEmbeddings.getInfo(language), + prepare: (language: string) => NativeAppleEmbeddings.prepare(language), + generateEmbeddings: (values: string[], language: string) => + NativeAppleEmbeddings.generateEmbeddings(values, language), +} diff --git a/packages/apple-llm/src/ai-sdk.ts b/packages/apple-llm/src/ai-sdk.ts index 9d767e1c4..026774775 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 7424ba640..095b15dba 100644 --- a/packages/apple-llm/src/index.ts +++ b/packages/apple-llm/src/index.ts @@ -26,6 +26,10 @@ export { } from './ai-sdk' export type { AppleLLMError, AppleLLMErrorCode } from './errors' export { AppleLLMErrorCodes } from './errors' +export type { + AppleEmbeddingModelInfo, + EmbeddingInfo, +} 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 cd366e77a..14d61609c 100644 --- a/website/src/docs/apple/embeddings.md +++ b/website/src/docs/apple/embeddings.md @@ -99,8 +99,8 @@ For advanced use cases, you can access the embeddings API directly: ```tsx import { AppleEmbeddings } from '@react-native-ai/apple' -// Get embedding model information -const modelInfo: EmbeddingInfo = await AppleEmbeddings.getInfo(language: string) +// Get embedding model information (getInfo is a deprecated alias) +const modelInfo: AppleEmbeddingModelInfo = await AppleEmbeddings.getModelInfo(language: string) // Prepare language assets await AppleEmbeddings.prepare(language: string) @@ -111,7 +111,7 @@ const embeddings = await AppleEmbeddings.generateEmbeddings( language: string ): Promise -export interface EmbeddingInfo { +export interface AppleEmbeddingModelInfo { hasAvailableAssets: boolean dimension: number languages: string[] From 5d1341099ff17525cfea8554f6d814fe1c24ac88 Mon Sep 17 00:00:00 2001 From: Mike Grabowski Date: Mon, 26 Oct 2026 15:57:28 +0400 Subject: [PATCH 2/3] docs(apple): make the embeddings direct api example runnable Co-Authored-By: Claude Opus 5.5 --- website/src/docs/apple/embeddings.md | 36 +++++++++++++--------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/website/src/docs/apple/embeddings.md b/website/src/docs/apple/embeddings.md index 14d61609c..aa6e14d50 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 (getInfo is a deprecated alias) -const modelInfo: AppleEmbeddingModelInfo = await AppleEmbeddings.getModelInfo(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 AppleEmbeddingModelInfo { - 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 From 8aaacc4e79748985e7254c7c27eb2d5d3c3ec2dc Mon Sep 17 00:00:00 2001 From: Mike Grabowski Date: Mon, 26 Oct 2026 16:03:00 +0400 Subject: [PATCH 3/3] feat(apple)!: rename embeddings getInfo to getModelInfo Native now implements getModelInfo() instead of getInfo(), and the module is exported as is again. BREAKING CHANGE: AppleEmbeddings.getInfo() is now getModelInfo(), and the EmbeddingInfo type is now AppleEmbeddingModelInfo. Co-Authored-By: Claude Opus 5.5 --- .../ios/embeddings/AppleEmbeddings.mm | 4 ++-- .../ios/embeddings/AppleEmbeddingsImpl.swift | 2 +- .../apple-llm/src/NativeAppleEmbeddings.ts | 19 ++----------------- packages/apple-llm/src/index.ts | 5 +---- website/src/docs/apple/embeddings.md | 2 +- 5 files changed, 7 insertions(+), 25 deletions(-) diff --git a/packages/apple-llm/ios/embeddings/AppleEmbeddings.mm b/packages/apple-llm/ios/embeddings/AppleEmbeddings.mm index 24ed48225..23e20353c 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 3ccbc425c..afb3c19af 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 c100f4003..ac972a7e9 100644 --- a/packages/apple-llm/src/NativeAppleEmbeddings.ts +++ b/packages/apple-llm/src/NativeAppleEmbeddings.ts @@ -11,25 +11,10 @@ export interface AppleEmbeddingModelInfo { scripts: string[] } -/** @deprecated Use `AppleEmbeddingModelInfo` */ -export type EmbeddingInfo = AppleEmbeddingModelInfo - export interface Spec extends TurboModule { - getInfo(language: string): Promise + getModelInfo(language: string): Promise prepare(language: string): Promise generateEmbeddings(values: string[], language: string): Promise } -const NativeAppleEmbeddings = TurboModuleRegistry.getEnforcing( - 'NativeAppleEmbeddings' -) - -export default { - // Named like the language and transcription models' getModelInfo - getModelInfo: (language: string) => NativeAppleEmbeddings.getInfo(language), - /** @deprecated Use `getModelInfo` */ - getInfo: (language: string) => NativeAppleEmbeddings.getInfo(language), - prepare: (language: string) => NativeAppleEmbeddings.prepare(language), - generateEmbeddings: (values: string[], language: string) => - NativeAppleEmbeddings.generateEmbeddings(values, language), -} +export default TurboModuleRegistry.getEnforcing('NativeAppleEmbeddings') diff --git a/packages/apple-llm/src/index.ts b/packages/apple-llm/src/index.ts index 095b15dba..991c28556 100644 --- a/packages/apple-llm/src/index.ts +++ b/packages/apple-llm/src/index.ts @@ -26,10 +26,7 @@ export { } from './ai-sdk' export type { AppleLLMError, AppleLLMErrorCode } from './errors' export { AppleLLMErrorCodes } from './errors' -export type { - AppleEmbeddingModelInfo, - EmbeddingInfo, -} from './NativeAppleEmbeddings' +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 aa6e14d50..7de66e6a4 100644 --- a/website/src/docs/apple/embeddings.md +++ b/website/src/docs/apple/embeddings.md @@ -104,7 +104,7 @@ import { const language = 'en' -// Get embedding model information (getInfo is a deprecated alias) +// Get embedding model information const modelInfo: AppleEmbeddingModelInfo = await AppleEmbeddings.getModelInfo(language) // { hasAvailableAssets, dimension, languages, maximumSequenceLength,