DocumentsQuery
in package
Table of Contents
Properties
- $fields : array<string|int, mixed>
- $filter : array<string|int, mixed>
- $limit : int
- $offset : int
- $retrieveVectors : bool|null
Methods
- hasFilter() : bool
- Checks if the $filter attribute has been set.
- setFields() : DocumentsQuery
- setFilter() : DocumentsQuery
- Sets the filter for the DocumentsQuery.
- setLimit() : DocumentsQuery
- setOffset() : DocumentsQuery
- setRetrieveVectors() : DocumentsQuery
- toArray() : array<string|int, mixed>
- fields() : array<string|int, mixed>|string|null
- Prepares fields for request Fix for 1.2 document/fetch.
Properties
$fields
private
array<string|int, mixed>
$fields
$filter
private
array<string|int, mixed>
$filter
$limit
private
int
$limit
$offset
private
int
$offset
$retrieveVectors
private
bool|null
$retrieveVectors
= null
Methods
hasFilter()
Checks if the $filter attribute has been set.
public
hasFilter() : bool
Return values
bool —true when filter contains at least a non-empty array
setFields()
public
setFields(array<string|int, mixed> $fields) : DocumentsQuery
Parameters
- $fields : array<string|int, mixed>
Return values
DocumentsQuerysetFilter()
Sets the filter for the DocumentsQuery.
public
setFilter(array<int, non-empty-string|array<int, non-empty-string>> $filter) : DocumentsQuery
Parameters
- $filter : array<int, non-empty-string|array<int, non-empty-string>>
-
a filter expression written as an array of strings
Return values
DocumentsQuery —the updated DocumentsQuery instance
setLimit()
public
setLimit(int $limit) : DocumentsQuery
Parameters
- $limit : int
Return values
DocumentsQuerysetOffset()
public
setOffset(int $offset) : DocumentsQuery
Parameters
- $offset : int
Return values
DocumentsQuerysetRetrieveVectors()
public
setRetrieveVectors(bool|null $retrieveVectors) : DocumentsQuery
Parameters
- $retrieveVectors : bool|null
-
boolean value to show _vector details
Return values
DocumentsQuerytoArray()
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>fields()
Prepares fields for request Fix for 1.2 document/fetch.
private
fields() : array<string|int, mixed>|string|null