@langchain/openai 0.6.8 → 1.0.0-alpha.1

package/dist/tools/dalle.d.cts

@@ -0,0 +1,123 @@
+import { OpenAI as OpenAI$1 } from "openai";
+import { MessageContentComplex } from "@langchain/core/messages";
+import { Tool, ToolParams } from "@langchain/core/tools";
+
+//#region src/tools/dalle.d.ts
+
+/**
+ * @see https://platform.openai.com/docs/api-reference/images/create
+ */
+type OpenAIImageModelId = OpenAI$1.ImageModel | (string & NonNullable<unknown>);
+/**
+ * An interface for the Dall-E API Wrapper.
+ */
+interface DallEAPIWrapperParams extends ToolParams {
+  /**
+   * The OpenAI API key
+   * Alias for `apiKey`
+   */
+  openAIApiKey?: string;
+  /**
+   * The OpenAI API key
+   */
+  apiKey?: string;
+  /**
+   * The model to use.
+   * Alias for `model`
+   * @params "dall-e-2" | "dall-e-3"
+   * @default "dall-e-3"
+   * @deprecated Use `model` instead.
+   */
+  modelName?: OpenAIImageModelId;
+  /**
+   * The model to use.
+   * @params "dall-e-2" | "dall-e-3"
+   * @default "dall-e-3"
+   */
+  model?: OpenAIImageModelId;
+  /**
+   * The style of the generated images. Must be one of vivid or natural.
+   * Vivid causes the model to lean towards generating hyper-real and dramatic images.
+   * Natural causes the model to produce more natural, less hyper-real looking images.
+   * @default "vivid"
+   */
+  style?: "natural" | "vivid";
+  /**
+   * The quality of the image that will be generated. ‘hd’ creates images with finer
+   * details and greater consistency across the image.
+   * @default "standard"
+   */
+  quality?: "standard" | "hd";
+  /**
+   * The number of images to generate.
+   * Must be between 1 and 10.
+   * For dall-e-3, only `n: 1` is supported.
+   * @default 1
+   */
+  n?: number;
+  /**
+   * The size of the generated images.
+   * Must be one of 256x256, 512x512, or 1024x1024 for DALL·E-2 models.
+   * Must be one of 1024x1024, 1792x1024, or 1024x1792 for DALL·E-3 models.
+   * @default "1024x1024"
+   */
+  size?: "256x256" | "512x512" | "1024x1024" | "1792x1024" | "1024x1792";
+  /**
+   * The format in which the generated images are returned.
+   * Must be one of "url" or "b64_json".
+   * @default "url"
+   */
+  dallEResponseFormat?: "url" | "b64_json";
+  /**
+   * @deprecated Use dallEResponseFormat instead for the Dall-E response type.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  responseFormat?: any;
+  /**
+   * A unique identifier representing your end-user, which will help
+   * OpenAI to monitor and detect abuse.
+   */
+  user?: string;
+  /**
+   * The organization to use
+   */
+  organization?: string;
+  /**
+   * The base URL of the OpenAI API.
+   */
+  baseUrl?: string;
+}
+/**
+ * A tool for generating images with Open AIs Dall-E 2 or 3 API.
+ */
+declare class DallEAPIWrapper extends Tool {
+  static lc_name(): string;
+  name: string;
+  description: string;
+  protected client: OpenAI$1;
+  static readonly toolName: string;
+  private model;
+  private style;
+  private quality;
+  private n;
+  private size;
+  private dallEResponseFormat;
+  private user?;
+  constructor(fields?: DallEAPIWrapperParams);
+  /**
+   * Processes the API response if multiple images are generated.
+   * Returns a list of MessageContentImageUrl objects. If the response
+   * format is `url`, then the `image_url` field will contain the URL.
+   * If it is `b64_json`, then the `image_url` field will contain an object
+   * with a `url` field with the base64 encoded image.
+   *
+   * @param {OpenAIClient.Images.ImagesResponse[]} response The API response
+   * @returns {MessageContentImageUrl[]}
+   */
+  private processMultipleGeneratedUrls;
+  /** @ignore */
+  _call(input: string): Promise<string | MessageContentComplex[]>;
+}
+//#endregion
+export { DallEAPIWrapper, DallEAPIWrapperParams, OpenAIImageModelId };
+//# sourceMappingURL=dalle.d.cts.map

