Skip to main content Link Search Menu Expand Document (external link)

OpenAiEmbeddingModel.ts overview

Since v1.0.0


Exports Grouped by Category


Configuration

withConfigOverride

Signature

declare const withConfigOverride: {
  (config: Config.Service): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
  <A, E, R>(self: Effect.Effect<A, E, R>, config: Config.Service): Effect.Effect<A, E, R>
}

Source

Since v1.0.0

Context

Config (class)

Signature

declare class Config

Source

Since v1.0.0

Models

Model (type alias)

Signature

type Model = typeof Generated.CreateEmbeddingRequestModelEnum.Encoded

Source

Since v1.0.0

model

Signature

declare const model: (
  model: (string & {}) | Model,
  config: Simplify<
    ({ readonly mode: "batched" } & Config.Batched) | ({ readonly mode: "data-loader" } & Config.DataLoader)
  >
) => AiModel.AiModel<AiEmbeddingModel.AiEmbeddingModel | Tokenizer.Tokenizer, OpenAiClient>

Source

Since v1.0.0

utils

Config (namespace)

Source

Since v1.0.0

Service (interface)

Signature

export interface Service extends Simplify<Partial<Omit<typeof Generated.CreateEmbeddingRequest.Encoded, "input">>> {}

Source

Since v1.0.

Batched (interface)

Signature

export interface Batched extends Omit<Config.Service, "model"> {
  readonly maxBatchSize?: number
  readonly cache?: {
    readonly capacity: number
    readonly timeToLive: Duration.DurationInput
  }
}

Source

Since v1.0.

DataLoader (interface)

Signature

export interface DataLoader extends Omit<Config.Service, "model"> {
  readonly window: Duration.DurationInput
  readonly maxBatchSize?: number
}

Source

Since v1.0.