remote.d.ts 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. import { Runnable, RunnableBatchOptions } from "./base.js";
  2. import { type RunnableConfig } from "./config.js";
  3. import { CallbackManagerForChainRun } from "../callbacks/manager.js";
  4. import { RunLogPatch, type LogStreamCallbackHandlerInput, type StreamEvent } from "../tracers/log_stream.js";
  5. import { IterableReadableStream } from "../utils/stream.js";
  6. type RemoteRunnableOptions = {
  7. timeout?: number;
  8. headers?: Record<string, unknown>;
  9. };
  10. /**
  11. * Client for interacting with LangChain runnables
  12. * that are hosted as LangServe endpoints.
  13. *
  14. * Allows you to interact with hosted runnables using the standard
  15. * `.invoke()`, `.stream()`, `.streamEvents()`, etc. methods that
  16. * other runnables support.
  17. *
  18. * @deprecated LangServe is no longer actively developed - please consider using LangGraph Platform.
  19. *
  20. * @param url - The base URL of the LangServe endpoint.
  21. * @param options - Optional configuration for the remote runnable, including timeout and headers.
  22. * @param fetch - Optional custom fetch implementation.
  23. * @param fetchRequestOptions - Optional additional options for fetch requests.
  24. */
  25. export declare class RemoteRunnable<RunInput, RunOutput, CallOptions extends RunnableConfig> extends Runnable<RunInput, RunOutput, CallOptions> {
  26. private url;
  27. private options?;
  28. fetchImplementation: (...args: any[]) => any;
  29. fetchRequestOptions?: Record<string, any>;
  30. lc_namespace: string[];
  31. constructor(fields: {
  32. url: string;
  33. options?: RemoteRunnableOptions;
  34. fetch?: (...args: any[]) => any;
  35. fetchRequestOptions?: Record<string, any>;
  36. });
  37. private post;
  38. _invoke(input: RunInput, options?: Partial<CallOptions>, _?: CallbackManagerForChainRun): Promise<RunOutput>;
  39. invoke(input: RunInput, options?: Partial<CallOptions>): Promise<RunOutput>;
  40. _batch(inputs: RunInput[], options?: Partial<CallOptions>[], _?: (CallbackManagerForChainRun | undefined)[], batchOptions?: RunnableBatchOptions): Promise<(RunOutput | Error)[]>;
  41. batch(inputs: RunInput[], options?: Partial<CallOptions> | Partial<CallOptions>[], batchOptions?: RunnableBatchOptions & {
  42. returnExceptions?: false;
  43. }): Promise<RunOutput[]>;
  44. batch(inputs: RunInput[], options?: Partial<CallOptions> | Partial<CallOptions>[], batchOptions?: RunnableBatchOptions & {
  45. returnExceptions: true;
  46. }): Promise<(RunOutput | Error)[]>;
  47. batch(inputs: RunInput[], options?: Partial<CallOptions> | Partial<CallOptions>[], batchOptions?: RunnableBatchOptions): Promise<(RunOutput | Error)[]>;
  48. _streamIterator(input: RunInput, options?: Partial<CallOptions>): AsyncGenerator<RunOutput>;
  49. streamLog(input: RunInput, options?: Partial<CallOptions>, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): AsyncGenerator<RunLogPatch>;
  50. _streamEvents(input: RunInput, options: Partial<CallOptions> & {
  51. version: "v1" | "v2";
  52. }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose"> | undefined): AsyncGenerator<StreamEvent>;
  53. streamEvents(input: RunInput, options: Partial<CallOptions> & {
  54. version: "v1" | "v2";
  55. }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): IterableReadableStream<StreamEvent>;
  56. streamEvents(input: RunInput, options: Partial<CallOptions> & {
  57. version: "v1" | "v2";
  58. encoding: "text/event-stream";
  59. }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): IterableReadableStream<Uint8Array>;
  60. }
  61. export {};