@effect/ai-openai 0.17.0 → 0.18.0

package/src/OpenAiTelemetry.ts

@@ -15,105 +15,100 @@ import type { Simplify } from "effect/Types"
  * {@see https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/}
  *
  * @since 1.0.0
- * @category models
+ * @category Models
  */
 export type OpenAiTelemetryAttributes = Simplify<
   & AiTelemetry.GenAITelemetryAttributes
-  & AiTelemetry.GenAI.AttributesWithPrefix<OpenAiTelemetry.RequestAttributes, "gen_ai.openai.request">
-  & AiTelemetry.GenAI.AttributesWithPrefix<OpenAiTelemetry.ResponseAttributes, "gen_ai.openai.request">
+  & AiTelemetry.AttributesWithPrefix<RequestAttributes, "gen_ai.openai.request">
+  & AiTelemetry.AttributesWithPrefix<ResponseAttributes, "gen_ai.openai.request">
 >
 
 /**
+ * All telemetry attributes which are part of the GenAI specification,
+ * including the OpenAi-specific attributes.
+ *
  * @since 1.0.0
+ * @category Models
  */
-export declare namespace OpenAiTelemetry {
-  /**
-   * All telemetry attributes which are part of the GenAI specification,
-   * including the OpenAi-specific attributes.
-   *
-   * @since 1.0.0
-   * @category models
-   */
-  export type AllAttributes = AiTelemetry.GenAI.AllAttributes & RequestAttributes & ResponseAttributes
+export type AllAttributes = AiTelemetry.AllAttributes & RequestAttributes & ResponseAttributes
 
+/**
+ * Telemetry attributes which are part of the GenAI specification and are
+ * namespaced by `gen_ai.openai.request`.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface RequestAttributes {
   /**
-   * Telemetry attributes which are part of the GenAI specification and are
-   * namespaced by `gen_ai.openai.request`.
-   *
-   * @since 1.0.0
-   * @category models
+   * The response format that is requested.
    */
-  export interface RequestAttributes {
-    /**
-     * The response format that is requested.
-     */
-    readonly responseFormat?: (string & {}) | WellKnownResponseFormat | null | undefined
-    /**
-     * The service tier requested. May be a specific tier, `default`, or `auto`.
-     */
-    readonly serviceTier?: (string & {}) | WellKnownServiceTier | null | undefined
-  }
-
+  readonly responseFormat?: (string & {}) | WellKnownResponseFormat | null | undefined
   /**
-   * Telemetry attributes which are part of the GenAI specification and are
-   * namespaced by `gen_ai.openai.response`.
-   *
-   * @since 1.0.0
-   * @category models
+   * The service tier requested. May be a specific tier, `default`, or `auto`.
    */
-  export interface ResponseAttributes {
-    /**
-     * The service tier used for the response.
-     */
-    readonly serviceTier?: string | null | undefined
-    /**
-     * A fingerprint to track any eventual change in the Generative AI
-     * environment.
-     */
-    readonly systemFingerprint?: string | null | undefined
-  }
+  readonly serviceTier?: (string & {}) | WellKnownServiceTier | null | undefined
+}
 
+/**
+ * Telemetry attributes which are part of the GenAI specification and are
+ * namespaced by `gen_ai.openai.response`.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export interface ResponseAttributes {
   /**
-   * The `gen_ai.openai.request.response_format` attribute has the following
-   * list of well-known values.
-   *
-   * If one of them applies, then the respective value **MUST** be used;
-   * otherwise, a custom value **MAY** be used.
-   *
-   * @since 1.0.0
-   * @category models
+   * The service tier used for the response.
    */
-  export type WellKnownResponseFormat = "json_object" | "json_schema" | "text"
-
+  readonly serviceTier?: string | null | undefined
   /**
-   * The `gen_ai.openai.request.service_tier` attribute has the following
-   * list of well-known values.
-   *
-   * If one of them applies, then the respective value **MUST** be used;
-   * otherwise, a custom value **MAY** be used.
-   *
-   * @since 1.0.0
-   * @category models
+   * A fingerprint to track any eventual change in the Generative AI
+   * environment.
    */
