langchain_core.tools.create_schema_from_function

langchain_core.tools.create_schema_from_function(model_name: str, func: Callable, *, filter_args: Optional[Sequence[str]] = None, parse_docstring: bool = False, error_on_invalid_docstring: bool = False, include_injected: bool = True) → Type[BaseModel][source]

从函数签名创建pydantic模式。

参数

  • model_name (str) – 分配给生成的pydantic模式的名称。

  • func (Callable) – 从中生成模式的函数。

  • filter_args (Optional[Sequence[str]]) – 可选的参数列表，从模式中排除。默认为FILTERED_ARGS。

  • parse_docstring (bool) – 是否为每个参数解析函数的文档字符串以进行描述。默认为False。

  • error_on_invalid_docstring (bool) – 如果提供了parse_docstring，配置在无效的Google样式文档字符串上引发ValueError。默认为False。

  • include_injected (bool) – 是否在模式中包含注入参数。默认为True，因为我们希望在验证工具输入时将它们包含在模式中。

返回

一个与函数相同参数的pydantic模型。

返回类型

Type[BaseModel]