@effect/ai 0.26.0 → 0.27.0

package/dist/esm/Telemetry.js

@@ -0,0 +1,166 @@
+/**
+ * The `Telemetry` module provides OpenTelemetry integration for operations
+ * performed against a large language model provider by defining telemetry
+ * attributes and utilities that follow the OpenTelemetry GenAI semantic
+ * conventions.
+ *
+ * @example
+ * ```ts
+ * import { Telemetry } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * // Add telemetry attributes to a span
+ * const addTelemetry = Effect.gen(function* () {
+ *   const span = yield* Effect.currentSpan
+ *
+ *   Telemetry.addGenAIAnnotations(span, {
+ *     system: "openai",
+ *     operation: { name: "chat" },
+ *     request: {
+ *       model: "gpt-4",
+ *       temperature: 0.7,
+ *       maxTokens: 1000
+ *     },
+ *     usage: {
+ *       inputTokens: 100,
+ *       outputTokens: 50
+ *     }
+ *   })
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ */
+import * as Context from "effect/Context";
+import { dual } from "effect/Function";
+import * as Predicate from "effect/Predicate";
+import * as String from "effect/String";
+/**
+ * Creates a function to add attributes to a span with a given prefix and key transformation.
+ *
+ * This utility function is used internally to create specialized functions for adding
+ * different types of telemetry attributes to OpenTelemetry spans.
+ *
+ * @example
+ * ```ts
+ * import { Telemetry } from "@effect/ai"
+ * import { String, Tracer } from "effect"
+ *
+ * const addCustomAttributes = Telemetry.addSpanAttributes(
+ *   "custom.ai",
+ *   String.camelToSnake
+ * )
+ *
+ * // Usage with a span
+ * declare const span: Tracer.Span
+ * addCustomAttributes(span, {
+ *   modelName: "gpt-4",
+ *   maxTokens: 1000
+ * })
+ * // Results in attributes: "custom.ai.model_name" and "custom.ai.max_tokens"
+ * ```
+ *
+ * @since 1.0.0
+ * @category Utilities
+ */
+export const addSpanAttributes = (
+/**
+ * The prefix to add to all attribute keys.
+ */
+keyPrefix,
+/**
+ * Function to transform attribute keys (e.g., camelCase to snake_case).
+ */
+transformKey) => (
+/**
+ * The OpenTelemetry span to add attributes to.
+ */
+span,
+/**
+ * The attributes to add to the span.
+ */
+attributes) => {
+  for (const [key, value] of Object.entries(attributes)) {
+    if (Predicate.isNotNullable(value)) {
+      span.attribute(`${keyPrefix}.${transformKey(key)}`, value);
+    }
+  }
+};
+const addSpanBaseAttributes = /*#__PURE__*/addSpanAttributes("gen_ai", String.camelToSnake);
+const addSpanOperationAttributes = /*#__PURE__*/addSpanAttributes("gen_ai.operation", String.camelToSnake);
+const addSpanRequestAttributes = /*#__PURE__*/addSpanAttributes("gen_ai.request", String.camelToSnake);
+const addSpanResponseAttributes = /*#__PURE__*/addSpanAttributes("gen_ai.response", String.camelToSnake);
+const addSpanTokenAttributes = /*#__PURE__*/addSpanAttributes("gen_ai.token", String.camelToSnake);
+const addSpanUsageAttributes = /*#__PURE__*/addSpanAttributes("gen_ai.usage", String.camelToSnake);
+/**
+ * Applies GenAI telemetry attributes to an OpenTelemetry span.
+ *
+ * This function adds standardized GenAI attributes to a span following OpenTelemetry
+ * semantic conventions. It supports both curried and direct application patterns.
+ *
+ * **Note**: This function mutates the provided span in-place.
+ *
+ * @example
+ * ```ts
+ * import { Telemetry } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * const directUsage = Effect.gen(function* () {
+ *   const span = yield* Effect.currentSpan
+ *
+ *   Telemetry.addGenAIAnnotations(span, {
+ *     system: "openai",
+ *     request: { model: "gpt-4", temperature: 0.7 },
+ *     usage: { inputTokens: 100, outputTokens: 50 }
+ *   })
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Utilities
+ */
+export const addGenAIAnnotations = /*#__PURE__*/dual(2, (span, options) => {
+  addSpanBaseAttributes(span, {
+    system: options.system
+  });
+  if (Predicate.isNotNullable(options.operation)) addSpanOperationAttributes(span, options.operation);
+  if (Predicate.isNotNullable(options.request)) addSpanRequestAttributes(span, options.request);
+  if (Predicate.isNotNullable(options.response)) addSpanResponseAttributes(span, options.response);
+  if (Predicate.isNotNullable(options.token)) addSpanTokenAttributes(span, options.token);
+  if (Predicate.isNotNullable(options.usage)) addSpanUsageAttributes(span, options.usage);
+});
+/**
+ * Context tag for providing a span transformer to large langauge model
+ * operations.
+ *
+ * The CurrentSpanTransformer allows you to inject custom span transformation
+ * logic into AI operations, enabling application-specific telemetry and
+ * observability patterns.
+ *
+ * @example
+ * ```ts
+ * import { Telemetry } from "@effect/ai"
+ * import { Context, Effect } from "effect"
+ *
+ * // Create a custom span transformer
+ * const loggingTransformer: Telemetry.SpanTransformer = (options) => {
+ *   console.log(`AI request completed: ${options.model}`)
+ *   options.response.forEach((part, index) => {
+ *     console.log(`Part ${index}: ${part.type}`)
+ *   })
+ * }
+ *
+ * // Provide the transformer to your AI operations
+ * const program = myAIOperation.pipe(
+ *   Effect.provideService(
+ *     Telemetry.CurrentSpanTransformer,
+ *     Telemetry.CurrentSpanTransformer.of(loggingTransformer)
+ *   )
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Context
+ */
+export class CurrentSpanTransformer extends /*#__PURE__*/Context.Tag("@effect/ai/Telemetry/CurrentSpanTransformer")() {}
+//# sourceMappingURL=Telemetry.js.map