-  export type WellKnownServiceTier = "auto" | "default"
+  readonly systemFingerprint?: string | null | undefined
 }
 
+/**
+ * The `gen_ai.openai.request.response_format` attribute has the following
+ * list of well-known values.
+ *
+ * If one of them applies, then the respective value **MUST** be used;
+ * otherwise, a custom value **MAY** be used.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type WellKnownResponseFormat = "json_object" | "json_schema" | "text"
+
+/**
+ * The `gen_ai.openai.request.service_tier` attribute has the following
+ * list of well-known values.
+ *
+ * If one of them applies, then the respective value **MUST** be used;
+ * otherwise, a custom value **MAY** be used.
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+export type WellKnownServiceTier = "auto" | "default"
+
 /**
  * @since 1.0.0
- * @since models
+ * @since Models
  */
 export type OpenAiTelemetryAttributeOptions = AiTelemetry.GenAITelemetryAttributeOptions & {
   openai?: {
-    request?: OpenAiTelemetry.RequestAttributes | undefined
-    response?: OpenAiTelemetry.ResponseAttributes | undefined
+    request?: RequestAttributes | undefined
+    response?: ResponseAttributes | undefined
   } | undefined
 }
 
 const addOpenAiRequestAttributes = AiTelemetry.addSpanAttributes("gen_ai.openai.request", String.camelToSnake)<
-  OpenAiTelemetry.RequestAttributes
+  RequestAttributes
 >
 const addOpenAiResponseAttributes = AiTelemetry.addSpanAttributes("gen_ai.openai.response", String.camelToSnake)<
