langchain.tools.openapi.utils.api_models.APIProperty

class langchain.tools.openapi.utils.api_models.APIProperty(*, name: str, required: bool, type: Union[str, Type, tuple, None, Enum] = None, default: Optional[Any] = None, description: Optional[str] = None, location: APIPropertyLocation)

Bases: APIPropertyBase

A model for a property in the query, path, header, or cookie params.

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 default: Optional[Any] = None

The default value of the property.

param description: Optional[str] = None

The description of the property.

param location: langchain.tools.openapi.utils.api_models.APIPropertyLocation [Required]

The path/how it’s being passed to the endpoint.

param name: str [Required]

The name of the property.

param required: bool [Required]

Whether the property is required.

param type: Union[str, Type, tuple, None, enum.Enum] = None

The type of the property.

Either a primitive type, a component/parameter type, or an array or ‘object’ (dict) of the above.

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

Instantiate from an OpenAPI Parameter.

static is_supported_location(location: str) → bool

Return whether the provided location is supported.