langchain_community.utilities.zapier.ZapierNLAWrapper

class langchain_community.utilities.zapier.ZapierNLAWrapper[source]

Bases: 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。请查阅上面的完整文档，了解如何创建自己的提供程序并生成凭据。

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

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][source]

返回与当前用户关联的所有公开（已启用）操作的列表（与设置的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）

Return type

List[Dict]

async alist_as_str() → str[source]

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

Return type

str

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

与运行相同，但是不会实际执行动作，而是会返回AI猜测的参数预览，以便您在执行之前需要明确审查。

Parameters

  • action_id (str) –

  • instructions (str) –

  • params (Optional[Dict]) –

Return type

Dict

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

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

Return type

str

async arun(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调用的提示中。

Parameters

  • action_id (str) –

  • instructions (str) –

  • params (Optional[Dict]) –

Return type

Dict

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

与运行相同，但返回JSON的字符串版本，以便插入回LLM。

Return type

str

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Parameters

  • _fields_set (Optional[SetStr]) –

  • values (Any) –

Return type

Model

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include

  • update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

  • deep (bool) – set to True to make a deep copy of the model

  • self (Model) –

Returns

new model instance

Return type

Model

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

Return type

DictStrAny

classmethod from_orm(obj: Any) → Model
Parameters

obj (Any) –

Return type

Model

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

  • encoder (Optional[Callable[[Any], Any]]) –

  • models_as_dict (bool) –

  • dumps_kwargs (Any) –

Return type

unicode

list() → List[Dict][source]

返回与当前用户关联（与设置的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）

Return type

List[Dict]

list_as_str() → str[source]

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

Return type

str

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
Parameters

  • path (Union[str, Path]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

classmethod parse_obj(obj: Any) → Model
Parameters

obj (Any) –

Return type

Model

classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
Parameters

  • b (Union[str, bytes]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

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

与运行相同，但是不会实际执行动作，而是会返回AI猜测的参数预览，以便您在执行之前需要明确审查。

Parameters

  • action_id (str) –

  • instructions (str) –

  • params (Optional[Dict]) –

Return type

Dict

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

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

Return type

str

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调用的提示中。

Parameters

  • action_id (str) –

  • instructions (str) –

  • params (Optional[Dict]) –

Return type

Dict

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

与运行相同，但返回JSON的字符串版本，以便插入回LLM。

Return type

str

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny
Parameters

  • by_alias (bool) –

  • ref_template (unicode) –

Return type

DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode
Parameters

  • by_alias (bool) –

  • ref_template (unicode) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod update_forward_refs(**localns: Any) → None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Parameters

localns (Any) –

Return type

None

classmethod validate(value: Any) → Model
Parameters

value (Any) –

Return type

Model

Examples using ZapierNLAWrapper