BoxSearchOptions#
- class langchain_box.utilities.box.BoxSearchOptions[source]#
Bases:
BaseModelCreate a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- param ancestor_folder_ids: List[str] | None = None#
Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs.
- param created_date_range: List[str] | None = None#
Limits the search results to any items created within a given date range.
Date ranges are defined as comma separated RFC3339 timestamps.
If the the start date is omitted (,2014-05-17T13:35:01-07:00) anything created before the end date will be returned.
If the end date is omitted (2014-05-15T13:35:01-07:00,) the current date will be used as the end date instead.
- param file_extensions: List[DocumentFiles] | None = None#
Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of
langchain_box.utilities.DocumentFilesentries
- param k: int | None = 100#
Defines the maximum number of items to return. Defaults to 100, maximum is 200.
- param search_type_filter: List[SearchTypeFilter] | None = None#
Limits the search results to any items that match the search query for a specific part of the file, for example the file description.
Content types are defined as a comma separated lists of Box recognized content types. The allowed content types are as follows. Default is all.
- param size_range: List[int] | None = None#
Limits the search results to any items with a size within a given file size range. This applied to files and folders.
Size ranges are defined as comma separated list of a lower and upper byte size limit (inclusive).
The upper and lower bound can be omitted to create open ranges.
- param updated_date_range: List[str] | None = None#
Limits the search results to any items updated within a given date range.
Date ranges are defined as comma separated RFC3339 timestamps.
If the start date is omitted (,2014-05-17T13:35:01-07:00) anything updated before the end date will be returned.
If the end date is omitted (2014-05-15T13:35:01-07:00,) the current date will be used as the end date instead.