SimilarDocumentsQuery
in package
Table of Contents
Properties
- $attributesToRetrieve : array<int, non-empty-string>|null
- $embedder : non-empty-string
- $filter : array<int, array<int, string>|string>|null
- $id : int|string
- $limit : positive-int|null
- $offset : int|null
- $rankingScoreThreshold : int|float|null
- $retrieveVectors : bool|null
- $showRankingScore : bool|null
- $showRankingScoreDetails : bool|null
Methods
- __construct() : mixed
- setAttributesToRetrieve() : $this
- setFilter() : $this
- setLimit() : $this
- setOffset() : $this
- setRankingScoreThreshold() : $this
- setRetrieveVectors() : $this
- setShowRankingScore() : $this
- setShowRankingScoreDetails() : $this
- toArray() : array<string|int, mixed>
Properties
$attributesToRetrieve
private
array<int, non-empty-string>|null
$attributesToRetrieve
= null
$embedder
private
non-empty-string
$embedder
$filter
private
array<int, array<int, string>|string>|null
$filter
= null
$id
private
int|string
$id
$limit
private
positive-int|null
$limit
= null
$offset
private
int|null
$offset
= null
non-negative-int|null
$rankingScoreThreshold
private
int|float|null
$rankingScoreThreshold
$retrieveVectors
private
bool|null
$retrieveVectors
= null
$showRankingScore
private
bool|null
$showRankingScore
= null
$showRankingScoreDetails
private
bool|null
$showRankingScoreDetails
= null
Methods
__construct()
public
__construct(int|string $id, non-empty-string $embedder) : mixed
Parameters
- $id : int|string
- $embedder : non-empty-string
setAttributesToRetrieve()
public
setAttributesToRetrieve(array<int, non-empty-string> $attributesToRetrieve) : $this
Parameters
- $attributesToRetrieve : array<int, non-empty-string>
-
an array of attribute names to retrieve
Return values
$thissetFilter()
public
setFilter(array<int, array<int, string>|string> $filter) : $this
Parameters
- $filter : array<int, array<int, string>|string>
-
an array of arrays representing filter conditions
Return values
$thissetLimit()
public
setLimit(positive-int|null $limit) : $this
Parameters
- $limit : positive-int|null
Return values
$thissetOffset()
public
setOffset(int|null $offset) : $this
Parameters
- $offset : int|null
Return values
$thissetRankingScoreThreshold()
public
setRankingScoreThreshold(int|float|null $rankingScoreThreshold) : $this
Parameters
- $rankingScoreThreshold : int|float|null
Return values
$thissetRetrieveVectors()
public
setRetrieveVectors(bool|null $retrieveVectors) : $this
Parameters
- $retrieveVectors : bool|null
-
boolean value to show _vector details
Return values
$thissetShowRankingScore()
public
setShowRankingScore(bool|null $showRankingScore) : $this
Parameters
- $showRankingScore : bool|null
-
boolean value to show ranking score
Return values
$thissetShowRankingScoreDetails()
public
setShowRankingScoreDetails(bool|null $showRankingScoreDetails) : $this
Parameters
- $showRankingScoreDetails : bool|null
-
boolean value to show ranking score details
Return values
$thistoArray()
public
toArray() : array<string|int, mixed>