@effect/ai 0.26.0 → 0.27.0

package/dist/cjs/AiResponse.js

@@ -1,681 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.withToolCallsJson = exports.merge = exports.isStructured = exports.isPart = exports.is = exports.hasToolCallResults = exports.empty = exports.WithToolCallResultsTypeId = exports.WithToolCallResults = exports.WithStructuredOutput = exports.Usage = exports.UrlAnnotation = exports.TypeId = exports.ToolCallPart = exports.ToolCallId = exports.TextPart = exports.StructuredResponseTypeId = exports.RedactedReasoningPart = exports.ReasoningPart = exports.PartTypeId = exports.Part = exports.MetadataPart = exports.FromJson = exports.FinishReason = exports.FinishPart = exports.FileAnnotation = exports.ContentSourceAnnotation = exports.Annotation = exports.AiResponse = void 0;
-var Effect = _interopRequireWildcard(require("effect/Effect"));
-var _Function = require("effect/Function");
-var Option = _interopRequireWildcard(require("effect/Option"));
-var Predicate = _interopRequireWildcard(require("effect/Predicate"));
-var Schema = _interopRequireWildcard(require("effect/Schema"));
-var _AiError = require("./AiError.js");
-var InternalCommon = _interopRequireWildcard(require("./internal/common.js"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-const constDisableValidation = {
-  disableValidation: true
-};
-/**
- * @since 1.0.0
- * @category Type Ids
- */
-const TypeId = exports.TypeId = /*#__PURE__*/Symbol.for("@effect/ai/AiResponse");
-/**
- * Represents a response received from a large language model.
- *
- * @since 1.0.0
- * @category Models
- */
-class AiResponse extends /*#__PURE__*/Schema.Class("@effect/ai/AiResponse")({
-  /**
-   * The parts of the response.
-   */
-  parts: /*#__PURE__*/Schema.Array(/*#__PURE__*/Schema.suspend(() => Part))
-}) {
-  /**
-   * @since 1.0.0
-   */
-  [TypeId] = TypeId;
-  /**
-   * Returns the generated text content of the response.
-   */
-  get text() {
-    let text = "";
-    let found = false;
-    for (const part of this.parts) {
-      if (part._tag === "TextPart") {
-        text += found ? "\n\n" + part.text : part.text;
-        found = true;
-      }
-    }
-    return text;
-  }
-  /**
-   * Returns the finish reason for the response, or `"unknown"` if the finish
-   * reason is not known.
-   */
-  get finishReason() {
-    const finishPart = this.parts.find(part => part._tag === "FinishPart");
-    return finishPart?.reason ?? "unknown";
-  }
-  /**
-   * Returns all tool calls contained within the response.
-   */
-  get toolCalls() {
-    return this.parts.filter(part => part._tag === "ToolCallPart");
-  }
-  /**
-   * Attempts to retrieve provider-specific response metadata.
-   */
-  getProviderMetadata(tag) {
-    const finishPart = this.parts.find(part => part._tag === "FinishPart");
-    return Option.fromNullable(finishPart?.providerMetadata[tag.key]);
-  }
-}
-/**
- * @since 1.0.0
- * @category Models
- */
-exports.AiResponse = AiResponse;
-const FromJson = exports.FromJson = /*#__PURE__*/Schema.parseJson(AiResponse);
-/**
- * @since 1.0.0
- * @category Type Ids
- */
-const StructuredResponseTypeId = exports.StructuredResponseTypeId = /*#__PURE__*/Symbol.for("@effect/ai/AiResponse/StructuredResponse");
-/**
- * Represents a response generated by a large language model that includes
- * structured output.
- *
- * @since 1.0.0
- * @category Models
- */
-class WithStructuredOutput extends AiResponse {
-  /**
-   * @since 1.0.0
-   */
-  [StructuredResponseTypeId] = StructuredResponseTypeId;
-  /**
-   * The identifier of the tool which generated the structured output.
-   */
-  id;
-  /**
-   * The name of the tool which generated the structured output.
-   */
-  name;
-  /**
-   * The structured output generated by the model.
-   */
-  value;
-  constructor(props, options) {
-    super({
-      parts: props.parts
-    }, options);
-    this.id = props.id;
-    this.name = props.name;
-    this.value = props.value;
-  }
-}
-/**
- * @since 1.0.0
- * @category Type Ids
- */
-exports.WithStructuredOutput = WithStructuredOutput;
-const WithToolCallResultsTypeId = exports.WithToolCallResultsTypeId = /*#__PURE__*/Symbol.for("@effect/ai/AiResponse/WithToolCallResults");
-/**
- * Represents a response generated by a large language model that includes
- * tool call results.
- *
- * @since 1.0.0
- * @category Models
- */
-class WithToolCallResults extends AiResponse {
-  /**
-   * @since 1.0.0
-   */
-  [WithToolCallResultsTypeId] = WithToolCallResultsTypeId;
-  /**
-   * The tool call results, represented as a mapping between the tool call
-   * identifier and the result of the tool call handler.
-   */
-  results;
-  /**
-   * The encoded tool call results, suitable for incorporation into subsequent
-   * requests to the large language model.
-   */
-  encodedResults;
-  constructor(props, options) {
-    super({
-      parts: props.parts
-    }, options);
-    this.results = props.results;
-    this.encodedResults = props.encodedResults;
-  }
-  getToolCallResult(toolName) {
-    for (const {
-      name,
-      result
-    } of this.results.values()) {
-      if (name === toolName) {
-        return Option.some(result);
-      }
-    }
-    return Option.none();
-  }
-}
-// =============================================================================
-// Part
-// =============================================================================
-/**
- * @since 1.0.0
- * @category Type Ids
- */
-exports.WithToolCallResults = WithToolCallResults;
-const PartTypeId = exports.PartTypeId = /*#__PURE__*/Symbol.for("@effect/ai/AiResponse/Part");
-/**
- * Represents a content source that was used to generate a model response.
- *
- * @since 1.0.0
- * @category Models
- */
-class ContentSourceAnnotation extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/Annotation/ContentSourceAnnotation")("ContentSourceAnnotation", {
-  /**
-   * The identifier for the content source.
-   */
-  id: Schema.String,
-  /**
-   * The index of the content source in the list of sources provided in the
-   * model request parameters.
-   */
-  index: Schema.Int,
-  /**
-   * The provider-specific type of the file annotation.
-   *
-   * For example, when using Anthropic the type may be `char_location`,
-   * `page_location`, or `content_block_location`.
-   */
-  type: Schema.String,
-  /**
-   * The content used from the content source in the message generated by the
-   * model.
-   */
-  referencedContent: Schema.String,
-  /**
-   * The index of the first character of the content referenced by the content
-   * source in the message generated by the model.
-   */
-  startIndex: Schema.Int,
-  /**
-   * The index of the last character of the content referenced by the content
-   * source in the message generated by the model.
-   */
-  endIndex: Schema.Int
-}) {}
-/**
- * Represents a file that was used to generate a model response.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.ContentSourceAnnotation = ContentSourceAnnotation;
-class FileAnnotation extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/Annotation/FileAnnotation")("FileAnnotation", {
-  /**
-   * The identifier for the file.
-   */
-  id: Schema.String,
-  /**
-   * The provider-specific type of the file annotation.
-   *
-   * For example, when using OpenAi the type may be `file_citation` or
-   * `file_path`.
-   */
-  type: Schema.String,
-  /**
-   * The index of the file in the list of files provided in the model request
-   * parameters.
-   */
-  index: Schema.Int
-}) {}
-/**
- * Represents a web resource that was used to generate a model response.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.FileAnnotation = FileAnnotation;
-class UrlAnnotation extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/Annotation/UrlAnnotation")("UrlAnnotation", {
-  /**
-   * The URL of the web resource.
-   */
-  url: Schema.String,
-  /**
-   * The title of the web resource.
-   */
-  title: Schema.String,
-  /**
-   * The index of the first character of the content referenced by the web
-   * resource in the message generated by the model.
-   */
-  startIndex: Schema.Int,
-  /**
-   * The index of the last character of the content referenced by the web
-   * resource in the message generated by the model.
-   */
-  endIndex: Schema.Int
-}) {}
-/**
- * Represents annotations that were used to support the message generated by
- * a model.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.UrlAnnotation = UrlAnnotation;
-const Annotation = exports.Annotation = /*#__PURE__*/Schema.Union(ContentSourceAnnotation, FileAnnotation, UrlAnnotation);
-/**
- * Represents part of the text generated by the model.
- *
- * @since 1.0.0
- * @category Models
- */
-class TextPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/TextPart")("TextPart", {
-  /**
-   * The text content generated by the model.
-   */
-  text: Schema.String,
-  /**
-   * The annotations used to support the text generated by the model.
-   */
-  annotations: /*#__PURE__*/Schema.optionalWith(/*#__PURE__*/Schema.Array(Annotation), {
-    default: () => []
-  })
-}) {
-  /**
-   * @since 1.0.0
-   */
-  [PartTypeId] = PartTypeId;
-}
-/**
- * Represents part of the reasoning carried out by the model to generate a
- * response.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.TextPart = TextPart;
-class ReasoningPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/ReasoningPart")("ReasoningPart", {
-  /**
-   * The reasoning content that the model used to return the output.
-   */
-  reasoningText: Schema.String,
-  /**
-   * An optional signature which verifies that the reasoning text was generated
-   * by the model.
-   */
-  signature: /*#__PURE__*/Schema.optional(Schema.String)
-}) {
-  /**
-   * @since 1.0.0
-   */
-  [PartTypeId] = PartTypeId;
-}
-/**
- * Represents part of the reasoning carried out by the model to generate a
- * response which needed to be encrypted by the model provider for safety
- * reasons.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.ReasoningPart = ReasoningPart;
-class RedactedReasoningPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/RedactedReasoningPart")("RedactedReasoningPart", {
-  /**
-   * The content in the reasoning that was encrypted by the model provider for
-   * safety reasons.
-   */
-  redactedText: Schema.String
-}) {
-  /**
-   * @since 1.0.0
-   */
-  [PartTypeId] = PartTypeId;
-}
-/**
- * Represents the identifier generated by a model when a tool call is requested.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.RedactedReasoningPart = RedactedReasoningPart;
-const ToolCallId = exports.ToolCallId = InternalCommon.ToolCallId;
-/**
- * Represents a request by a model to call a specific tool that it has been
- * provided with.
- *
- * @since 1.0.0
- * @category Models
- */
-class ToolCallPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/ToolCallPart")("ToolCallPart", {
-  /**
-   * The identifier generated by a model when requesting a tool call.
-   */
-  id: ToolCallId,
-  /**
-   * The name of the tool to call.
-   */
-  name: Schema.String,
-  /**
-   * The arguments to call the tool with as a JSON-serializable object that
-   * matches the tool call input schema.
-   */
-  params: Schema.Unknown
-}) {
-  /**
-   * @since 1.0.0
-   */
-  [PartTypeId] = PartTypeId;
-  /**
-   * Converts a raw tool call into a `ToolCallPart` by parsing tool call
-   * parameters as a JSON string. If your tool call parameters are already
-   * parsed, use `ToolCallPart.fromUnknown`.
-   *
-   * @since 1.0.0
-   */
-  static fromJson({
-    id,
-    name,
-    params
-  }) {
-    return Effect.try({
-      try() {
-        return new ToolCallPart({
-          id: ToolCallId.make(id, constDisableValidation),
-          name,
-          params: JSON.parse(params)
-        }, constDisableValidation);
-      },
-      catch: cause => new _AiError.AiError({
-        module: "AiResponse",
-        method: "ToolCall.fromJson",
-        description: `Failed to parse parameters from JSON:\n${params}`,
-        cause
-      })
-    });
-  }
-  /**
-   * Converts a raw tool call into a `ToolCallPart` assuming that the tool call
-   * parameters have already been parsed. If your tool call parameters have not
-   * already been parsed, use `ToolCallPart.fromJson`.
-   *
-   * @since 1.0.0
-   */
-  static fromUnknown({
-    id,
-    name,
-    params
-  }) {
-    return new ToolCallPart({
-      id: ToolCallId.make(id, constDisableValidation),
-      name,
-      params
-    }, constDisableValidation);
-  }
-}
-/**
- * Represents the initial response metadata generated by a model when responding
- * to a request.
- *
- * @since 1.0.0
- * @categor Models
- */
-exports.ToolCallPart = ToolCallPart;
-class MetadataPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/MetadataPart")("MetadataPart", {
-  /**
-   * The unique identifier for the response. Each chunk of the response should
-   * have the same identifier.
-   */
-  id: /*#__PURE__*/Schema.optional(Schema.String),
-  /**
-   * The model that was used to generate the response.
-   */
-  model: Schema.String,
-  /**
-   * The Unix timestamp of when the model began generated the response.
-   */
-  timestamp: /*#__PURE__*/Schema.optional(Schema.DateFromNumber)
-}) {
-  /**
-   * @since 1.0.0
-   */
-  [PartTypeId] = PartTypeId;
-}
-/**
- * Represents the reason why a model finished generation of a response.
- *
- * Possible finish reasons:
- * - `"stop"`: The model generated a stop sequence.
- * - `"length"`: The model exceeded its token budget.
- * - `"content-filter"`: The model generated content which violated a content filter.
- * - `"tool-calls"`: The model triggered a tool call.
- * - `"error"`: The model encountered an error.
- * - `"other"`: The model stopped for a reason not supported by this protocol.
- * - `"unknown"`: The model did not specify a finish reason.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.MetadataPart = MetadataPart;
-const FinishReason = exports.FinishReason = /*#__PURE__*/Schema.Literal("stop", "length", "content-filter", "tool-calls", "error", "other", "unknown");
-/**
- * Represents information about the number of tokens used by the model to
- * generate a response.
- *
- * @since 1.0.0
- * @category Models
- */
-class Usage extends /*#__PURE__*/Schema.Class("@effect/ai/AiResponse/Usage")({
-  /**
-   * The number of tokens sent in the request to the model.
-   */
-  inputTokens: Schema.Number,
-  /**
-   * The number of tokens that the model generated for the request.
-   */
-  outputTokens: Schema.Number,
-  /**
-   * The total of number of input tokens and output tokens generated by the
-   * model.
-   */
-  totalTokens: Schema.Number,
-  /**
-   * The number of reasoning tokens that the model used to generate the output
-   * for the request.
-   */
-  reasoningTokens: Schema.Number,
-  /**
-   * The number of input tokens read from the prompt cache for the request.
-   */
-  cacheReadInputTokens: Schema.Number,
-  /**
-   * The number of input tokens written to the prompt cache for the request.
-   */
-  cacheWriteInputTokens: Schema.Number
-}) {}
-/**
- * Represents the final part of a response generated by a large language model.
- *
- * Contains useful information such as tokens used as part of the interaction
- * with the model.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.Usage = Usage;
-class FinishPart extends /*#__PURE__*/Schema.TaggedClass("@effect/ai/AiResponse/FinishPart")("FinishPart", {
-  /**
-   * The usage information for the response.
-   */
-  usage: Usage,
-  /**
-   * The reason the model finished generating a response.
-   */
-  reason: FinishReason,
-  /**
-   * Provider-specific metadata associated with the response.
-   */
-  providerMetadata: /*#__PURE__*/Schema.optionalWith(/*#__PURE__*/Schema.Record({
-    key: Schema.String,
-    value: /*#__PURE__*/Schema.Record({
-      key: Schema.String,
-      value: Schema.Unknown
-    })
-  }), {
-    default: () => ({})
-  })
-}) {
-  /**
-   * @since 1.0.0
-   */
-  [PartTypeId] = PartTypeId;
-}
-/**
- * Represents an single part of a response received from a large language model.
- *
- * @since 1.0.0
- * @category Models
- */
-exports.FinishPart = FinishPart;
-const Part = exports.Part = /*#__PURE__*/Schema.Union(TextPart, ReasoningPart, RedactedReasoningPart, ToolCallPart, MetadataPart, FinishPart);
-/**
- * @since 1.0.0
- * @category Guards
- */
-const is = u => Predicate.hasProperty(u, TypeId);
-/**
- * @since 1.0.0
- * @category Guards
- */
-exports.is = is;
-const isPart = u => Predicate.hasProperty(u, PartTypeId);
-/**
- * @since 1.0.0
- * @category Guards
- */
-exports.isPart = isPart;
-const isStructured = u => Predicate.hasProperty(u, StructuredResponseTypeId);
-/**
- * @since 1.0.0
- * @category Guards
- */
-exports.isStructured = isStructured;
-const hasToolCallResults = u => Predicate.hasProperty(u, WithToolCallResultsTypeId);
-/**
- * @since 1.0.0
- * @category Constructors
- */
-exports.hasToolCallResults = hasToolCallResults;
-const empty = exports.empty = /*#__PURE__*/new AiResponse({
-  parts: []
-}, constDisableValidation);
-/**
- * Combines two responses into a single response.
- *
- * @since 1.0.0
- * @category Combination
- */
-const merge = exports.merge = /*#__PURE__*/(0, _Function.dual)(2, (self, other) => {
-  const newParts = mergeParts(self, other);
-  if (hasToolCallResults(self) && hasToolCallResults(other)) {
-    return new WithToolCallResults({
-      results: new Map([...self.results, ...other.results]),
-      encodedResults: new Map([...self.encodedResults, ...other.encodedResults]),
-      parts: newParts
-    }, constDisableValidation);
-  } else if (hasToolCallResults(self)) {
-    return new WithToolCallResults({
-      results: self.results,
-      encodedResults: self.encodedResults,
-      parts: newParts
-    }, constDisableValidation);
-  } else if (hasToolCallResults(other)) {
-    return new WithToolCallResults({
-      results: other.results,
-      encodedResults: other.encodedResults,
-      parts: newParts
-    }, constDisableValidation);
-  } else if (isStructured(self) && isStructured(other)) {
-    return new WithStructuredOutput({
-      id: self.id,
-      name: self.name,
-      value: other.value,
-      parts: newParts
-    }, constDisableValidation);
-  } else if (isStructured(self)) {
-    return new WithStructuredOutput({
-      id: self.id,
-      name: self.name,
-      value: self.value,
-      parts: newParts
-    }, constDisableValidation);
-  } else if (isStructured(other)) {
-    return new WithStructuredOutput({
-      id: other.id,
-      name: other.name,
-      value: other.value,
-      parts: newParts
-    }, constDisableValidation);
-  }
-  return new AiResponse({
-    parts: newParts
-  }, constDisableValidation);
-});
-const mergeParts = (self, other) => {
-  if (other.parts.length === 0) {
-    return self.parts;
-  }
-  if (self.parts.length === 0) {
-    return other.parts;
-  }
-  const result = [];
-  let accumulatedText = "";
-  const flushText = () => {
-    if (accumulatedText.length > 0) {
-      result.push(new TextPart({
-        text: accumulatedText
-      }, constDisableValidation));
-      accumulatedText = "";
-    }
-  };
-  for (const part of self.parts) {
-    if (part._tag === "TextPart") {
-      accumulatedText += part.text;
-    } else {
-      flushText();
-      result.push(part);
-    }
-  }
-  for (const part of other.parts) {
-    if (part._tag === "TextPart") {
-      accumulatedText += part.text;
-    } else {
-      flushText();
-      result.push(part);
-    }
-  }
-  flushText();
-  return result;
-};
-/**
- * Adds the specified tool calls to the provided `AiResponse`.
- *
- * **NOTE**: With this method, the tool call parameters will be parsed as a
- * JSON string. If your tool call parameters are already parsed, use
- * `AiResponse.withToolCallsUnknown`.
- *
- * @since 1.0.0
- * @category Combination
- */
-const withToolCallsJson = exports.withToolCallsJson = /*#__PURE__*/(0, _Function.dual)(2, (self, toolCalls) => Effect.forEach(toolCalls, toolCall => ToolCallPart.fromJson(toolCall)).pipe(Effect.map(parts => new AiResponse({
-  parts: [...self.parts, ...parts]
-}, constDisableValidation))));
-//# sourceMappingURL=AiResponse.js.map