langchain.js
    Preparing search index...

    Interface StringPromptValueInterface

    interface StringPromptValueInterface {
        lc_kwargs: SerializedFields;
        lc_namespace: string[];
        lc_serializable: boolean;
        value: string;
        get lc_aliases(): undefined | { [key: string]: string };
        get lc_attributes(): undefined | SerializedFields;
        get lc_id(): string[];
        get lc_secrets(): undefined | { [key: string]: string };
        get lc_serializable_keys(): undefined | string[];
        toChatMessages(): BaseMessage<MessageStructure, MessageType>[];
        toJSON(): Serialized;
        toJSONNotImplemented(): SerializedNotImplemented;
        toString(): string;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    lc_kwargs: SerializedFields
    lc_namespace: string[]

    A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

    lc_serializable: boolean = false
    value: string

    Accessors

    • get lc_aliases(): undefined | { [key: string]: string }

      A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

      Returns undefined | { [key: string]: string }

    • get lc_attributes(): undefined | SerializedFields

      A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

      Returns undefined | SerializedFields

    • get lc_id(): string[]

      The final serialized identifier for the module.

      Returns string[]

    • get lc_secrets(): undefined | { [key: string]: string }

      A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

      Returns undefined | { [key: string]: string }

    • get lc_serializable_keys(): undefined | string[]

      A manual list of keys that should be serialized. If not overridden, all fields passed into the constructor will be serialized.

      Returns undefined | string[]

    Methods

    • Returns a string representation of an object.

      Returns string