API属性#

class langchain_community.tools.openapi.utils.api_models.APIProperty[source]#

基础类:APIPropertyBase

查询、路径、头信息或cookie参数中属性的模型。

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

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

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

param default: Any | None = None#

属性的默认值。

param description: str | None = None#

属性的描述。

param location: APIPropertyLocation [Required]#

路径/它是如何传递到端点的。

param name: str [Required]#

属性的名称。

param required: bool [Required]#

该属性是否为必填项。

param type: SCHEMA_TYPE [Required]#

属性的类型。

可以是原始类型、组件/参数类型,或者是上述类型的数组或‘对象’(字典)。

classmethod from_parameter(parameter: Parameter, spec: OpenAPISpec) APIProperty[source]#

从OpenAPI参数实例化。

Parameters:
Return type:

APIProperty

static is_supported_location(location: str) bool[source]#

返回提供的位置是否受支持。

Parameters:

位置 (字符串)

Return type:

布尔