langchain_community.utilities.zapier.ZapierNLAWrapper

class langchain_community.utilities.zapier.ZapierNLAWrapper[源代码]

基类:BaseModel

Zapier NLA 的封装器。

完整文档在此处:https://nla.zapier.com/start/

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

使用 zapier_nla_api_keyzapier_nla_oauth_access_token 参数调用此封装器,或设置 ZAPIER_NLA_API_KEY 环境变量。如果都设置了参数,则访问令牌将具有优先权。

对于 LangChain + Zapier NLA 驱动的前端应用用例,并且 LangChain 需要访问用户在 Zapier.com 上连接的账户的情况,您需要使用 OAuth。请查阅上面的完整文档,以了解如何创建自己的提供程序并生成凭据。

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

如果输入数据无法解析成有效的模型,则引发 ValidationError

param zapier_nla_api_base: str = 'https://nla.zapier.com/api/v1/'
param zapier_nla_api_key: str [必需]
param zapier_nla_oauth_access_token: str [必需]
async alist() List[Dict][源代码]

返回与当前用户(关联到设置的 api_key)关联的所有公开(启用)操作的列表。在此修改您的公开操作:https://nla.zapier.com/demo/start/

如果没有任何公开操作,则返回列表可能为空。否则,将包含操作对象的列表

[{

“id”:str, “description”:str, “params”:Dict[str, str]

}]

params 总是包含一个 instructions 键,是唯一必需的参数。所有其他参数都是可选的,如果提供的参数将覆盖任何 AI 推测(请参阅此处:“了解 AI 推测流程”: https://nla.zapier.com/api/v1/docs)

返回类型

List[Dict]

async alist_as_str() str[来源]

与列表相似,但返回一个用于重新插入到 LLM 中的 JSON 字符串格式。

返回类型

字符串

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

与执行(run)相似,但实际上不会执行动作,而是返回 AI 推测的 params 预览,以便在执行前进行明确审查。

参数
  • action_id (字符串) –

  • instructions (字符串) –

  • params (可选[字典]) –

返回类型

字典

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

与预览(preview)相似,但返回一个用于重新插入到 LLM 中的 JSON 字符串格式。

返回类型

字符串

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

执行由 action_id 标识的动作,必须由当前用户(关联到 api_key 集合)公开(启用)。在此更改您的公开动作:https://nla.zapier.com/demo/start/

返回的 JSON 保证少于 ~500 个单词(350 个标记),使其可以安全地注入到另一个 LLM 调用的提示中。

参数
  • action_id (字符串) –

  • instructions (字符串) –

  • params (可选[字典]) –

返回类型

字典

async arun_as_str(*args, **kwargs) str[源代码]

与run功能相同,但返回用于重新插入LLM的JSON的字符串形式。

返回类型

字符串

list() List[Dict][源代码]

返回与当前用户(关联到设置的 api_key)关联的所有公开(启用)操作的列表。在此修改您的公开操作:https://nla.zapier.com/demo/start/

如果没有任何公开操作,则返回列表可能为空。否则,将包含操作对象的列表

[{

“id”:str, “description”:str, “params”:Dict[str, str]

}]

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

返回类型

List[Dict]

list_as_str() str[源代码]

与列表相似,但返回一个用于重新插入到 LLM 中的 JSON 字符串格式。

返回类型

字符串

preview(action_id: str, instructions: str, params: Optional[Dict] = None) Dict[源代码]

与执行(run)相似,但实际上不会执行动作,而是返回 AI 推测的 params 预览,以便在执行前进行明确审查。

参数
  • action_id (字符串) –

  • instructions (字符串) –

  • params (可选[字典]) –

返回类型

字典

preview_as_str(*args, **kwargs) str[源代码]

与预览(preview)相似,但返回一个用于重新插入到 LLM 中的 JSON 字符串格式。

返回类型

字符串

run(action_id: str, instructions: str, params: Optional[Dict] = None) Dict[source]

执行由 action_id 标识的动作,必须由当前用户(关联到 api_key 集合)公开(启用)。在此更改您的公开动作:https://nla.zapier.com/demo/start/

返回的 JSON 保证少于 ~500 个单词(350 个标记),使其可以安全地注入到另一个 LLM 调用的提示中。

参数
  • action_id (字符串) –

  • instructions (字符串) –

  • params (可选[字典]) –

返回类型

字典

run_as_str(*args, **kwargs) str[source]

与run功能相同,但返回用于重新插入LLM的JSON的字符串形式。

返回类型

字符串

使用ZapierNLAWrapper的示例