langchain
Version:
Typescript bindings for langchain
40 lines (38 loc) • 2.01 kB
TypeScript
import { basePush } from "./base.js";
import { Runnable } from "@langchain/core/runnables";
import { BaseLanguageModel } from "@langchain/core/language_models/base";
//#region src/hub/index.d.ts
/**
* Pull a prompt from the hub.
*
* @param ownerRepoCommit The name of the repo containing the prompt, as well as an optional commit hash separated by a slash.
* @param options.apiKey LangSmith API key to use when pulling the prompt
* @param options.apiUrl LangSmith API URL to use when pulling the prompt
* @param options.includeModel Whether to also instantiate and attach a model instance to the prompt,
* if the prompt has associated model metadata. If set to true, invoking the resulting pulled prompt will
* also invoke the instantiated model. For non-OpenAI models, you must also set "modelClass" to the
* correct class of the model.
* @param options.modelClass If includeModel is true, the class of the model to instantiate. Required
* for non-OpenAI models. If you are running in Node or another environment that supports dynamic imports,
* you may instead import this function from "langchain/hub/node" and pass "includeModel: true" instead
* of specifying this parameter.
* @param options.secrets A map of secrets to use when loading, e.g.
* {'OPENAI_API_KEY': 'sk-...'}`.
* If a secret is not found in the map, it will be loaded from the
* environment if `secrets_from_env` is `True`. Should only be needed when
* `includeModel` is `true`.
* @param options.secretsFromEnv Whether to load secrets from environment variables.
* Use with caution and only with trusted prompts.
* @returns
*/
declare function pull<T extends Runnable>(ownerRepoCommit: string, options?: {
apiKey?: string;
apiUrl?: string;
includeModel?: boolean;
modelClass?: new (...args: any[]) => BaseLanguageModel;
secrets?: Record<string, string>;
secretsFromEnv?: boolean;
}): Promise<T>;
//#endregion
export { pull, basePush as push };
//# sourceMappingURL=index.d.ts.map