langchain_community.tools.openapi.utils.api_models.APIProperty

class langchain_community.tools.openapi.utils.api_models.APIProperty

基础： APIPropertyBase

查询、路径、头部或cookie参数中属性的模式。

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

如果输入数据无法解析为有效的模式，则抛出ValidationError。

参数 default: Optional[Any] = None

属性的默认值。

参数 description: Optional[str] = None

属性的描述。

参数 location: APIPropertyLocation [Required]

如何将属性传递到端点。

参数 name: str [Required]

属性名称。

参数 required: bool [Required]

属性是否必须。

参数 type: Union[str, Type, tuple, None, Enum] = None

属性的类型。

可以是基本类型、组件/参数类型，或者以上类型数组的‘object’（字典）。

classmethod from_parameter(parameter: Parameter, spec: OpenAPISpec) → APIProperty

从OpenAPI参数实例化。

参数

• parameter (Parameter) –

• spec (OpenAPISpec) –

返回类型

APIProperty

static is_supported_location(location: str) → bool

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

参数

location (str) –

返回类型

布尔型