package/dist/esm/Telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Telemetry.js","names":["Context","dual","Predicate","String","addSpanAttributes","keyPrefix","transformKey","span","attributes","key","value","Object","entries","isNotNullable","attribute","addSpanBaseAttributes","camelToSnake","addSpanOperationAttributes","addSpanRequestAttributes","addSpanResponseAttributes","addSpanTokenAttributes","addSpanUsageAttributes","addGenAIAnnotations","options","system","operation","request","response","token","usage","CurrentSpanTransformer","Tag"],"sources":["../../src/Telemetry.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,SAASC,IAAI,QAAQ,iBAAiB;AACtC,OAAO,KAAKC,SAAS,MAAM,kBAAkB;AAC7C,OAAO,KAAKC,MAAM,MAAM,eAAe;AAiQvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,MAAMC,iBAAiB,GAAGA;AAC/B;;;AAGAC,SAAiB;AACjB;;;AAGAC,YAAqC,KAEvC;AACE;;;AAGAC,IAAU;AACV;;;AAGAC,UAAsB,KACd;EACR,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACJ,UAAU,CAAC,EAAE;IACrD,IAAIN,SAAS,CAACW,aAAa,CAACH,KAAK,CAAC,EAAE;MAClCH,IAAI,CAACO,SAAS,CAAC,GAAGT,SAAS,IAAIC,YAAY,CAACG,GAAG,CAAC,EAAE,EAAEC,KAAK,CAAC;IAC5D;EACF;AACF,CAAC;AAED,MAAMK,qBAAqB,gBAAGX,iBAAiB,CAAC,QAAQ,EAAED,MAAM,CAACa,YAAY,CAAiB;AAC9F,MAAMC,0BAA0B,gBAAGb,iBAAiB,CAAC,kBAAkB,EAAED,MAAM,CAACa,YAAY,CAAsB;AAClH,MAAME,wBAAwB,gBAAGd,iBAAiB,CAAC,gBAAgB,EAAED,MAAM,CAACa,YAAY,CAAoB;AAC5G,MAAMG,yBAAyB,gBAAGf,iBAAiB,CAAC,iBAAiB,EAAED,MAAM,CAACa,YAAY,CAAqB;AAC/G,MAAMI,sBAAsB,gBAAGhB,iBAAiB,CAAC,cAAc,EAAED,MAAM,CAACa,YAAY,CAAkB;AACtG,MAAMK,sBAAsB,gBAAGjB,iBAAiB,CAAC,cAAc,EAAED,MAAM,CAACa,YAAY,CAAkB;AA4DtG;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAMM,mBAAmB,gBA4E5BrB,IAAI,CAyDN,CAAC,EAAE,CAACM,IAAI,EAAEgB,OAAO,KAAI;EACrBR,qBAAqB,CAACR,IAAI,EAAE;IAAEiB,MAAM,EAAED,OAAO,CAACC;EAAM,CAAE,CAAC;EACvD,IAAItB,SAAS,CAACW,aAAa,CAACU,OAAO,CAACE,SAAS,CAAC,EAAER,0BAA0B,CAACV,IAAI,EAAEgB,OAAO,CAACE,SAAS,CAAC;EACnG,IAAIvB,SAAS,CAACW,aAAa,CAACU,OAAO,CAACG,OAAO,CAAC,EAAER,wBAAwB,CAACX,IAAI,EAAEgB,OAAO,CAACG,OAAO,CAAC;EAC7F,IAAIxB,SAAS,CAACW,aAAa,CAACU,OAAO,CAACI,QAAQ,CAAC,EAAER,yBAAyB,CAACZ,IAAI,EAAEgB,OAAO,CAACI,QAAQ,CAAC;EAChG,IAAIzB,SAAS,CAACW,aAAa,CAACU,OAAO,CAACK,KAAK,CAAC,EAAER,sBAAsB,CAACb,IAAI,EAAEgB,OAAO,CAACK,KAAK,CAAC;EACvF,IAAI1B,SAAS,CAACW,aAAa,CAACU,OAAO,CAACM,KAAK,CAAC,EAAER,sBAAsB,CAACd,IAAI,EAAEgB,OAAO,CAACM,KAAK,CAAC;AACzF,CAAC,CAAC;AAsCF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,OAAM,MAAOC,sBAAuB,sBAAQ9B,OAAO,CAAC+B,GAAG,CAAC,6CAA6C,CAAC,EAGnG","ignoreList":[]}

