modelfusion 0.29.0 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/README.md +27 -32
  2. package/core/index.cjs +1 -0
  3. package/core/index.d.ts +1 -0
  4. package/core/index.js +1 -0
  5. package/core/structure/Schema.d.ts +24 -0
  6. package/core/structure/StructureDefinition.d.ts +6 -0
  7. package/core/structure/UncheckedJsonSchemaSchema.cjs +26 -0
  8. package/core/structure/UncheckedJsonSchemaSchema.d.ts +14 -0
  9. package/core/structure/UncheckedJsonSchemaSchema.js +22 -0
  10. package/core/structure/UncheckedJsonSchemaStructureDefinition.cjs +30 -0
  11. package/core/structure/UncheckedJsonSchemaStructureDefinition.d.ts +12 -0
  12. package/core/structure/UncheckedJsonSchemaStructureDefinition.js +26 -0
  13. package/core/structure/ZodSchema.cjs +31 -0
  14. package/core/structure/ZodSchema.d.ts +15 -0
  15. package/core/structure/ZodSchema.js +27 -0
  16. package/core/structure/ZodStructureDefinition.cjs +30 -0
  17. package/core/structure/ZodStructureDefinition.d.ts +13 -0
  18. package/core/structure/ZodStructureDefinition.js +26 -0
  19. package/core/structure/index.cjs +22 -0
  20. package/core/structure/index.d.ts +6 -0
  21. package/core/structure/index.js +6 -0
  22. package/model-function/ModelCallEvent.d.ts +3 -3
  23. package/model-function/SuccessfulModelCall.d.ts +1 -1
  24. package/model-function/embed-text/TextEmbeddingModel.d.ts +4 -1
  25. package/model-function/embed-text/embedText.cjs +7 -2
  26. package/model-function/embed-text/embedText.js +7 -2
  27. package/model-function/generate-structure/InstructionWithStructurePrompt.cjs +17 -0
  28. package/model-function/generate-structure/InstructionWithStructurePrompt.d.ts +17 -0
  29. package/model-function/generate-structure/InstructionWithStructurePrompt.js +14 -0
  30. package/model-function/generate-structure/NoSuchStructureError.cjs +17 -0
  31. package/model-function/generate-structure/NoSuchStructureError.d.ts +4 -0
  32. package/model-function/generate-structure/NoSuchStructureError.js +13 -0
  33. package/model-function/{generate-json/JsonTextGenerationModel.cjs → generate-structure/StructureFromTextGenerationModel.cjs} +7 -7
  34. package/model-function/generate-structure/StructureFromTextGenerationModel.d.ts +26 -0
  35. package/model-function/{generate-json/JsonTextGenerationModel.js → generate-structure/StructureFromTextGenerationModel.js} +5 -5
  36. package/model-function/generate-structure/StructureGenerationEvent.d.ts +23 -0
  37. package/model-function/generate-structure/StructureGenerationModel.d.ts +13 -0
  38. package/model-function/generate-structure/StructureOrTextGenerationModel.cjs +2 -0
  39. package/model-function/generate-structure/StructureOrTextGenerationModel.d.ts +23 -0
  40. package/model-function/generate-structure/StructureOrTextGenerationModel.js +1 -0
  41. package/model-function/generate-structure/StructureValidationError.cjs +34 -0
  42. package/model-function/generate-structure/StructureValidationError.d.ts +10 -0
  43. package/model-function/generate-structure/StructureValidationError.js +30 -0
  44. package/model-function/generate-structure/generateStructure.cjs +29 -0
  45. package/model-function/generate-structure/generateStructure.d.ts +5 -0
  46. package/model-function/generate-structure/generateStructure.js +25 -0
  47. package/model-function/generate-structure/generateStructureOrText.cjs +42 -0
  48. package/model-function/generate-structure/generateStructureOrText.d.ts +22 -0
  49. package/model-function/generate-structure/generateStructureOrText.js +38 -0
  50. package/model-function/index.cjs +9 -10
  51. package/model-function/index.d.ts +9 -10
  52. package/model-function/index.js +9 -10
  53. package/model-provider/openai/OpenAICostCalculator.cjs +1 -1
  54. package/model-provider/openai/OpenAICostCalculator.js +1 -1
  55. package/model-provider/openai/OpenAITextEmbeddingModel.cjs +6 -8
  56. package/model-provider/openai/OpenAITextEmbeddingModel.d.ts +2 -2
  57. package/model-provider/openai/OpenAITextEmbeddingModel.js +6 -8
  58. package/model-provider/openai/chat/OpenAIChatModel.cjs +2 -2
  59. package/model-provider/openai/chat/OpenAIChatModel.d.ts +5 -5
  60. package/model-provider/openai/chat/OpenAIChatModel.js +2 -2
  61. package/model-provider/openai/chat/OpenAIChatPrompt.cjs +22 -26
  62. package/model-provider/openai/chat/OpenAIChatPrompt.d.ts +20 -30
  63. package/model-provider/openai/chat/OpenAIChatPrompt.js +22 -26
  64. package/model-provider/openai/index.d.ts +1 -1
  65. package/model-provider/openai/index.js +1 -1
  66. package/package.json +9 -12
  67. package/tool/Tool.cjs +2 -2
  68. package/tool/Tool.d.ts +8 -8
  69. package/tool/Tool.js +2 -2
  70. package/tool/WebSearchTool.cjs +5 -4
  71. package/tool/WebSearchTool.d.ts +2 -22
  72. package/tool/WebSearchTool.js +5 -4
  73. package/tool/executeTool.cjs +1 -1
  74. package/tool/executeTool.d.ts +1 -2
  75. package/tool/executeTool.js +1 -1
  76. package/tool/useTool.cjs +3 -3
  77. package/tool/useTool.d.ts +3 -3
  78. package/tool/useTool.js +3 -3
  79. package/tool/useToolOrGenerateText.cjs +7 -7
  80. package/tool/useToolOrGenerateText.d.ts +2 -2
  81. package/tool/useToolOrGenerateText.js +7 -7
  82. package/util/getErrorMessage.cjs +13 -0
  83. package/util/getErrorMessage.d.ts +1 -0
  84. package/util/getErrorMessage.js +9 -0
  85. package/model-function/generate-json/InstructionWithSchemaPrompt.cjs +0 -17
  86. package/model-function/generate-json/InstructionWithSchemaPrompt.d.ts +0 -26
  87. package/model-function/generate-json/InstructionWithSchemaPrompt.js +0 -14
  88. package/model-function/generate-json/JsonGenerationEvent.d.ts +0 -23
  89. package/model-function/generate-json/JsonGenerationModel.d.ts +0 -13
  90. package/model-function/generate-json/JsonOrTextGenerationModel.d.ts +0 -23
  91. package/model-function/generate-json/JsonTextGenerationModel.d.ts +0 -26
  92. package/model-function/generate-json/NoSuchSchemaError.cjs +0 -17
  93. package/model-function/generate-json/NoSuchSchemaError.d.ts +0 -4
  94. package/model-function/generate-json/NoSuchSchemaError.js +0 -13
  95. package/model-function/generate-json/SchemaDefinition.d.ts +0 -6
  96. package/model-function/generate-json/SchemaValidationError.cjs +0 -36
  97. package/model-function/generate-json/SchemaValidationError.d.ts +0 -11
  98. package/model-function/generate-json/SchemaValidationError.js +0 -32
  99. package/model-function/generate-json/generateJson.cjs +0 -29
  100. package/model-function/generate-json/generateJson.d.ts +0 -5
  101. package/model-function/generate-json/generateJson.js +0 -25
  102. package/model-function/generate-json/generateJsonOrText.cjs +0 -42
  103. package/model-function/generate-json/generateJsonOrText.d.ts +0 -22
  104. package/model-function/generate-json/generateJsonOrText.js +0 -38
  105. /package/{model-function/generate-json/JsonGenerationEvent.cjs → core/structure/Schema.cjs} +0 -0
  106. /package/{model-function/generate-json/JsonGenerationEvent.js → core/structure/Schema.js} +0 -0
  107. /package/{model-function/generate-json/JsonGenerationModel.cjs → core/structure/StructureDefinition.cjs} +0 -0
  108. /package/{model-function/generate-json/JsonGenerationModel.js → core/structure/StructureDefinition.js} +0 -0
  109. /package/model-function/{generate-json/JsonOrTextGenerationModel.cjs → generate-structure/StructureGenerationEvent.cjs} +0 -0
  110. /package/model-function/{generate-json/JsonOrTextGenerationModel.js → generate-structure/StructureGenerationEvent.js} +0 -0
  111. /package/model-function/{generate-json/SchemaDefinition.cjs → generate-structure/StructureGenerationModel.cjs} +0 -0
  112. /package/model-function/{generate-json/SchemaDefinition.js → generate-structure/StructureGenerationModel.js} +0 -0
