prompt_values.d.ts 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. import { Serializable } from "./load/serializable.js";
  2. import { type BaseMessage } from "./messages/base.js";
  3. import { HumanMessage } from "./messages/human.js";
  4. export interface BasePromptValueInterface extends Serializable {
  5. toString(): string;
  6. toChatMessages(): BaseMessage[];
  7. }
  8. export interface StringPromptValueInterface extends BasePromptValueInterface {
  9. value: string;
  10. }
  11. export interface ChatPromptValueInterface extends BasePromptValueInterface {
  12. messages: BaseMessage[];
  13. }
  14. /**
  15. * Base PromptValue class. All prompt values should extend this class.
  16. */
  17. export declare abstract class BasePromptValue extends Serializable implements BasePromptValueInterface {
  18. abstract toString(): string;
  19. abstract toChatMessages(): BaseMessage[];
  20. }
  21. /**
  22. * Represents a prompt value as a string. It extends the BasePromptValue
  23. * class and overrides the toString and toChatMessages methods.
  24. */
  25. export declare class StringPromptValue extends BasePromptValue implements StringPromptValueInterface {
  26. static lc_name(): string;
  27. lc_namespace: string[];
  28. lc_serializable: boolean;
  29. value: string;
  30. constructor(value: string);
  31. toString(): string;
  32. toChatMessages(): HumanMessage[];
  33. }
  34. /**
  35. * Interface for the fields of a ChatPromptValue.
  36. */
  37. export interface ChatPromptValueFields {
  38. messages: BaseMessage[];
  39. }
  40. /**
  41. * Class that represents a chat prompt value. It extends the
  42. * BasePromptValue and includes an array of BaseMessage instances.
  43. */
  44. export declare class ChatPromptValue extends BasePromptValue implements ChatPromptValueInterface {
  45. lc_namespace: string[];
  46. lc_serializable: boolean;
  47. static lc_name(): string;
  48. messages: BaseMessage[];
  49. constructor(messages: BaseMessage[]);
  50. constructor(fields: ChatPromptValueFields);
  51. toString(): string;
  52. toChatMessages(): BaseMessage[];
  53. }
  54. export type ImageContent = {
  55. /** Specifies the detail level of the image. */
  56. detail?: "auto" | "low" | "high";
  57. /** Either a URL of the image or the base64 encoded image data. */
  58. url: string;
  59. };
  60. export interface ImagePromptValueFields {
  61. imageUrl: ImageContent;
  62. }
  63. /**
  64. * Class that represents an image prompt value. It extends the
  65. * BasePromptValue and includes an ImageURL instance.
  66. */
  67. export declare class ImagePromptValue extends BasePromptValue {
  68. lc_namespace: string[];
  69. lc_serializable: boolean;
  70. static lc_name(): string;
  71. imageUrl: ImageContent;
  72. /** @ignore */
  73. value: string;
  74. constructor(fields: ImagePromptValueFields);
  75. constructor(fields: ImageContent);
  76. toString(): string;
  77. toChatMessages(): HumanMessage[];
  78. }