package/dist/esm/Tokenizer.js

@@ -1,41 +1,120 @@
 /**
+ * The `Tokenizer` module provides tokenization and text truncation capabilities
+ * for large language model text processing workflows.
+ *
+ * This module offers services for converting text into tokens and truncating
+ * prompts based on token limits, essential for managing context length
+ * constraints in large language models.
+ *
+ * @example
+ * ```ts
+ * import { Tokenizer, Prompt } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * const tokenizeText = Effect.gen(function* () {
+ *   const tokenizer = yield* Tokenizer.Tokenizer
+ *   const tokens = yield* tokenizer.tokenize("Hello, world!")
+ *   console.log(`Token count: ${tokens.length}`)
+ *   return tokens
+ * })
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { Tokenizer, Prompt } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * // Truncate a prompt to fit within token limits
+ * const truncatePrompt = Effect.gen(function* () {
+ *   const tokenizer = yield* Tokenizer.Tokenizer
+ *   const longPrompt = "This is a very long prompt..."
+ *   const truncated = yield* tokenizer.truncate(longPrompt, 100)
+ *   return truncated
+ * })
+ * ```
+ *
  * @since 1.0.0
  */
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
 import * as Predicate from "effect/Predicate";
-import * as AiInput from "./AiInput.js";
+import * as Prompt from "./Prompt.js";
 /**
+ * The `Tokenizer` service tag for dependency injection.
+ *
+ * This tag provides access to tokenization functionality throughout your
+ * application, enabling token counting and prompt truncation capabilities.
+ *
+ * @example
+ * ```ts
+ * import { Tokenizer } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * const useTokenizer = Effect.gen(function* () {
+ *   const tokenizer = yield* Tokenizer.Tokenizer
+ *   const tokens = yield* tokenizer.tokenize("Hello, world!")
+ *   return tokens.length
+ * })
+ * ```
+ *
  * @since 1.0.0
- * @category Tags
+ * @category Context
  */
 export class Tokenizer extends /*#__PURE__*/Context.Tag("@effect/ai/Tokenizer")() {}
 /**
+ * Creates a Tokenizer service implementation from tokenization options.
+ *
+ * This function constructs a complete Tokenizer service by providing a
+ * tokenization function. The service handles both tokenization and
+ * truncation operations using the provided tokenizer.
+ *
+ * @example
+ * ```ts
+ * import { Tokenizer, Prompt } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * // Simple word-based tokenizer
+ * const wordTokenizer = Tokenizer.make({
+ *   tokenize: (prompt) =>
+ *     Effect.succeed(
+ *       prompt.content
+ *         .flatMap(msg =>
+ *           typeof msg.content === "string"
+ *             ? msg.content.split(' ')
+ *             : msg.content.flatMap(part =>
+ *                 part.type === "text" ? part.text.split(' ') : []
+ *               )
+ *         )
+ *         .map((_, index) => index)
+ *     )
+ * })
+ * ```
+ *
  * @since 1.0.0
  * @category Constructors
  */
 export const make = options => Tokenizer.of({
   tokenize(input) {
-    return options.tokenize(AiInput.make(input));
+    return options.tokenize(Prompt.make(input));
   },
   truncate(input, tokens) {
-    return truncate(AiInput.make(input), options.tokenize, tokens);
+    return truncate(Prompt.make(input), options.tokenize, tokens);
   }
 });
 const truncate = (self, tokenize, maxTokens) => Effect.suspend(() => {
   let count = 0;
-  let inputMessages = self.messages;
+  let inputMessages = self.content;
   let outputMessages = [];
   const loop = Effect.suspend(() => {
     const message = inputMessages[inputMessages.length - 1];
     if (Predicate.isUndefined(message)) {
-      return Effect.succeed(AiInput.make(outputMessages));
+      return Effect.succeed(Prompt.fromMessages(outputMessages));
     }
     inputMessages = inputMessages.slice(0, inputMessages.length - 1);
-    return Effect.flatMap(tokenize(AiInput.make(message)), tokens => {
+    return Effect.flatMap(tokenize(Prompt.fromMessages([message])), tokens => {
       count += tokens.length;
       if (count > maxTokens) {
-        return Effect.succeed(AiInput.make(outputMessages));
+        return Effect.succeed(Prompt.fromMessages(outputMessages));
       }
       outputMessages = [message, ...outputMessages];
       return loop;

package/dist/esm/Tokenizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tokenizer.js","names":["Context","Effect","Predicate","AiInput","Tokenizer","Tag","make","options","of","tokenize","input","truncate","tokens","self","maxTokens","suspend","count","inputMessages","messages","outputMessages","loop","message","length","isUndefined","succeed","slice","flatMap"],"sources":["../../src/Tokenizer.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,SAAS,MAAM,kBAAkB;AAE7C,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;;AAIA,OAAM,MAAOC,SAAU,sBAAQJ,OAAO,CAACK,GAAG,CAAC,sBAAsB,CAAC,EAG/D;AAgBH;;;;AAIA,OAAO,MAAMC,IAAI,GAAIC,OAEpB,IACCH,SAAS,CAACI,EAAE,CAAC;EACXC,QAAQA,CAACC,KAAK;IACZ,OAAOH,OAAO,CAACE,QAAQ,CAACN,OAAO,CAACG,IAAI,CAACI,KAAK,CAAC,CAAC;EAC9C,CAAC;EACDC,QAAQA,CAACD,KAAK,EAAEE,MAAM;IACpB,OAAOD,QAAQ,CAACR,OAAO,CAACG,IAAI,CAACI,KAAK,CAAC,EAAEH,OAAO,CAACE,QAAQ,EAAEG,MAAM,CAAC;EAChE;CACD,CAAC;AAEJ,MAAMD,QAAQ,GAAGA,CACfE,IAAqB,EACrBJ,QAA2E,EAC3EK,SAAiB,KAEjBb,MAAM,CAACc,OAAO,CAAC,MAAK;EAClB,IAAIC,KAAK,GAAG,CAAC;EACb,IAAIC,aAAa,GAAGJ,IAAI,CAACK,QAAQ;EACjC,IAAIC,cAAc,GAA2B,EAAE;EAC/C,MAAMC,IAAI,GAA4CnB,MAAM,CAACc,OAAO,CAAC,MAAK;IACxE,MAAMM,OAAO,GAAGJ,aAAa,CAACA,aAAa,CAACK,MAAM,GAAG,CAAC,CAAC;IACvD,IAAIpB,SAAS,CAACqB,WAAW,CAACF,OAAO,CAAC,EAAE;MAClC,OAAOpB,MAAM,CAACuB,OAAO,CAACrB,OAAO,CAACG,IAAI,CAACa,cAAc,CAAC,CAAC;IACrD;IACAF,aAAa,GAAGA,aAAa,CAACQ,KAAK,CAAC,CAAC,EAAER,aAAa,CAACK,MAAM,GAAG,CAAC,CAAC;IAChE,OAAOrB,MAAM,CAACyB,OAAO,CAACjB,QAAQ,CAACN,OAAO,CAACG,IAAI,CAACe,OAAO,CAAC,CAAC,EAAGT,MAAM,IAAI;MAChEI,KAAK,IAAIJ,MAAM,CAACU,MAAM;MACtB,IAAIN,KAAK,GAAGF,SAAS,EAAE;QACrB,OAAOb,MAAM,CAACuB,OAAO,CAACrB,OAAO,CAACG,IAAI,CAACa,cAAc,CAAC,CAAC;MACrD;MACAA,cAAc,GAAG,CAACE,OAAO,EAAE,GAAGF,cAAc,CAAC;MAC7C,OAAOC,IAAI;IACb,CAAC,CAAC;EACJ,CAAC,CAAC;EACF,OAAOA,IAAI;AACb,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"Tokenizer.js","names":["Context","Effect","Predicate","Prompt","Tokenizer","Tag","make","options","of","tokenize","input","truncate","tokens","self","maxTokens","suspend","count","inputMessages","content","outputMessages","loop","message","length","isUndefined","succeed","fromMessages","slice","flatMap"],"sources":["../../src/Tokenizer.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,SAAS,MAAM,kBAAkB;AAE7C,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAM,MAAOC,SAAU,sBAAQJ,OAAO,CAACK,GAAG,CAAC,sBAAsB,CAAC,EAG/D;AAkDH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,OAAO,MAAMC,IAAI,GAAIC,OAUpB,IACCH,SAAS,CAACI,EAAE,CAAC;EACXC,QAAQA,CAACC,KAAK;IACZ,OAAOH,OAAO,CAACE,QAAQ,CAACN,MAAM,CAACG,IAAI,CAACI,KAAK,CAAC,CAAC;EAC7C,CAAC;EACDC,QAAQA,CAACD,KAAK,EAAEE,MAAM;IACpB,OAAOD,QAAQ,CAACR,MAAM,CAACG,IAAI,CAACI,KAAK,CAAC,EAAEH,OAAO,CAACE,QAAQ,EAAEG,MAAM,CAAC;EAC/D;CACD,CAAC;AAEJ,MAAMD,QAAQ,GAAGA,CACfE,IAAmB,EACnBJ,QAAiF,EACjFK,SAAiB,KAEjBb,MAAM,CAACc,OAAO,CAAC,MAAK;EAClB,IAAIC,KAAK,GAAG,CAAC;EACb,IAAIC,aAAa,GAAGJ,IAAI,CAACK,OAAO;EAChC,IAAIC,cAAc,GAA0B,EAAE;EAC9C,MAAMC,IAAI,GAAkDnB,MAAM,CAACc,OAAO,CAAC,MAAK;IAC9E,MAAMM,OAAO,GAAGJ,aAAa,CAACA,aAAa,CAACK,MAAM,GAAG,CAAC,CAAC;IACvD,IAAIpB,SAAS,CAACqB,WAAW,CAACF,OAAO,CAAC,EAAE;MAClC,OAAOpB,MAAM,CAACuB,OAAO,CAACrB,MAAM,CAACsB,YAAY,CAACN,cAAc,CAAC,CAAC;IAC5D;IACAF,aAAa,GAAGA,aAAa,CAACS,KAAK,CAAC,CAAC,EAAET,aAAa,CAACK,MAAM,GAAG,CAAC,CAAC;IAChE,OAAOrB,MAAM,CAAC0B,OAAO,CAAClB,QAAQ,CAACN,MAAM,CAACsB,YAAY,CAAC,CAACJ,OAAO,CAAC,CAAC,CAAC,EAAGT,MAAM,IAAI;MACzEI,KAAK,IAAIJ,MAAM,CAACU,MAAM;MACtB,IAAIN,KAAK,GAAGF,SAAS,EAAE;QACrB,OAAOb,MAAM,CAACuB,OAAO,CAACrB,MAAM,CAACsB,YAAY,CAACN,cAAc,CAAC,CAAC;MAC5D;MACAA,cAAc,GAAG,CAACE,OAAO,EAAE,GAAGF,cAAc,CAAC;MAC7C,OAAOC,IAAI;IACb,CAAC,CAAC;EACJ,CAAC,CAAC;EACF,OAAOA,IAAI;AACb,CAAC,CAAC","ignoreList":[]}