@@ -0,0 +1,4 @@
1
+ export declare class NoSuchStructureError extends Error {
2
+ readonly structureName: string;
3
+ constructor(structureName: string);
4
+ }
@@ -0,0 +1,13 @@
1
+ export class NoSuchStructureError extends Error {
2
+ constructor(structureName) {
3
+ super(`No such structure: ${structureName}`);
4
+ Object.defineProperty(this, "structureName", {
5
+ enumerable: true,
6
+ configurable: true,
7
+ writable: true,
8
+ value: void 0
9
+ });
10
+ this.name = "NoSuchStructureError";
11
+ this.structureName = structureName;
12
+ }
13
+ }
@@ -1,8 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.JsonTextGenerationModel = void 0;
3
+ exports.StructureFromTextGenerationModel = void 0;
4
4
  const generateText_js_1 = require("../generate-text/generateText.cjs");
5
- class JsonTextGenerationModel {
5
+ class StructureFromTextGenerationModel {
6
6
  constructor({ model, format, }) {
7
7
  Object.defineProperty(this, "model", {
8
8
  enumerable: true,
@@ -28,17 +28,17 @@ class JsonTextGenerationModel {
28
28
  get settingsForEvent() {
29
29
  return this.model.settingsForEvent;
30
30
  }
31
- async generateJsonResponse(prompt, options) {
31
+ async generateStructureResponse(prompt, options) {
32
32
  return await (0, generateText_js_1.generateText)(this.model, this.format.createPrompt(prompt), options);
33
33
  }
34
- extractJson(response) {
35
- return this.format.extractJson(response);
34
+ extractStructure(response) {
35
+ return this.format.extractStructure(response);
36
36
  }
37
37
  withSettings(additionalSettings) {
38
- return new JsonTextGenerationModel({
38
+ return new StructureFromTextGenerationModel({
39
39
  model: this.model.withSettings(additionalSettings),
40
40
  format: this.format,
41
41
  });
42
42
  }
43
43
  }
44
- exports.JsonTextGenerationModel = JsonTextGenerationModel;
44
+ exports.StructureFromTextGenerationModel = StructureFromTextGenerationModel;
@@ -0,0 +1,26 @@
1
+ import { TextGenerationModel, TextGenerationModelSettings } from "../generate-text/TextGenerationModel.js";
2
+ import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
3
+ import { InstructionWithStructure } from "./InstructionWithStructurePrompt.js";
4
+ import { StructureGenerationModel } from "./StructureGenerationModel.js";
5
+ import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
6
+ export type StructureFromTextPromptFormat = {
7
+ createPrompt: (prompt: {
8
+ instruction: string;
9
+ structure: StructureDefinition<string, unknown>;
10
+ }) => string;
11
+ extractStructure: (response: string) => unknown;
12
+ };
13
+ export declare class StructureFromTextGenerationModel<MODEL extends TextGenerationModel<string, any, any, TextGenerationModelSettings>> implements StructureGenerationModel<InstructionWithStructure<string, unknown>, string, MODEL["settings"]> {
14
+ private readonly model;
15
+ private readonly format;
16
+ constructor({ model, format, }: {
17
+ model: MODEL;
18
+ format: StructureFromTextPromptFormat;
19
+ });
20
+ get modelInformation(): import("../ModelInformation.js").ModelInformation;
21
+ get settings(): TextGenerationModelSettings;
22
+ get settingsForEvent(): Partial<MODEL["settings"]>;
23
+ generateStructureResponse(prompt: InstructionWithStructure<string, unknown>, options?: ModelFunctionOptions<MODEL["settings"]> | undefined): Promise<string>;
24
+ extractStructure(response: string): unknown;
25
+ withSettings(additionalSettings: Partial<MODEL["settings"]>): this;
26
+ }
@@ -1,5 +1,5 @@
1
1
  import { generateText } from "../generate-text/generateText.js";
2
- export class JsonTextGenerationModel {
2
+ export class StructureFromTextGenerationModel {
3
3
  constructor({ model, format, }) {
4
4
  Object.defineProperty(this, "model", {
5
5
  enumerable: true,
@@ -25,14 +25,14 @@ export class JsonTextGenerationModel {
25
25
  get settingsForEvent() {
26
26
  return this.model.settingsForEvent;
27
27
  }
28
- async generateJsonResponse(prompt, options) {
28
+ async generateStructureResponse(prompt, options) {
29
29
  return await generateText(this.model, this.format.createPrompt(prompt), options);
30
30
  }
31
- extractJson(response) {
32
- return this.format.extractJson(response);
31
+ extractStructure(response) {
32
+ return this.format.extractStructure(response);
33
33
  }
34
34
  withSettings(additionalSettings) {
35
- return new JsonTextGenerationModel({
35
+ return new StructureFromTextGenerationModel({
36
36
  model: this.model.withSettings(additionalSettings),
37
37
  format: this.format,
38
38
  });
@@ -0,0 +1,23 @@
1
+ import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
2
+ export interface StructureGenerationStartedEvent extends BaseModelCallStartedEvent {
3
+ functionType: "structure-generation" | "structure-or-text-generation";
4
+ }
5
+ export type StructureGenerationFinishedEventResult = {
6
+ status: "success";
7
+ response: unknown;
8
+ output: unknown;
9
+ usage?: {
10
+ promptTokens: number;
11
+ completionTokens: number;
12
+ totalTokens: number;
13
+ };
14
+ } | {
15
+ status: "error";
16
+ error: unknown;
17
+ } | {
18
+ status: "abort";
19
+ };
20
+ export type StructureGenerationFinishedEvent = BaseModelCallFinishedEvent & {
21
+ functionType: "structure-generation" | "structure-or-text-generation";
22
+ result: StructureGenerationFinishedEventResult;
23
+ };
@@ -0,0 +1,13 @@
1
+ import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
2
+ import { Model, ModelSettings } from "../Model.js";
3
+ export interface StructureGenerationModelSettings extends ModelSettings {
4
+ }
5
+ export interface StructureGenerationModel<PROMPT, RESPONSE, SETTINGS extends StructureGenerationModelSettings> extends Model<SETTINGS> {
6
+ generateStructureResponse(prompt: PROMPT, options?: ModelFunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
7
+ extractStructure(response: RESPONSE): unknown;
8
+ extractUsage?(response: RESPONSE): {
9
+ promptTokens: number;
10
+ completionTokens: number;
11
+ totalTokens: number;
12
+ };
13
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,23 @@
1
+ import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
2
+ import { Model, ModelSettings } from "../Model.js";
3
+ export interface StructureOrTextGenerationModelSettings extends ModelSettings {
4
+ }
5
+ export interface StructureOrTextGenerationPrompt<RESPONSE> {
6
+ extractStructureAndText(response: RESPONSE): {
7
+ structure: null;
8
+ value: null;
9
+ text: string;
10
+ } | {
11
+ structure: string;
12
+ value: unknown;
13
+ text: string | null;
14
+ };
15
+ }
16
+ export interface StructureOrTextGenerationModel<PROMPT, RESPONSE, SETTINGS extends StructureOrTextGenerationModelSettings> extends Model<SETTINGS> {
17
+ generateStructureResponse(prompt: PROMPT & StructureOrTextGenerationPrompt<RESPONSE>, options?: ModelFunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
18
+ extractUsage?(response: RESPONSE): {
19
+ promptTokens: number;
20
+ completionTokens: number;
21
+ totalTokens: number;
22
+ };
23
+ }
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.StructureValidationError = void 0;
4
+ const getErrorMessage_js_1 = require("../../util/getErrorMessage.cjs");
5
+ class StructureValidationError extends Error {
6
+ constructor({ structureName, value, cause, }) {
7
+ super(`Structure validation error for '${structureName}'. ` +
8
+ `Value: ${JSON.stringify(value)}.\n` +
9
+ `Error message: ${(0, getErrorMessage_js_1.getErrorMessage)(cause)}`);
10
+ Object.defineProperty(this, "structureName", {
11
+ enumerable: true,
12
+ configurable: true,
13
+ writable: true,
14
+ value: void 0
15
+ });
16
+ Object.defineProperty(this, "cause", {
17
+ enumerable: true,
18
+ configurable: true,
19
+ writable: true,
20
+ value: void 0
21
+ });
22
+ Object.defineProperty(this, "value", {
23
+ enumerable: true,
24
+ configurable: true,
25
+ writable: true,
26
+ value: void 0
27
+ });
28
+ this.name = "StructureValidationError";
29
+ this.structureName = structureName;
30
+ this.cause = cause;
31
+ this.value = value;
32
+ }
33
+ }
34
+ exports.StructureValidationError = StructureValidationError;
@@ -0,0 +1,10 @@
1
+ export declare class StructureValidationError extends Error {
2
+ readonly structureName: string;
3
+ readonly cause: unknown;
4
+ readonly value: unknown;
5
+ constructor({ structureName, value, cause, }: {
6
+ structureName: string;
7
+ value: unknown;
8
+ cause: unknown;
9
+ });
10
+ }
@@ -0,0 +1,30 @@
1
+ import { getErrorMessage } from "../../util/getErrorMessage.js";
2
+ export class StructureValidationError extends Error {
3
+ constructor({ structureName, value, cause, }) {
4
+ super(`Structure validation error for '${structureName}'. ` +
5
+ `Value: ${JSON.stringify(value)}.\n` +
6
+ `Error message: ${getErrorMessage(cause)}`);
7
+ Object.defineProperty(this, "structureName", {
8
+ enumerable: true,
9
+ configurable: true,
10
+ writable: true,
11
+ value: void 0
12
+ });
13
+ Object.defineProperty(this, "cause", {
14
+ enumerable: true,
15
+ configurable: true,
16
+ writable: true,
17
+ value: void 0
18
+ });
19
+ Object.defineProperty(this, "value", {
20
+ enumerable: true,
21
+ configurable: true,
22
+ writable: true,
23
+ value: void 0
24
+ });
25
+ this.name = "StructureValidationError";
26
+ this.structureName = structureName;
27
+ this.cause = cause;
28
+ this.value = value;
29
+ }
30
+ }
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.generateStructure = void 0;
4
+ const executeCall_js_1 = require("../executeCall.cjs");
5
+ const StructureValidationError_js_1 = require("./StructureValidationError.cjs");
6
+ function generateStructure(model, structureDefinition, prompt, options) {
7
+ const expandedPrompt = prompt(structureDefinition);
8
+ return (0, executeCall_js_1.executeCall)({
9
+ functionType: "structure-generation",
10
+ input: expandedPrompt,
11
+ model,
12
+ options,
13
+ generateResponse: (options) => model.generateStructureResponse(expandedPrompt, options),
14
+ extractOutputValue: (response) => {
15
+ const structure = model.extractStructure(response);
16
+ const parseResult = structureDefinition.schema.validate(structure);
17
+ if (!parseResult.success) {
18
+ throw new StructureValidationError_js_1.StructureValidationError({
19
+ structureName: structureDefinition.name,
20
+ value: structure,
21
+ cause: parseResult.error,
22
+ });
23
+ }
24
+ return parseResult.value;
25
+ },
26
+ extractUsage: (result) => model.extractUsage?.(result),
27
+ });
28
+ }
29
+ exports.generateStructure = generateStructure;
@@ -0,0 +1,5 @@
1
+ import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
2
+ import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
3
+ import { ModelFunctionPromise } from "../executeCall.js";
4
+ import { StructureGenerationModel, StructureGenerationModelSettings } from "./StructureGenerationModel.js";
5
+ export declare function generateStructure<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, RESPONSE, SETTINGS>, structureDefinition: StructureDefinition<NAME, STRUCTURE>, prompt: (structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT, options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<STRUCTURE, RESPONSE>;
@@ -0,0 +1,25 @@
1
+ import { executeCall } from "../executeCall.js";
2
+ import { StructureValidationError } from "./StructureValidationError.js";
3
+ export function generateStructure(model, structureDefinition, prompt, options) {
4
+ const expandedPrompt = prompt(structureDefinition);
5
+ return executeCall({
6
+ functionType: "structure-generation",
7
+ input: expandedPrompt,
8
+ model,
9
+ options,
10
+ generateResponse: (options) => model.generateStructureResponse(expandedPrompt, options),
11
+ extractOutputValue: (response) => {
12
+ const structure = model.extractStructure(response);
13
+ const parseResult = structureDefinition.schema.validate(structure);
14
+ if (!parseResult.success) {
15
+ throw new StructureValidationError({
16
+ structureName: structureDefinition.name,
17
+ value: structure,
18
+ cause: parseResult.error,
19
+ });
20
+ }
21
+ return parseResult.value;
22
+ },
23
+ extractUsage: (result) => model.extractUsage?.(result),
24
+ });
25
+ }
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.generateStructureOrText = void 0;
4
+ const executeCall_js_1 = require("../executeCall.cjs");
5
+ const NoSuchStructureError_js_1 = require("./NoSuchStructureError.cjs");
6
+ const StructureValidationError_js_1 = require("./StructureValidationError.cjs");
7
+ function generateStructureOrText(model, structures, prompt, options) {
8
+ const expandedPrompt = prompt(structures);
9
+ return (0, executeCall_js_1.executeCall)({
10
+ functionType: "structure-or-text-generation",
11
+ input: expandedPrompt,
12
+ model,
13
+ options,
14
+ generateResponse: (options) => model.generateStructureResponse(expandedPrompt, options),
15
+ extractOutputValue: (response) => {
16
+ const { structure, value, text } = expandedPrompt.extractStructureAndText(response);
17
+ // text generation:
18
+ if (structure == null) {
19
+ return { structure, value, text };
20
+ }
21
+ const definition = structures.find((d) => d.name === structure);
22
+ if (definition == undefined) {
23
+ throw new NoSuchStructureError_js_1.NoSuchStructureError(structure);
24
+ }
25
+ const parseResult = definition.schema.validate(value);
26
+ if (!parseResult.success) {
27
+ throw new StructureValidationError_js_1.StructureValidationError({
28
+ structureName: structure,
29
+ value,
30
+ cause: parseResult.error,
31
+ });
32
+ }
33
+ return {
34
+ structure: structure,
35
+ value: parseResult.value,
36
+ text: text, // text is string | null, which is part of the response for schema values
37
+ };
38
+ },
39
+ extractUsage: (result) => model.extractUsage?.(result),
40
+ });
41
+ }
42
+ exports.generateStructureOrText = generateStructureOrText;
@@ -0,0 +1,22 @@
1
+ import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
2
+ import { ModelFunctionPromise } from "../executeCall.js";
3
+ import { StructureOrTextGenerationModel, StructureOrTextGenerationModelSettings, StructureOrTextGenerationPrompt } from "./StructureOrTextGenerationModel.js";
4
+ import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
5
+ type StructureDefinitionArray<T extends StructureDefinition<any, any>[]> = T;
6
+ type ToStructureDefinitionMap<T extends StructureDefinitionArray<StructureDefinition<any, any>[]>> = {
7
+ [K in T[number]["name"]]: Extract<T[number], StructureDefinition<K, any>>;
8
+ };
9
+ type ToStructureUnion<T> = {
10
+ [KEY in keyof T]: T[KEY] extends StructureDefinition<any, infer STRUCTURE> ? {
11
+ structure: KEY;
12
+ value: STRUCTURE;
13
+ text: string | null;
14
+ } : never;
15
+ }[keyof T];
16
+ type ToOutputValue<STRUCTURES extends StructureDefinitionArray<StructureDefinition<any, any>[]>> = ToStructureUnion<ToStructureDefinitionMap<STRUCTURES>>;
17
+ export declare function generateStructureOrText<STRUCTURES extends StructureDefinition<any, any>[], PROMPT, RESPONSE, SETTINGS extends StructureOrTextGenerationModelSettings>(model: StructureOrTextGenerationModel<PROMPT, RESPONSE, SETTINGS>, structures: STRUCTURES, prompt: (structures: STRUCTURES) => PROMPT & StructureOrTextGenerationPrompt<RESPONSE>, options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<{
18
+ structure: null;
19
+ value: null;
20
+ text: string;
21
+ } | ToOutputValue<STRUCTURES>, RESPONSE>;
22
+ export {};
@@ -0,0 +1,38 @@
1
+ import { executeCall } from "../executeCall.js";
2
+ import { NoSuchStructureError } from "./NoSuchStructureError.js";
3
+ import { StructureValidationError } from "./StructureValidationError.js";
4
+ export function generateStructureOrText(model, structures, prompt, options) {
5
+ const expandedPrompt = prompt(structures);
6
+ return executeCall({
7
+ functionType: "structure-or-text-generation",
8
+ input: expandedPrompt,
9
+ model,
10
+ options,
11
+ generateResponse: (options) => model.generateStructureResponse(expandedPrompt, options),
12
+ extractOutputValue: (response) => {
13
+ const { structure, value, text } = expandedPrompt.extractStructureAndText(response);
14
+ // text generation:
15
+ if (structure == null) {
16
+ return { structure, value, text };
17
+ }
18
+ const definition = structures.find((d) => d.name === structure);
19
+ if (definition == undefined) {
20
+ throw new NoSuchStructureError(structure);
21
+ }
22
+ const parseResult = definition.schema.validate(value);
23
+ if (!parseResult.success) {
24
+ throw new StructureValidationError({
25
+ structureName: structure,
26
+ value,
27
+ cause: parseResult.error,
28
+ });
29
+ }
30
+ return {
31
+ structure: structure,
32
+ value: parseResult.value,
33
+ text: text, // text is string | null, which is part of the response for schema values
34
+ };
35
+ },
36
+ extractUsage: (result) => model.extractUsage?.(result),
37
+ });
38
+ }
@@ -28,16 +28,15 @@ __exportStar(require("./embed-text/embedText.cjs"), exports);
28
28
  __exportStar(require("./generate-image/ImageGenerationEvent.cjs"), exports);
29
29
  __exportStar(require("./generate-image/ImageGenerationModel.cjs"), exports);
30
30
  __exportStar(require("./generate-image/generateImage.cjs"), exports);
31
- __exportStar(require("./generate-json/InstructionWithSchemaPrompt.cjs"), exports);
32
- __exportStar(require("./generate-json/JsonGenerationEvent.cjs"), exports);
33
- __exportStar(require("./generate-json/JsonGenerationModel.cjs"), exports);
34
- __exportStar(require("./generate-json/JsonOrTextGenerationModel.cjs"), exports);
35
- __exportStar(require("./generate-json/JsonTextGenerationModel.cjs"), exports);
36
- __exportStar(require("./generate-json/NoSuchSchemaError.cjs"), exports);
37
- __exportStar(require("./generate-json/SchemaDefinition.cjs"), exports);
38
- __exportStar(require("./generate-json/SchemaValidationError.cjs"), exports);
39
- __exportStar(require("./generate-json/generateJson.cjs"), exports);
40
- __exportStar(require("./generate-json/generateJsonOrText.cjs"), exports);
31
+ __exportStar(require("./generate-structure/InstructionWithStructurePrompt.cjs"), exports);
32
+ __exportStar(require("./generate-structure/StructureGenerationEvent.cjs"), exports);
33
+ __exportStar(require("./generate-structure/StructureGenerationModel.cjs"), exports);
34
+ __exportStar(require("./generate-structure/StructureOrTextGenerationModel.cjs"), exports);
35
+ __exportStar(require("./generate-structure/StructureFromTextGenerationModel.cjs"), exports);
36
+ __exportStar(require("./generate-structure/NoSuchStructureError.cjs"), exports);
37
+ __exportStar(require("./generate-structure/StructureValidationError.cjs"), exports);
38
+ __exportStar(require("./generate-structure/generateStructure.cjs"), exports);
39
+ __exportStar(require("./generate-structure/generateStructureOrText.cjs"), exports);
41
40
  __exportStar(require("./generate-text/DeltaEvent.cjs"), exports);
42
41
  __exportStar(require("./generate-text/TextDeltaEventSource.cjs"), exports);
43
42
  __exportStar(require("./generate-text/TextGenerationEvent.cjs"), exports);
@@ -12,16 +12,15 @@ export * from "./embed-text/embedText.js";
12
12
  export * from "./generate-image/ImageGenerationEvent.js";
13
13
  export * from "./generate-image/ImageGenerationModel.js";
14
14
  export * from "./generate-image/generateImage.js";
15
- export * from "./generate-json/InstructionWithSchemaPrompt.js";
16
- export * from "./generate-json/JsonGenerationEvent.js";
17
- export * from "./generate-json/JsonGenerationModel.js";
18
- export * from "./generate-json/JsonOrTextGenerationModel.js";
19
- export * from "./generate-json/JsonTextGenerationModel.js";
20
- export * from "./generate-json/NoSuchSchemaError.js";
21
- export * from "./generate-json/SchemaDefinition.js";
22
- export * from "./generate-json/SchemaValidationError.js";
23
- export * from "./generate-json/generateJson.js";
24
- export * from "./generate-json/generateJsonOrText.js";
15
+ export * from "./generate-structure/InstructionWithStructurePrompt.js";
16
+ export * from "./generate-structure/StructureGenerationEvent.js";
17
+ export * from "./generate-structure/StructureGenerationModel.js";
18
+ export * from "./generate-structure/StructureOrTextGenerationModel.js";
19
+ export * from "./generate-structure/StructureFromTextGenerationModel.js";
20
+ export * from "./generate-structure/NoSuchStructureError.js";
21
+ export * from "./generate-structure/StructureValidationError.js";
22
+ export * from "./generate-structure/generateStructure.js";
23
+ export * from "./generate-structure/generateStructureOrText.js";
25
24
  export * from "./generate-text/DeltaEvent.js";
26
25
  export * from "./generate-text/TextDeltaEventSource.js";
27
26
  export * from "./generate-text/TextGenerationEvent.js";
@@ -12,16 +12,15 @@ export * from "./embed-text/embedText.js";
12
12
  export * from "./generate-image/ImageGenerationEvent.js";
13
13
  export * from "./generate-image/ImageGenerationModel.js";
14
14
  export * from "./generate-image/generateImage.js";
15
- export * from "./generate-json/InstructionWithSchemaPrompt.js";
16
- export * from "./generate-json/JsonGenerationEvent.js";
17
- export * from "./generate-json/JsonGenerationModel.js";
18
- export * from "./generate-json/JsonOrTextGenerationModel.js";
19
- export * from "./generate-json/JsonTextGenerationModel.js";
20
- export * from "./generate-json/NoSuchSchemaError.js";
21
- export * from "./generate-json/SchemaDefinition.js";
22
- export * from "./generate-json/SchemaValidationError.js";
23
- export * from "./generate-json/generateJson.js";
24
- export * from "./generate-json/generateJsonOrText.js";
15
+ export * from "./generate-structure/InstructionWithStructurePrompt.js";
16
+ export * from "./generate-structure/StructureGenerationEvent.js";
17
+ export * from "./generate-structure/StructureGenerationModel.js";
18
+ export * from "./generate-structure/StructureOrTextGenerationModel.js";
19
+ export * from "./generate-structure/StructureFromTextGenerationModel.js";
20
+ export * from "./generate-structure/NoSuchStructureError.js";
21
+ export * from "./generate-structure/StructureValidationError.js";
22
+ export * from "./generate-structure/generateStructure.js";
23
+ export * from "./generate-structure/generateStructureOrText.js";
25
24
  export * from "./generate-text/DeltaEvent.js";
26
25
  export * from "./generate-text/TextDeltaEventSource.js";
27
26
  export * from "./generate-text/TextGenerationEvent.js";
@@ -36,7 +36,7 @@ class OpenAICostCalculator {
36
36
  }
37
37
  break;
38
38
  }
39
- case "json-generation":
39
+ case "structure-generation":
40
40
  case "text-generation": {
41
41
  if (model == null) {
42
42
  return null;
@@ -33,7 +33,7 @@ export class OpenAICostCalculator {
33
33
  }
34
34
  break;
35
35
  }
36
- case "json-generation":
36
+ case "structure-generation":
37
37
  case "text-generation": {
38
38
  if (model == null) {
39
39
  return null;
@@ -58,7 +58,7 @@ class OpenAITextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
58
58
  enumerable: true,
59
59
  configurable: true,
60
60
  writable: true,
61
- value: 1
61
+ value: 2048
62
62
  });
63
63
  Object.defineProperty(this, "embeddingDimensions", {
64
64
  enumerable: true,
@@ -90,7 +90,7 @@ class OpenAITextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
90
90
  async countTokens(input) {
91
91
  return (0, countTokens_js_1.countTokens)(this.tokenizer, input);
92
92
  }
93
- async callAPI(text, options) {
93
+ async callAPI(texts, options) {
94
94
  const run = options?.run;
95
95
  const settings = options?.settings;
96
96
  const combinedSettings = {
@@ -103,7 +103,7 @@ class OpenAITextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
103
103
  ...combinedSettings,
104
104
  // other settings:
105
105
  abortSignal: run?.abortSignal,
106
- input: text,
106
+ input: texts,
107
107
  };
108
108
  return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
109
109
  retry: callSettings.api?.retry,
@@ -118,7 +118,7 @@ class OpenAITextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
118
118
  if (texts.length > this.maxTextsPerCall) {
119
119
  throw new Error(`The OpenAI embedding API only supports ${this.maxTextsPerCall} texts per API call.`);
120
120
  }
121
- return this.callAPI(texts[0], options);
121
+ return this.callAPI(texts, options);
122
122
  }
123
123
  extractEmbeddings(response) {
124
124
  return [response.data[0].embedding];
@@ -130,13 +130,11 @@ class OpenAITextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
130
130
  exports.OpenAITextEmbeddingModel = OpenAITextEmbeddingModel;
131
131
  const openAITextEmbeddingResponseSchema = zod_1.default.object({
132
132
  object: zod_1.default.literal("list"),
133
- data: zod_1.default
134
- .array(zod_1.default.object({
133
+ data: zod_1.default.array(zod_1.default.object({
135
134
  object: zod_1.default.literal("embedding"),
136
135
  embedding: zod_1.default.array(zod_1.default.number()),
137
136
  index: zod_1.default.number(),
138
- }))
139
- .length(1),
137
+ })),
140
138
  model: zod_1.default.string(),
141
139
  usage: zod_1.default.object({
142
140
  prompt_tokens: zod_1.default.number(),
@@ -40,12 +40,12 @@ export declare class OpenAITextEmbeddingModel extends AbstractModel<OpenAITextEm
40
40
  constructor(settings: OpenAITextEmbeddingModelSettings);
41
41
  readonly provider: "openai";
42
42
  get modelName(): "text-embedding-ada-002";
43
- readonly maxTextsPerCall = 1;
43
+ readonly maxTextsPerCall = 2048;
44
44
  readonly embeddingDimensions: number;
45
45
  readonly tokenizer: TikTokenTokenizer;
46
46
  readonly contextWindowSize: number;
47
47
  countTokens(input: string): Promise<number>;
48
- callAPI(text: string, options?: ModelFunctionOptions<OpenAITextEmbeddingModelSettings>): Promise<OpenAITextEmbeddingResponse>;
48
+ callAPI(texts: Array<string>, options?: ModelFunctionOptions<OpenAITextEmbeddingModelSettings>): Promise<OpenAITextEmbeddingResponse>;
49
49
  get settingsForEvent(): Partial<OpenAITextEmbeddingModelSettings>;
50
50
  generateEmbeddingResponse(texts: string[], options?: ModelFunctionOptions<OpenAITextEmbeddingModelSettings>): Promise<{
51
51
  object: "list";