ZapierNLAWrapper#

class langchain_community.utilities.zapier.ZapierNLAWrapper[source]#

基础类：BaseModel

Zapier NLA的封装器。

完整文档在这里：https://nla.zapier.com/start/

此包装器支持API密钥和OAuth凭证认证方法。API密钥是开始使用此包装器的最快方式。

使用zapier_nla_api_key或zapier_nla_oauth_access_token参数调用此包装器，或设置ZAPIER_NLA_API_KEY环境变量。如果同时设置了这两个参数，访问令牌将优先。

对于LangChain + Zapier NLA驱动面向用户的应用的使用场景，且LangChain需要访问用户在Zapier.com上连接的账户时，您需要使用OAuth。请查看上面的完整文档，了解如何创建您自己的提供者并生成凭证。

通过解析和验证来自关键字参数的输入数据来创建一个新模型。

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param zapier_nla_api_base: str = 'https://nla.zapier.com/api/v1/'#
param zapier_nla_api_key: str [Required]#
param zapier_nla_oauth_access_token: str [Required]#
async alist() → List[Dict][来源]#

返回与当前用户（与设置的api_key相关联）相关联的所有公开（启用）操作的列表。在此处更改您的公开操作：https://nla.zapier.com/demo/start/

如果没有暴露任何操作，返回列表可能为空。否则将包含一个操作对象列表：

[{

“id”: str, “描述”: str, “参数”: Dict[str, str]

}]

params 将始终包含一个 instructions 键，这是唯一必需的参数。所有其他参数都是可选的，如果提供，将覆盖任何AI的猜测（请参阅“理解AI猜测流程”： https://nla.zapier.com/api/v1/docs)

Return type:

列表[字典]

async alist_as_str() → str[source]#

与列表相同，但返回一个字符串化的JSON版本，用于插入回LLM。

Return type:

字符串

async apreview(action_id: str, instructions: str, params: Dict | None = None) → Dict[来源]#

与run相同，但不是实际执行操作，而是返回AI猜测的参数预览，以便在执行前进行明确审查。

Parameters:

  • action_id (str)

  • 说明 (str)

  • params (Dict | None)

Return type:

字典

async apreview_as_str(*args, **kwargs) → str[来源]#

与预览相同，但返回一个字符串化的JSON版本，用于插入回LLM。

Return type:

字符串

async arun(action_id: str, instructions: str, params: Dict | None = None) → Dict[来源]#

执行由action_id标识的操作，必须由当前用户（与设置的api_key关联）暴露（启用）。在此处更改您暴露的操作：https://nla.zapier.com/demo/start/

返回的JSON保证少于约500个单词（350个标记），因此可以安全地注入到另一个LLM调用的提示中。

Parameters:

  • action_id (str)

  • 说明 (str)

  • params (Dict | None)

Return type:

字典

async arun_as_str(*args, **kwargs) → str[source]#

与run相同，但返回一个字符串化的JSON版本，用于插入回LLM。

Return type:

字符串

list() → List[Dict][source]#

返回与当前用户（与设置的api_key相关联）相关联的所有公开（启用）操作的列表。在此处更改您的公开操作：https://nla.zapier.com/demo/start/

如果没有暴露任何操作，返回列表可能为空。否则将包含一个操作对象列表：

[{

“id”: str, “描述”: str, “参数”: Dict[str, str]

}]

params 将始终包含一个 instructions 键，这是唯一必需的参数。所有其他参数都是可选的，如果提供，将覆盖任何AI的猜测（请参阅“理解AI猜测流程”： https://nla.zapier.com/docs/using-the-api#ai-guessing)

Return type:

列表[字典]

list_as_str() → str[来源]#

与列表相同，但返回一个字符串化的JSON版本，用于插入回LLM。

Return type:

字符串

preview(action_id: str, instructions: str, params: Dict | None = None) → Dict[source]#

与run相同，但不是实际执行操作，而是返回AI猜测的参数预览，以便在执行前进行明确审查。

Parameters:

  • action_id (str)

  • 说明 (str)

  • params (Dict | None)

Return type:

字典

preview_as_str(*args, **kwargs) → str[source]#

与预览相同，但返回一个字符串化的JSON版本，用于插入回LLM。

Return type:

字符串

run(action_id: str, instructions: str, params: Dict | None = None) → Dict[来源]#

执行由action_id标识的操作，必须由当前用户（与设置的api_key关联）暴露（启用）。在此处更改您暴露的操作：https://nla.zapier.com/demo/start/

返回的JSON保证少于约500个单词（350个标记），因此可以安全地注入到另一个LLM调用的提示中。

Parameters:

  • action_id (str)

  • 说明 (str)

  • params (Dict | None)

Return type:

字典

run_as_str(*args, **kwargs) → str[来源]#

与run相同，但返回一个字符串化的JSON版本，用于插入回LLM。

Return type:

字符串

使用 ZapierNLAWrapper 的示例