Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions harness/apple/embeddings.device.harness.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
4 changes: 2 additions & 2 deletions packages/apple-llm/ios/embeddings/AppleEmbeddings.mm
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ + (NSString *)moduleName {
return std::make_shared<react::NativeAppleEmbeddingsSpecJSI>(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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
4 changes: 2 additions & 2 deletions packages/apple-llm/src/NativeAppleEmbeddings.ts
Original file line number Diff line number Diff line change
@@ -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[]
Expand All @@ -12,7 +12,7 @@ export interface EmbeddingInfo {
}

export interface Spec extends TurboModule {
getInfo(language: string): Promise<EmbeddingInfo>
getModelInfo(language: string): Promise<AppleEmbeddingModelInfo>
prepare(language: string): Promise<void>
generateEmbeddings(values: string[], language: string): Promise<number[][]>
}
Expand Down
5 changes: 5 additions & 0 deletions packages/apple-llm/src/ai-sdk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<EmbeddingModelV4Result> {
Expand Down
1 change: 1 addition & 0 deletions packages/apple-llm/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
36 changes: 17 additions & 19 deletions website/src/docs/apple/embeddings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<number[][]>

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
Expand Down
Loading