API请求体属性#

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

基础类：APIPropertyBase

请求体属性的模型。

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

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

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

param default: Any | None = None#

属性的默认值。

param description: str | None = None#

属性的描述。

param name: str [Required]#

属性的名称。

param properties: List['APIRequestBodyProperty'] [Required]#

属性的子属性。

param references_used: List[str] [Required]#

属性使用的引用。

param required: bool [Required]#

该属性是否为必填项。

param type: SCHEMA_TYPE [Required]#

属性的类型。

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

classmethod from_schema(schema: Schema, name: str, required: bool, spec: OpenAPISpec, references_used: List[str] | None = None) → APIRequestBodyProperty[source]#

从OpenAPI Schema递归填充。

Parameters:

  • schema (Schema)

  • name (str)

  • 必填 (布尔型)

  • spec (OpenAPISpec)

  • references_used (可选[列表[字符串]])

Return type:

APIRequestBodyProperty