package/dist/tools/dalle.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dalle.d.cts","names":["OpenAI","OpenAIClient","Tool","ToolParams","MessageContentComplex","OpenAIImageModelId","ImageModel","NonNullable","DallEAPIWrapperParams","DallEAPIWrapper","Promise"],"sources":["../../src/tools/dalle.d.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport { Tool, ToolParams } from \"@langchain/core/tools\";\nimport { MessageContentComplex } from \"@langchain/core/messages\";\n/**\n * @see https://platform.openai.com/docs/api-reference/images/create\n */\nexport type OpenAIImageModelId = OpenAIClient.ImageModel | (string & NonNullable<unknown>);\n/**\n * An interface for the Dall-E API Wrapper.\n */\nexport interface DallEAPIWrapperParams extends ToolParams {\n    /**\n     * The OpenAI API key\n     * Alias for `apiKey`\n     */\n    openAIApiKey?: string;\n    /**\n     * The OpenAI API key\n     */\n    apiKey?: string;\n    /**\n     * The model to use.\n     * Alias for `model`\n     * @params \"dall-e-2\" | \"dall-e-3\"\n     * @default \"dall-e-3\"\n     * @deprecated Use `model` instead.\n     */\n    modelName?: OpenAIImageModelId;\n    /**\n     * The model to use.\n     * @params \"dall-e-2\" | \"dall-e-3\"\n     * @default \"dall-e-3\"\n     */\n    model?: OpenAIImageModelId;\n    /**\n     * The style of the generated images. Must be one of vivid or natural.\n     * Vivid causes the model to lean towards generating hyper-real and dramatic images.\n     * Natural causes the model to produce more natural, less hyper-real looking images.\n     * @default \"vivid\"\n     */\n    style?: \"natural\" | \"vivid\";\n    /**\n     * The quality of the image that will be generated. ‘hd’ creates images with finer\n     * details and greater consistency across the image.\n     * @default \"standard\"\n     */\n    quality?: \"standard\" | \"hd\";\n    /**\n     * The number of images to generate.\n     * Must be between 1 and 10.\n     * For dall-e-3, only `n: 1` is supported.\n     * @default 1\n     */\n    n?: number;\n    /**\n     * The size of the generated images.\n     * Must be one of 256x256, 512x512, or 1024x1024 for DALL·E-2 models.\n     * Must be one of 1024x1024, 1792x1024, or 1024x1792 for DALL·E-3 models.\n     * @default \"1024x1024\"\n     */\n    size?: \"256x256\" | \"512x512\" | \"1024x1024\" | \"1792x1024\" | \"1024x1792\";\n    /**\n     * The format in which the generated images are returned.\n     * Must be one of \"url\" or \"b64_json\".\n     * @default \"url\"\n     */\n    dallEResponseFormat?: \"url\" | \"b64_json\";\n    /**\n     * @deprecated Use dallEResponseFormat instead for the Dall-E response type.\n     */\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    responseFormat?: any;\n    /**\n     * A unique identifier representing your end-user, which will help\n     * OpenAI to monitor and detect abuse.\n     */\n    user?: string;\n    /**\n     * The organization to use\n     */\n    organization?: string;\n    /**\n     * The base URL of the OpenAI API.\n     */\n    baseUrl?: string;\n}\n/**\n * A tool for generating images with Open AIs Dall-E 2 or 3 API.\n */\nexport declare class DallEAPIWrapper extends Tool {\n    static lc_name(): string;\n    name: string;\n    description: string;\n    protected client: OpenAIClient;\n    static readonly toolName: string;\n    private model;\n    private style;\n    private quality;\n    private n;\n    private size;\n    private dallEResponseFormat;\n    private user?;\n    constructor(fields?: DallEAPIWrapperParams);\n    /**\n     * Processes the API response if multiple images are generated.\n     * Returns a list of MessageContentImageUrl objects. If the response\n     * format is `url`, then the `image_url` field will contain the URL.\n     * If it is `b64_json`, then the `image_url` field will contain an object\n     * with a `url` field with the base64 encoded image.\n     *\n     * @param {OpenAIClient.Images.ImagesResponse[]} response The API response\n     * @returns {MessageContentImageUrl[]}\n     */\n    private processMultipleGeneratedUrls;\n    /** @ignore */\n    _call(input: string): Promise<string | MessageContentComplex[]>;\n}\n"],"mappings":";;;;;;;;AAMA;AAA8B,KAAlBK,kBAAAA,GAAqBJ,QAAAA,CAAaK,UAAhB,GAAA,CAAA,MAAA,GAAuCC,WAAvC,CAAA,OAAA,CAAA,CAAA;;;AAAkD;AAI/DC,UAAAA,qBAAAA,SAA8BL,UAAT,CAAA;EAAA;;;;EAAmB,YAAA,CAAA,EAAA,MAAA;EA+EpCM;;;EAIa,MASTD,CAAAA,EAAAA,MAAAA;EAAqB;;;AAbG;;;;cA9DjCH;;;;;;UAMJA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAwDSI,eAAAA,SAAwBP,IAAAA;;;;oBAIvBD;;;;;;;;;uBASGO;;;;;;;;;;;;;wBAaCE,iBAAiBN"}

