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

OpenAiCompletions.ts overview

Since v1.0.0


Exports Grouped by Category


ai models

model

Signature

declare const model: (
  model: (string & {}) | Model,
  config?: Omit<Config.Service, "model">
) => AiModel.AiModel<Completions.Completions | Tokenizer.Tokenizer, OpenAiClient>

Source

Since v1.0.0

configuration

withConfigOverride

Signature

declare const withConfigOverride: {
  (overrides: 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>, overrides: Config.Service): Effect.Effect<A, E, R>
}

Source

Since v1.0.0

layers

layer

Signature

declare const layer: (options: {
  readonly model: (string & {}) | Model
  readonly config?: Omit<Config.Service, "model">
}) => Layer.Layer<Completions.Completions | Tokenizer.Tokenizer, never, OpenAiClient>

Source

Since v1.0.0

layerCompletions

Signature

declare const layerCompletions: (options: {
  readonly model: (string & {}) | Model
  readonly config?: Omit<Config.Service, "model">
}) => Layer.Layer<Completions.Completions, never, OpenAiClient>

Source

Since v1.0.0

models

Model (type alias)

Signature

type Model = typeof Generated.CreateChatCompletionRequestModelEnum.Encoded

Source

Since v1.0.0

tags

Config (class)

Signature

declare class Config

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.CreateChatCompletionRequest.Encoded,
        "messages" | "tools" | "tool_choice" | "stream" | "stream_options" | "functions"
      >
    >
  > {}

Source

Since v1.0.0