OpenAiEmbeddings.ts overview
Since v1.0.0
Exports Grouped by Category
ai models
model
Signature
declare const model: (
model: (string & {}) | Model,
config: Simplify<
({ readonly mode: "batched" } & Config.Batched) | ({ readonly mode: "data-loader" } & Config.DataLoader)
>
) => AiModel.AiModel<Embeddings.Embeddings | Tokenizer.Tokenizer, OpenAiClient>
Since v1.0.0
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>
}
Since v1.0.0
layers
layer
Signature
declare const layer: (options: {
readonly model: (string & {}) | Model
readonly maxBatchSize?: number
readonly cache?: { readonly capacity: number; readonly timeToLive: Duration.DurationInput }
readonly config?: Config.Service
}) => Layer.Layer<Embeddings.Embeddings, never, OpenAiClient>
Since v1.0.0
layerDataLoader
Signature
declare const layerDataLoader: (options: {
readonly model: (string & {}) | Model
readonly window: Duration.DurationInput
readonly maxBatchSize?: number
readonly config?: Config.Service
}) => Layer.Layer<Embeddings.Embeddings, never, OpenAiClient>
Since v1.0.0
models
Model (type alias)
Signature
type Model = typeof Generated.CreateEmbeddingRequestModelEnum.Encoded
Since v1.0.0
tags
Config (class)
Signature
declare class Config
Since v1.0.0
utils
Config (namespace)
Since v1.0.0
Service (interface)
Signature
export interface Service extends Simplify<Partial<Omit<typeof Generated.CreateEmbeddingRequest.Encoded, "input">>> {}
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
}
}
Since v1.0.
DataLoader (interface)
Signature
export interface DataLoader extends Omit<Config.Service, "model"> {
readonly window: Duration.DurationInput
readonly maxBatchSize?: number
}
Since v1.0.