package/dist/tools/dalle.d.ts

@@ -1,116 +1,123 @@
-import { OpenAI as OpenAIClient } from "openai";
-import { Tool, ToolParams } from "@langchain/core/tools";
+import { OpenAI as OpenAI$1 } from "openai";
 import { MessageContentComplex } from "@langchain/core/messages";
+import { Tool, ToolParams } from "@langchain/core/tools";
+
+//#region src/tools/dalle.d.ts
+
 /**
  * @see https://platform.openai.com/docs/api-reference/images/create
  */
-export type OpenAIImageModelId = OpenAIClient.ImageModel | (string & NonNullable<unknown>);
+type OpenAIImageModelId = OpenAI$1.ImageModel | (string & NonNullable<unknown>);
 /**
  * An interface for the Dall-E API Wrapper.
  */
-export interface DallEAPIWrapperParams extends ToolParams {
-    /**
-     * The OpenAI API key
-     * Alias for `apiKey`
-     */
-    openAIApiKey?: string;
-    /**
-     * The OpenAI API key
-     */
-    apiKey?: string;
-    /**
-     * The model to use.
-     * Alias for `model`
-     * @params "dall-e-2" | "dall-e-3"
-     * @default "dall-e-3"
-     * @deprecated Use `model` instead.
-     */
-    modelName?: OpenAIImageModelId;
-    /**
-     * The model to use.
-     * @params "dall-e-2" | "dall-e-3"
-     * @default "dall-e-3"
-     */
-    model?: OpenAIImageModelId;
-    /**
-     * The style of the generated images. Must be one of vivid or natural.
-     * Vivid causes the model to lean towards generating hyper-real and dramatic images.
-     * Natural causes the model to produce more natural, less hyper-real looking images.
-     * @default "vivid"
-     */
-    style?: "natural" | "vivid";
-    /**
-     * The quality of the image that will be generated. ‘hd’ creates images with finer
-     * details and greater consistency across the image.
-     * @default "standard"
-     */
-    quality?: "standard" | "hd";
-    /**
-     * The number of images to generate.
-     * Must be between 1 and 10.
-     * For dall-e-3, only `n: 1` is supported.
-     * @default 1
-     */
-    n?: number;
-    /**
-     * The size of the generated images.
-     * Must be one of 256x256, 512x512, or 1024x1024 for DALL·E-2 models.
-     * Must be one of 1024x1024, 1792x1024, or 1024x1792 for DALL·E-3 models.
-     * @default "1024x1024"
-     */
-    size?: "256x256" | "512x512" | "1024x1024" | "1792x1024" | "1024x1792";
-    /**
-     * The format in which the generated images are returned.
-     * Must be one of "url" or "b64_json".
-     * @default "url"
-     */
-    dallEResponseFormat?: "url" | "b64_json";
-    /**
-     * @deprecated Use dallEResponseFormat instead for the Dall-E response type.
-     */
-    responseFormat?: any;
-    /**
-     * A unique identifier representing your end-user, which will help
-     * OpenAI to monitor and detect abuse.
-     */
-    user?: string;
-    /**
-     * The organization to use
-     */
-    organization?: string;
-    /**
-     * The base URL of the OpenAI API.
-     */
-    baseUrl?: string;
+interface DallEAPIWrapperParams extends ToolParams {
+  /**
+   * The OpenAI API key
+   * Alias for `apiKey`
+   */
+  openAIApiKey?: string;
+  /**
+   * The OpenAI API key
+   */
+  apiKey?: string;
+  /**
+   * The model to use.
+   * Alias for `model`
+   * @params "dall-e-2" | "dall-e-3"
+   * @default "dall-e-3"
+   * @deprecated Use `model` instead.
+   */
+  modelName?: OpenAIImageModelId;
+  /**
+   * The model to use.
+   * @params "dall-e-2" | "dall-e-3"
+   * @default "dall-e-3"
+   */
+  model?: OpenAIImageModelId;
+  /**
+   * The style of the generated images. Must be one of vivid or natural.
+   * Vivid causes the model to lean towards generating hyper-real and dramatic images.
+   * Natural causes the model to produce more natural, less hyper-real looking images.
+   * @default "vivid"
+   */
+  style?: "natural" | "vivid";
+  /**
+   * The quality of the image that will be generated. ‘hd’ creates images with finer
+   * details and greater consistency across the image.
+   * @default "standard"
+   */
+  quality?: "standard" | "hd";
+  /**
+   * The number of images to generate.
+   * Must be between 1 and 10.
+   * For dall-e-3, only `n: 1` is supported.
+   * @default 1
+   */
+  n?: number;
+  /**
+   * The size of the generated images.
+   * Must be one of 256x256, 512x512, or 1024x1024 for DALL·E-2 models.
+   * Must be one of 1024x1024, 1792x1024, or 1024x1792 for DALL·E-3 models.
+   * @default "1024x1024"
+   */
+  size?: "256x256" | "512x512" | "1024x1024" | "1792x1024" | "1024x1792";
+  /**
+   * The format in which the generated images are returned.
+   * Must be one of "url" or "b64_json".
+   * @default "url"
+   */
+  dallEResponseFormat?: "url" | "b64_json";
+  /**
+   * @deprecated Use dallEResponseFormat instead for the Dall-E response type.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  responseFormat?: any;
+  /**
+   * A unique identifier representing your end-user, which will help
+   * OpenAI to monitor and detect abuse.
+   */
+  user?: string;
+  /**
+   * The organization to use
+   */
+  organization?: string;
+  /**
+   * The base URL of the OpenAI API.
+   */
+  baseUrl?: string;
 }
 /**
  * A tool for generating images with Open AIs Dall-E 2 or 3 API.
  */
-export declare class DallEAPIWrapper extends Tool {
-    static lc_name(): string;
-    name: string;
-    description: string;
-    protected client: OpenAIClient;
-    static readonly toolName = "dalle_api_wrapper";
-    private model;
-    private style;
-    private quality;
-    private n;
-    private size;
-    private dallEResponseFormat;
-    private user?;
-    constructor(fields?: DallEAPIWrapperParams);
-    /**
-     * Processes the API response if multiple images are generated.
-     * Returns a list of MessageContentImageUrl objects. If the response
-     * format is `url`, then the `image_url` field will contain the URL.
-     * If it is `b64_json`, then the `image_url` field will contain an object
-     * with a `url` field with the base64 encoded image.
-     *
-     * @param {OpenAIClient.Images.ImagesResponse[]} response The API response
-     * @returns {MessageContentImageUrl[]}
-     */
-    private processMultipleGeneratedUrls;
-    /** @ignore */
-    _call(input: string): Promise<string | MessageContentComplex[]>;
+declare class DallEAPIWrapper extends Tool {
+  static lc_name(): string;
+  name: string;
+  description: string;
+  protected client: OpenAI$1;
+  static readonly toolName: string;
+  private model;
+  private style;
+  private quality;
+  private n;
+  private size;
+  private dallEResponseFormat;
+  private user?;
+  constructor(fields?: DallEAPIWrapperParams);
+  /**
+   * Processes the API response if multiple images are generated.
+   * Returns a list of MessageContentImageUrl objects. If the response
+   * format is `url`, then the `image_url` field will contain the URL.
+   * If it is `b64_json`, then the `image_url` field will contain an object
+   * with a `url` field with the base64 encoded image.
+   *
+   * @param {OpenAIClient.Images.ImagesResponse[]} response The API response
+   * @returns {MessageContentImageUrl[]}
+   */
+  private processMultipleGeneratedUrls;
+  /** @ignore */
+  _call(input: string): Promise<string | MessageContentComplex[]>;
 }
+//#endregion
+export { DallEAPIWrapper, DallEAPIWrapperParams, OpenAIImageModelId };
+//# sourceMappingURL=dalle.d.ts.map

package/dist/tools/dalle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dalle.d.ts","names":["OpenAI","OpenAIClient","Tool","ToolParams","MessageContentComplex","OpenAIImageModelId","ImageModel","NonNullable","DallEAPIWrapperParams","DallEAPIWrapper","Promise"],"sources":["../../src/tools/dalle.d.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport { Tool, ToolParams } from \"@langchain/core/tools\";\nimport { MessageContentComplex } from \"@langchain/core/messages\";\n/**\n * @see https://platform.openai.com/docs/api-reference/images/create\n */\nexport type OpenAIImageModelId = OpenAIClient.ImageModel | (string & NonNullable<unknown>);\n/**\n * An interface for the Dall-E API Wrapper.\n */\nexport interface DallEAPIWrapperParams extends ToolParams {\n    /**\n     * The OpenAI API key\n     * Alias for `apiKey`\n     */\n    openAIApiKey?: string;\n    /**\n     * The OpenAI API key\n     */\n    apiKey?: string;\n    /**\n     * The model to use.\n     * Alias for `model`\n     * @params \"dall-e-2\" | \"dall-e-3\"\n     * @default \"dall-e-3\"\n     * @deprecated Use `model` instead.\n     */\n    modelName?: OpenAIImageModelId;\n    /**\n     * The model to use.\n     * @params \"dall-e-2\" | \"dall-e-3\"\n     * @default \"dall-e-3\"\n     */\n    model?: OpenAIImageModelId;\n    /**\n     * The style of the generated images. Must be one of vivid or natural.\n     * Vivid causes the model to lean towards generating hyper-real and dramatic images.\n     * Natural causes the model to produce more natural, less hyper-real looking images.\n     * @default \"vivid\"\n     */\n    style?: \"natural\" | \"vivid\";\n    /**\n     * The quality of the image that will be generated. ‘hd’ creates images with finer\n     * details and greater consistency across the image.\n     * @default \"standard\"\n     */\n    quality?: \"standard\" | \"hd\";\n    /**\n     * The number of images to generate.\n     * Must be between 1 and 10.\n     * For dall-e-3, only `n: 1` is supported.\n     * @default 1\n     */\n    n?: number;\n    /**\n     * The size of the generated images.\n     * Must be one of 256x256, 512x512, or 1024x1024 for DALL·E-2 models.\n     * Must be one of 1024x1024, 1792x1024, or 1024x1792 for DALL·E-3 models.\n     * @default \"1024x1024\"\n     */\n    size?: \"256x256\" | \"512x512\" | \"1024x1024\" | \"1792x1024\" | \"1024x1792\";\n    /**\n     * The format in which the generated images are returned.\n     * Must be one of \"url\" or \"b64_json\".\n     * @default \"url\"\n     */\n    dallEResponseFormat?: \"url\" | \"b64_json\";\n    /**\n     * @deprecated Use dallEResponseFormat instead for the Dall-E response type.\n     */\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    responseFormat?: any;\n    /**\n     * A unique identifier representing your end-user, which will help\n     * OpenAI to monitor and detect abuse.\n     */\n    user?: string;\n    /**\n     * The organization to use\n     */\n    organization?: string;\n    /**\n     * The base URL of the OpenAI API.\n     */\n    baseUrl?: string;\n}\n/**\n * A tool for generating images with Open AIs Dall-E 2 or 3 API.\n */\nexport declare class DallEAPIWrapper extends Tool {\n    static lc_name(): string;\n    name: string;\n    description: string;\n    protected client: OpenAIClient;\n    static readonly toolName: string;\n    private model;\n    private style;\n    private quality;\n    private n;\n    private size;\n    private dallEResponseFormat;\n    private user?;\n    constructor(fields?: DallEAPIWrapperParams);\n    /**\n     * Processes the API response if multiple images are generated.\n     * Returns a list of MessageContentImageUrl objects. If the response\n     * format is `url`, then the `image_url` field will contain the URL.\n     * If it is `b64_json`, then the `image_url` field will contain an object\n     * with a `url` field with the base64 encoded image.\n     *\n     * @param {OpenAIClient.Images.ImagesResponse[]} response The API response\n     * @returns {MessageContentImageUrl[]}\n     */\n    private processMultipleGeneratedUrls;\n    /** @ignore */\n    _call(input: string): Promise<string | MessageContentComplex[]>;\n}\n"],"mappings":";;;;;;;;AAMA;AAA8B,KAAlBK,kBAAAA,GAAqBJ,QAAAA,CAAaK,UAAhB,GAAA,CAAA,MAAA,GAAuCC,WAAvC,CAAA,OAAA,CAAA,CAAA;;;AAAkD;AAI/DC,UAAAA,qBAAAA,SAA8BL,UAAT,CAAA;EAAA;;;;EAAmB,YAAA,CAAA,EAAA,MAAA;EA+EpCM;;;EAIa,MASTD,CAAAA,EAAAA,MAAAA;EAAqB;;;AAbG;;;;cA9DjCH;;;;;;UAMJA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAwDSI,eAAAA,SAAwBP,IAAAA;;;;oBAIvBD;;;;;;;;;uBASGO;;;;;;;;;;;;;wBAaCE,iBAAiBN"}