langchain 0.0.191 → 0.0.193

package/dist/embeddings/cache_backed.cjs

@@ -13,6 +13,43 @@ const base_js_1 = require("./base.cjs");
  *
  * If need be, the interface can be extended to accept other implementations
  * of the value serializer and deserializer, as well as the key encoder.
+ * @example
+ * ```typescript
+ * const underlyingEmbeddings = new OpenAIEmbeddings();
+ *
+ * const cacheBackedEmbeddings = CacheBackedEmbeddings.fromBytesStore(
+ *   underlyingEmbeddings,
+ *   new ConvexKVStore({ ctx }),
+ *   {
+ *     namespace: underlyingEmbeddings.modelName,
+ *   },
+ * );
+ *
+ * const loader = new TextLoader("./state_of_the_union.txt");
+ * const rawDocuments = await loader.load();
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *   chunkSize: 1000,
+ *   chunkOverlap: 0,
+ * });
+ * const documents = await splitter.splitDocuments(rawDocuments);
+ *
+ * let time = Date.now();
+ * const vectorstore = await ConvexVectorStore.fromDocuments(
+ *   documents,
+ *   cacheBackedEmbeddings,
+ *   { ctx },
+ * );
+ * console.log(`Initial creation time: ${Date.now() - time}ms`);
+ *
+ * time = Date.now();
+ * const vectorstore2 = await ConvexVectorStore.fromDocuments(
+ *   documents,
+ *   cacheBackedEmbeddings,
+ *   { ctx },
+ * );
+ * console.log(`Cached creation time: ${Date.now() - time}ms`);
+ *
+ * ```
  */
 class CacheBackedEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {

package/dist/embeddings/cache_backed.d.ts

@@ -18,6 +18,43 @@ export interface CacheBackedEmbeddingsFields extends AsyncCallerParams {
  *
  * If need be, the interface can be extended to accept other implementations
  * of the value serializer and deserializer, as well as the key encoder.
+ * @example
+ * ```typescript
+ * const underlyingEmbeddings = new OpenAIEmbeddings();
+ *
+ * const cacheBackedEmbeddings = CacheBackedEmbeddings.fromBytesStore(
+ *   underlyingEmbeddings,
+ *   new ConvexKVStore({ ctx }),
+ *   {
+ *     namespace: underlyingEmbeddings.modelName,
+ *   },
+ * );
+ *
+ * const loader = new TextLoader("./state_of_the_union.txt");
+ * const rawDocuments = await loader.load();
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *   chunkSize: 1000,
+ *   chunkOverlap: 0,
+ * });
+ * const documents = await splitter.splitDocuments(rawDocuments);
+ *
+ * let time = Date.now();
+ * const vectorstore = await ConvexVectorStore.fromDocuments(
+ *   documents,
+ *   cacheBackedEmbeddings,
+ *   { ctx },
+ * );
+ * console.log(`Initial creation time: ${Date.now() - time}ms`);
+ *
+ * time = Date.now();
+ * const vectorstore2 = await ConvexVectorStore.fromDocuments(
+ *   documents,
+ *   cacheBackedEmbeddings,
+ *   { ctx },
+ * );
+ * console.log(`Cached creation time: ${Date.now() - time}ms`);
+ *
+ * ```
  */
 export declare class CacheBackedEmbeddings extends Embeddings {
     protected underlyingEmbeddings: Embeddings;

package/dist/embeddings/cache_backed.js

@@ -10,6 +10,43 @@ import { Embeddings } from "./base.js";
  *
  * If need be, the interface can be extended to accept other implementations
  * of the value serializer and deserializer, as well as the key encoder.
+ * @example
+ * ```typescript
+ * const underlyingEmbeddings = new OpenAIEmbeddings();
+ *
+ * const cacheBackedEmbeddings = CacheBackedEmbeddings.fromBytesStore(
+ *   underlyingEmbeddings,
+ *   new ConvexKVStore({ ctx }),
+ *   {
+ *     namespace: underlyingEmbeddings.modelName,
+ *   },
+ * );
+ *
+ * const loader = new TextLoader("./state_of_the_union.txt");
+ * const rawDocuments = await loader.load();
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *   chunkSize: 1000,
+ *   chunkOverlap: 0,
+ * });
+ * const documents = await splitter.splitDocuments(rawDocuments);
+ *
+ * let time = Date.now();
+ * const vectorstore = await ConvexVectorStore.fromDocuments(
+ *   documents,
+ *   cacheBackedEmbeddings,
+ *   { ctx },
+ * );
+ * console.log(`Initial creation time: ${Date.now() - time}ms`);
+ *
+ * time = Date.now();
+ * const vectorstore2 = await ConvexVectorStore.fromDocuments(
+ *   documents,
+ *   cacheBackedEmbeddings,
+ *   { ctx },
+ * );
+ * console.log(`Cached creation time: ${Date.now() - time}ms`);
+ *
+ * ```
  */
 export class CacheBackedEmbeddings extends Embeddings {
     constructor(fields) {

package/dist/embeddings/cohere.cjs

@@ -6,6 +6,16 @@ const env_js_1 = require("../util/env.cjs");
 const base_js_1 = require("./base.cjs");
 /**
  * A class for generating embeddings using the Cohere API.
+ * @example
+ * ```typescript
+ * // Embed a query using the CohereEmbeddings class
+ * const model = new ChatOpenAI();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * console.log({ res });
+ *
+ * ```
  */
 class CohereEmbeddings extends base_js_1.Embeddings {
     /**

package/dist/embeddings/cohere.d.ts

@@ -13,6 +13,16 @@ export interface CohereEmbeddingsParams extends EmbeddingsParams {
 }
 /**
  * A class for generating embeddings using the Cohere API.
+ * @example
+ * ```typescript
+ * // Embed a query using the CohereEmbeddings class
+ * const model = new ChatOpenAI();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * console.log({ res });
+ *
+ * ```
  */
 export declare class CohereEmbeddings extends Embeddings implements CohereEmbeddingsParams {
     modelName: string;

package/dist/embeddings/cohere.js

@@ -3,6 +3,16 @@ import { getEnvironmentVariable } from "../util/env.js";
 import { Embeddings } from "./base.js";
 /**
  * A class for generating embeddings using the Cohere API.
+ * @example
+ * ```typescript
+ * // Embed a query using the CohereEmbeddings class
+ * const model = new ChatOpenAI();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * console.log({ res });
+ *
+ * ```
  */
 export class CohereEmbeddings extends Embeddings {
     /**

package/dist/embeddings/googlepalm.cjs

@@ -8,6 +8,23 @@ const env_js_1 = require("../util/env.cjs");
 /**
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Google Palm API.
+ * @example
+ * ```typescript
+ * const model = new GooglePaLMEmbeddings({
+ *   apiKey: "<YOUR API KEY>",
+ *   modelName: "models/embedding-gecko-001",
+ * });
+ *
+ * // Embed a single query
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ *
+ * // Embed multiple documents
+ * const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
+ * console.log({ documentRes });
+ * ```
  */
 class GooglePaLMEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {

package/dist/embeddings/googlepalm.d.ts

@@ -18,6 +18,23 @@ export interface GooglePaLMEmbeddingsParams extends EmbeddingsParams {
 /**
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Google Palm API.
+ * @example
+ * ```typescript
+ * const model = new GooglePaLMEmbeddings({
+ *   apiKey: "<YOUR API KEY>",
+ *   modelName: "models/embedding-gecko-001",
+ * });
+ *
+ * // Embed a single query
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ *
+ * // Embed multiple documents
+ * const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
+ * console.log({ documentRes });
+ * ```
  */
 export declare class GooglePaLMEmbeddings extends Embeddings implements GooglePaLMEmbeddingsParams {
     apiKey?: string;

package/dist/embeddings/googlepalm.js

@@ -5,6 +5,23 @@ import { getEnvironmentVariable } from "../util/env.js";
 /**
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Google Palm API.
+ * @example
+ * ```typescript
+ * const model = new GooglePaLMEmbeddings({
+ *   apiKey: "<YOUR API KEY>",
+ *   modelName: "models/embedding-gecko-001",
+ * });
+ *
+ * // Embed a single query
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ *
+ * // Embed multiple documents
+ * const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
+ * console.log({ documentRes });
+ * ```
  */
 export class GooglePaLMEmbeddings extends Embeddings {
     constructor(fields) {

package/dist/embeddings/googlevertexai.cjs

@@ -18,6 +18,14 @@ const chunk_js_1 = require("../util/chunk.cjs");
  * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
  *   path of a credentials file for a service account permitted to the
  *   Google Cloud project using Vertex AI.
+ * @example
+ * ```typescript
+ * const model = new GoogleVertexAIEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 class GoogleVertexAIEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {

package/dist/embeddings/googlevertexai.d.ts

@@ -21,6 +21,14 @@ export interface GoogleVertexAIEmbeddingsParams extends EmbeddingsParams, Google
  * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
  *   path of a credentials file for a service account permitted to the
  *   Google Cloud project using Vertex AI.
+ * @example
+ * ```typescript
+ * const model = new GoogleVertexAIEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 export declare class GoogleVertexAIEmbeddings extends Embeddings implements GoogleVertexAIEmbeddingsParams {
     model: string;

package/dist/embeddings/googlevertexai.js

@@ -15,6 +15,14 @@ import { chunkArray } from "../util/chunk.js";
  * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
  *   path of a credentials file for a service account permitted to the
  *   Google Cloud project using Vertex AI.
+ * @example
+ * ```typescript
+ * const model = new GoogleVertexAIEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 export class GoogleVertexAIEmbeddings extends Embeddings {
     constructor(fields) {

package/dist/embeddings/hf_transformers.cjs

@@ -4,6 +4,24 @@ exports.HuggingFaceTransformersEmbeddings = void 0;
 const transformers_1 = require("@xenova/transformers");
 const chunk_js_1 = require("../util/chunk.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * @example
+ * ```typescript
+ * const model = new HuggingFaceTransformersEmbeddings({
+ *   modelName: "Xenova/all-MiniLM-L6-v2",
+ * });
+ *
+ * // Embed a single query
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ *
+ * // Embed multiple documents
+ * const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
+ * console.log({ documentRes });
+ * ```
+ */
 class HuggingFaceTransformersEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {
         super(fields ?? {});

package/dist/embeddings/hf_transformers.d.ts

@@ -16,6 +16,24 @@ export interface HuggingFaceTransformersEmbeddingsParams extends EmbeddingsParam
      */
     stripNewLines?: boolean;
 }
+/**
+ * @example
+ * ```typescript
+ * const model = new HuggingFaceTransformersEmbeddings({
+ *   modelName: "Xenova/all-MiniLM-L6-v2",
+ * });
+ *
+ * // Embed a single query
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ *
+ * // Embed multiple documents
+ * const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
+ * console.log({ documentRes });
+ * ```
+ */
 export declare class HuggingFaceTransformersEmbeddings extends Embeddings implements HuggingFaceTransformersEmbeddingsParams {
     modelName: string;
     batchSize: number;

package/dist/embeddings/hf_transformers.js

@@ -1,6 +1,24 @@
 import { pipeline } from "@xenova/transformers";
 import { chunkArray } from "../util/chunk.js";
 import { Embeddings } from "./base.js";
+/**
+ * @example
+ * ```typescript
+ * const model = new HuggingFaceTransformersEmbeddings({
+ *   modelName: "Xenova/all-MiniLM-L6-v2",
+ * });
+ *
+ * // Embed a single query
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ *
+ * // Embed multiple documents
+ * const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
+ * console.log({ documentRes });
+ * ```
+ */
 export class HuggingFaceTransformersEmbeddings extends Embeddings {
     constructor(fields) {
         super(fields ?? {});

package/dist/embeddings/llama_cpp.cjs

@@ -3,6 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LlamaCppEmbeddings = void 0;
 const llama_cpp_js_1 = require("../util/llama_cpp.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * @example
+ * ```typescript
+ * // Initialize LlamaCppEmbeddings with the path to the model file
+ * const embeddings = new LlamaCppEmbeddings({
+ *   modelPath: "/Replace/with/path/to/your/model/gguf-llama2-q4_0.bin",
+ * });
+ *
+ * // Embed a query string using the Llama embeddings
+ * const res = embeddings.embedQuery("Hello Llama!");
+ *
+ * // Output the resulting embeddings
+ * console.log(res);
+ *
+ * ```
+ */
 class LlamaCppEmbeddings extends base_js_1.Embeddings {
     constructor(inputs) {
         super(inputs);

package/dist/embeddings/llama_cpp.d.ts

@@ -7,6 +7,22 @@ import { Embeddings, EmbeddingsParams } from "./base.js";
  */
 export interface LlamaCppEmbeddingsParams extends LlamaBaseCppInputs, EmbeddingsParams {
 }
+/**
+ * @example
+ * ```typescript
+ * // Initialize LlamaCppEmbeddings with the path to the model file
+ * const embeddings = new LlamaCppEmbeddings({
+ *   modelPath: "/Replace/with/path/to/your/model/gguf-llama2-q4_0.bin",
+ * });
+ *
+ * // Embed a query string using the Llama embeddings
+ * const res = embeddings.embedQuery("Hello Llama!");
+ *
+ * // Output the resulting embeddings
+ * console.log(res);
+ *
+ * ```
+ */
 export declare class LlamaCppEmbeddings extends Embeddings {
     _model: LlamaModel;
     _context: LlamaContext;

package/dist/embeddings/llama_cpp.js

@@ -1,5 +1,21 @@
 import { createLlamaModel, createLlamaContext, } from "../util/llama_cpp.js";
 import { Embeddings } from "./base.js";
+/**
+ * @example
+ * ```typescript
+ * // Initialize LlamaCppEmbeddings with the path to the model file
+ * const embeddings = new LlamaCppEmbeddings({
+ *   modelPath: "/Replace/with/path/to/your/model/gguf-llama2-q4_0.bin",
+ * });
+ *
+ * // Embed a query string using the Llama embeddings
+ * const res = embeddings.embedQuery("Hello Llama!");
+ *
+ * // Output the resulting embeddings
+ * console.log(res);
+ *
+ * ```
+ */
 export class LlamaCppEmbeddings extends Embeddings {
     constructor(inputs) {
         super(inputs);

package/dist/embeddings/minimax.cjs

@@ -7,6 +7,21 @@ const base_js_1 = require("./base.cjs");
 /**
  * Class for generating embeddings using the Minimax API. Extends the
  * Embeddings class and implements MinimaxEmbeddingsParams
+ * @example
+ * ```typescript
+ * const embeddings = new MinimaxEmbeddings();
+ *
+ * // Embed a single query
+ * const queryEmbedding = await embeddings.embedQuery("Hello world");
+ * console.log(queryEmbedding);
+ *
+ * // Embed multiple documents
+ * const documentsEmbedding = await embeddings.embedDocuments([
+ *   "Hello world",
+ *   "Bye bye",
+ * ]);
+ * console.log(documentsEmbedding);
+ * ```
  */
 class MinimaxEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {

package/dist/embeddings/minimax.d.ts

@@ -64,6 +64,21 @@ export interface CreateMinimaxEmbeddingRequest {
 /**
  * Class for generating embeddings using the Minimax API. Extends the
  * Embeddings class and implements MinimaxEmbeddingsParams
+ * @example
+ * ```typescript
+ * const embeddings = new MinimaxEmbeddings();
+ *
+ * // Embed a single query
+ * const queryEmbedding = await embeddings.embedQuery("Hello world");
+ * console.log(queryEmbedding);
+ *
+ * // Embed multiple documents
+ * const documentsEmbedding = await embeddings.embedDocuments([
+ *   "Hello world",
+ *   "Bye bye",
+ * ]);
+ * console.log(documentsEmbedding);
+ * ```
  */
 export declare class MinimaxEmbeddings extends Embeddings implements MinimaxEmbeddingsParams {
     modelName: string;

package/dist/embeddings/minimax.js

@@ -4,6 +4,21 @@ import { Embeddings } from "./base.js";
 /**
  * Class for generating embeddings using the Minimax API. Extends the
  * Embeddings class and implements MinimaxEmbeddingsParams
+ * @example
+ * ```typescript
+ * const embeddings = new MinimaxEmbeddings();
+ *
+ * // Embed a single query
+ * const queryEmbedding = await embeddings.embedQuery("Hello world");
+ * console.log(queryEmbedding);
+ *
+ * // Embed multiple documents
+ * const documentsEmbedding = await embeddings.embedDocuments([
+ *   "Hello world",
+ *   "Bye bye",
+ * ]);
+ * console.log(documentsEmbedding);
+ * ```
  */
 export class MinimaxEmbeddings extends Embeddings {
     constructor(fields) {

package/dist/embeddings/openai.cjs

@@ -11,6 +11,16 @@ const openai_js_1 = require("../util/openai.cjs");
  * Class for generating embeddings using the OpenAI API. Extends the
  * Embeddings class and implements OpenAIEmbeddingsParams and
  * AzureOpenAIInput.
+ * @example
+ * ```typescript
+ * // Embed a query using OpenAIEmbeddings to generate embeddings for a given text
+ * const model = new OpenAIEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * console.log({ res });
+ *
+ * ```
  */
 class OpenAIEmbeddings extends base_js_1.Embeddings {
     constructor(fields, configuration) {

package/dist/embeddings/openai.d.ts

@@ -27,6 +27,16 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
  * Class for generating embeddings using the OpenAI API. Extends the
  * Embeddings class and implements OpenAIEmbeddingsParams and
  * AzureOpenAIInput.
+ * @example
+ * ```typescript
+ * // Embed a query using OpenAIEmbeddings to generate embeddings for a given text
+ * const model = new OpenAIEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * console.log({ res });
+ *
+ * ```
  */
 export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbeddingsParams, AzureOpenAIInput {
     modelName: string;

package/dist/embeddings/openai.js

@@ -8,6 +8,16 @@ import { wrapOpenAIClientError } from "../util/openai.js";
  * Class for generating embeddings using the OpenAI API. Extends the
  * Embeddings class and implements OpenAIEmbeddingsParams and
  * AzureOpenAIInput.
+ * @example
+ * ```typescript
+ * // Embed a query using OpenAIEmbeddings to generate embeddings for a given text
+ * const model = new OpenAIEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * console.log({ res });
+ *
+ * ```
  */
 export class OpenAIEmbeddings extends Embeddings {
     constructor(fields, configuration) {

package/dist/embeddings/tensorflow.cjs

@@ -31,6 +31,22 @@ const base_js_1 = require("./base.cjs");
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Universal Sentence Encoder model from
  * TensorFlow.js.
+ * @example
+ * ```typescript
+ * const embeddings = new TensorFlowEmbeddings();
+ * const store = new MemoryVectorStore(embeddings);
+ *
+ * const documents = [
+ *   "A document",
+ *   "Some other piece of text",
+ *   "One more",
+ *   "And another",
+ * ];
+ *
+ * await store.addDocuments(
+ *   documents.map((pageContent) => new Document({ pageContent }))
+ * );
+ * ```
  */
 class TensorFlowEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {

package/dist/embeddings/tensorflow.d.ts

@@ -10,6 +10,22 @@ export interface TensorFlowEmbeddingsParams extends EmbeddingsParams {
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Universal Sentence Encoder model from
  * TensorFlow.js.
+ * @example
+ * ```typescript
+ * const embeddings = new TensorFlowEmbeddings();
+ * const store = new MemoryVectorStore(embeddings);
+ *
+ * const documents = [
+ *   "A document",
+ *   "Some other piece of text",
+ *   "One more",
+ *   "And another",
+ * ];
+ *
+ * await store.addDocuments(
+ *   documents.map((pageContent) => new Document({ pageContent }))
+ * );
+ * ```
  */
 export declare class TensorFlowEmbeddings extends Embeddings {
     constructor(fields?: TensorFlowEmbeddingsParams);

package/dist/embeddings/tensorflow.js

@@ -5,6 +5,22 @@ import { Embeddings } from "./base.js";
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Universal Sentence Encoder model from
  * TensorFlow.js.
+ * @example
+ * ```typescript
+ * const embeddings = new TensorFlowEmbeddings();
+ * const store = new MemoryVectorStore(embeddings);
+ *
+ * const documents = [
+ *   "A document",
+ *   "Some other piece of text",
+ *   "One more",
+ *   "And another",
+ * ];
+ *
+ * await store.addDocuments(
+ *   documents.map((pageContent) => new Document({ pageContent }))
+ * );
+ * ```
  */
 export class TensorFlowEmbeddings extends Embeddings {
     constructor(fields) {

package/dist/experimental/autogpt/agent.cjs

@@ -13,6 +13,27 @@ const count_tokens_js_1 = require("../../base_language/count_tokens.cjs");
  * Class representing the AutoGPT concept with LangChain primitives. It is
  * designed to be used with a set of tools such as a search tool,
  * write-file tool, and a read-file tool.
+ * @example
+ * ```typescript
+ * const autogpt = AutoGPT.fromLLMAndTools(
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   [
+ *     new ReadFileTool({ store: new InMemoryFileStore() }),
+ *     new WriteFileTool({ store: new InMemoryFileStore() }),
+ *     new SerpAPI("YOUR_SERPAPI_API_KEY", {
+ *       location: "San Francisco,California,United States",
+ *       hl: "en",
+ *       gl: "us",
+ *     }),
+ *   ],
+ *   {
+ *     memory: new MemoryVectorStore(new OpenAIEmbeddings()).asRetriever(),
+ *     aiName: "Tom",
+ *     aiRole: "Assistant",
+ *   },
+ * );
+ * const result = await autogpt.run(["write a weather report for SF today"]);
+ * ```
  */
 class AutoGPT {
     constructor({ aiName, memory, chain, outputParser, tools, feedbackTool, maxIterations, }) {