-  OpenAiTelemetry.ResponseAttributes
+  ResponseAttributes
 >
 
 /**
@@ -123,7 +118,7 @@ const addOpenAiResponseAttributes = AiTelemetry.addSpanAttributes("gen_ai.openai
  * **NOTE**: This method will mutate the `Span` **in-place**.
  *
  * @since 1.0.0
- * @since utilities
+ * @since Utilities
  */
 export const addGenAIAnnotations = dual<
   /**
@@ -133,7 +128,7 @@ export const addGenAIAnnotations = dual<
    * **NOTE**: This method will mutate the `Span` **in-place**.
    *
    * @since 1.0.0
-   * @since utilities
+   * @since Utilities
    */
   (options: OpenAiTelemetryAttributeOptions) => (span: Span) => void,
   /**
@@ -143,7 +138,7 @@ export const addGenAIAnnotations = dual<
    * **NOTE**: This method will mutate the `Span` **in-place**.
    *
    * @since 1.0.0
-   * @since utilities
+   * @since Utilities
    */
   (span: Span, options: OpenAiTelemetryAttributeOptions) => void
 >(2, (span, options) => {

package/src/OpenAiTokenizer.ts

@@ -2,50 +2,59 @@
  * @since 1.0.0
  */
 import { AiError } from "@effect/ai/AiError"
+import type * as AiInput from "@effect/ai/AiInput"
 import * as Tokenizer from "@effect/ai/Tokenizer"
 import * as Arr from "effect/Array"
-import * as Chunk from "effect/Chunk"
 import * as Effect from "effect/Effect"
 import * as Layer from "effect/Layer"
 import * as Option from "effect/Option"
+import * as Predicate from "effect/Predicate"
 import * as GptTokenizer from "gpt-tokenizer"
 
 /**
  * @since 1.0.0
- * @category constructors
+ * @category Constructors
  */
 export const make = (options: { readonly model: string }) =>
   Tokenizer.make({
-    tokenize(content) {
+    tokenize(input) {
       return Effect.try({
         try: () =>
           GptTokenizer.encodeChat(
-            content.pipe(
-              Chunk.toReadonlyArray,
-              Arr.flatMap((message) =>
-                message.parts.pipe(
-                  Arr.filterMap((part) => {
-                    if (part._tag === "Image" || part._tag === "ImageUrl") {
-                      return Option.none()
-                    }
-                    return Option.some(
-                      {
-                        role: message.role.kind === "user" ? "user" : "assistant",
-                        name: message.role._tag === "UserWithName" ? message.role.name : undefined,
-                        content: part._tag === "Text"
-                          ? part.content
-                          : JSON.stringify(part._tag === "ToolCall" ? part.params : part.value)
-                      } as const
-                    )
-                  })
-                )
-              )
-            ),
+            Arr.flatMap(input.messages, (message) =>
+              Arr.filterMap(
+                message.parts as Array<
+                  | AiInput.AssistantMessagePart
+                  | AiInput.ToolMessagePart
+                  | AiInput.UserMessagePart
+                >,
+                (part) => {
+                  if (
+                    part._tag === "FilePart" ||
+                    part._tag === "FileUrlPart" ||
+                    part._tag === "ImagePart" ||
+                    part._tag === "ImageUrlPart" ||
+                    part._tag === "ReasoningPart" ||
+                    part._tag === "RedactedReasoningPart"
+                  ) return Option.none()
+                  return Option.some(
+                    {
+                      role: message._tag === "UserMessage" ? "user" : "assistant",
+                      name: message._tag === "UserMessage" && Predicate.isNotUndefined(message.userName)
+                        ? message.userName
+                        : undefined,
+                      content: part._tag === "TextPart"
+                        ? part.text
+                        : JSON.stringify(part._tag === "ToolCallPart" ? part.params : part.result)
+                    } as const
+                  )
+                }
+              )),
             options.model as any
           ),
         catch: (cause) =>
           new AiError({
-            module: "OpenAiCompletions",
+            module: "OpenAiTokenizer",
             method: "tokenize",
             description: "Could not tokenize",
             cause
@@ -56,7 +65,7 @@ export const make = (options: { readonly model: string }) =>
 
 /**
  * @since 1.0.0
- * @category layers
+ * @category Layers
  */
 export const layer = (options: { readonly model: string }): Layer.Layer<Tokenizer.Tokenizer> =>
   Layer.succeed(Tokenizer.Tokenizer, make(options))

package/src/index.ts

@@ -11,17 +11,17 @@ export * as OpenAiClient from "./OpenAiClient.js"
 /**
  * @since 1.0.0
  */
-export * as OpenAiCompletions from "./OpenAiCompletions.js"
+export * as OpenAiConfig from "./OpenAiConfig.js"
 
 /**
  * @since 1.0.0
  */
-export * as OpenAiConfig from "./OpenAiConfig.js"
+export * as OpenAiEmbeddingModel from "./OpenAiEmbeddingModel.js"
 
 /**
  * @since 1.0.0
  */
-export * as OpenAiEmbeddings from "./OpenAiEmbeddings.js"
+export * as OpenAiLanguageModel from "./OpenAiLanguageModel.js"
 
 /**
  * @since 1.0.0

package/src/internal/utilities.ts

@@ -0,0 +1,19 @@
+import type * as AiResponse from "@effect/ai/AiResponse"
+import * as Predicate from "effect/Predicate"
+
+/** @internal */
+export const ProviderMetadataKey = "@effect/ai-openai/OpenAiLanguageModel/ProviderMetadata"
+
+const finishReasonMap: Record<string, AiResponse.FinishReason> = {
+  content_filter: "content-filter",
+  function_call: "tool-calls",
+  length: "length",
+  stop: "stop",
+  tool_calls: "tool-calls"
+}
+
+/** @internal */
+export const resolveFinishReason = (finishReason: string): AiResponse.FinishReason => {
+  const reason = finishReasonMap[finishReason]
+  return Predicate.isUndefined(reason) ? "unknown" : reason
+}

package/OpenAiCompletions/package.json

@@ -1,6 +0,0 @@
-{
-  "sideEffects": [],
-  "main": "../dist/cjs/OpenAiCompletions.js",
-  "module": "../dist/esm/OpenAiCompletions.js",
-  "types": "../dist/dts/OpenAiCompletions.d.ts"
-}

package/OpenAiEmbeddings/package.json

@@ -1,6 +0,0 @@
-{
-  "sideEffects": [],
-  "main": "../dist/cjs/OpenAiEmbeddings.js",
-  "module": "../dist/esm/OpenAiEmbeddings.js",
-  "types": "../dist/dts/OpenAiEmbeddings.d.ts"
-}