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

OpenAiClient overview

Added in v1.0.0


Table of contents


constructors

make

Signature

export declare const make: (options: {
  readonly apiKey?: Redacted.Redacted | undefined
  readonly apiUrl?: string | undefined
  readonly organizationId?: Redacted.Redacted | undefined
  readonly projectId?: Redacted.Redacted | undefined
  readonly transformClient?: (client: HttpClient.HttpClient) => HttpClient.HttpClient
}) => Effect.Effect<OpenAiClient.Service, never, HttpClient.HttpClient>

Added in v1.0.0

layers

layer

Signature

export declare const layer: (options: {
  readonly apiKey?: Redacted.Redacted | undefined
  readonly apiUrl?: string | undefined
  readonly organizationId?: Redacted.Redacted | undefined
  readonly projectId?: Redacted.Redacted | undefined
  readonly transformClient?: (client: HttpClient.HttpClient) => HttpClient.HttpClient
}) => Layer.Layer<OpenAiClient, never, HttpClient.HttpClient>

Added in v1.0.0

layerConfig

Signature

export declare const layerConfig: (
  options: Config.Config.Wrap<{
    readonly apiKey?: Redacted.Redacted | undefined
    readonly apiUrl?: string | undefined
    readonly organizationId?: Redacted.Redacted | undefined
    readonly projectId?: Redacted.Redacted | undefined
    readonly transformClient?: (client: HttpClient.HttpClient) => HttpClient.HttpClient
  }>
) => Layer.Layer<OpenAiClient, ConfigError, HttpClient.HttpClient>

Added in v1.0.0

models

ContentPart (interface)

Signature

export interface ContentPart {
  readonly _tag: "Content"
  readonly name?: string
  readonly content: string
}

Added in v1.0.0

OpenAiClient (namespace)

Added in v1.0.0

Service (interface)

Signature

export interface Service {
  readonly client: Generated.Client
  readonly streamRequest: <A>(
    request: HttpClientRequest.HttpClientRequest
  ) => Stream.Stream<A, HttpClientError.HttpClientError>
  readonly stream: (request: StreamCompletionRequest) => Stream.Stream<StreamChunk, HttpClientError.HttpClientError>
}

Added in v1.0.0

StreamChunk (class)

Signature

export declare class StreamChunk

Added in v1.0.0

StreamChunkPart (type alias)

Signature

export type StreamChunkPart = ContentPart | ToolCallPart | UsagePart

Added in v1.0.0

StreamCompletionRequest (type alias)

Signature

export type StreamCompletionRequest = Omit<typeof Generated.CreateChatCompletionRequest.Encoded, "stream">

Added in v1.0.0

ToolCallPart (interface)

Signature

export interface ToolCallPart {
  readonly _tag: "ToolCall"
  readonly id: string
  readonly name: string
  readonly arguments: unknown
}

Added in v1.0.0

UsagePart (interface)

Signature

export interface UsagePart {
  readonly _tag: "Usage"
  readonly id: string
  readonly model: string
  readonly inputTokens: number
  readonly outputTokens: number
  readonly finishReasons: ReadonlyArray<string>
  readonly systemFingerprint: string
  readonly serviceTier: string | null
}

Added in v1.0.0

tags

OpenAiClient (class)

Signature

export declare class OpenAiClient

Added in v1.0.0