Class ZapierNLAWrapper

A wrapper class for Zapier's Natural Language Actions (NLA). It provides an interface to interact with the 5k+ apps and 20k+ actions on Zapier's platform through a natural language API interface. This includes apps like Gmail, Salesforce, Trello, Slack, Asana, HubSpot, Google Sheets, Microsoft Teams, and many more.

Hierarchy

Constructors

Properties

caller: AsyncCaller
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
zapierNlaApiBase: string = "https://nla.zapier.com/api/v1/"
zapierNlaApiKey?: string
zapierNlaOAuthAccessToken?: 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_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;
    }

Methods

  • Returns a list of all exposed (enabled) actions associated with current user (associated with the set api_key or access token).

    Returns Promise<ZapierValues[]>

  • Same as list, but returns a stringified version of the result.

    Returns Promise<string>

  • Same as run, but instead of actually executing the action, will instead return a preview of params that have been guessed by the AI in case you need to explicitly review before executing.

    Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<ZapierValues>

  • Same as preview, but returns a stringified version of the result.

    Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<string>

  • Executes an action that is identified by action_id, must be exposed (enabled) by the current user (associated with the set api_key or access token).

    Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<ZapierValues>

  • Same as run, but returns a stringified version of the result.

    Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<string>

  • The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

    Implemented as a static method to support loading logic.

    Returns string

  • Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<ZapierValues>

Generated using TypeDoc