Skip to content

feat: support retrieveVectors in getDocument #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tcferreira wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: support retrieveVectors in getDocument #920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/Endpoints/Delegates/HandlesDocuments.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,17 @@ trait HandlesDocuments
{
/**
* @param non-empty-string|int $documentId
* @param list<non-empty-string>|null $fields
*/
public function getDocument(string|int $documentId, ?array $fields = null): array
public function getDocument(string|int $documentId, ?array $fields = null, bool $retrieveVectors = false): array
{
$query = isset($fields) ? ['fields' => implode(',', $fields)] : [];
$query = [];
if (isset($fields)) {
$query['fields'] = implode(',', $fields);
}
if ($retrieveVectors) {
$query['retrieveVectors'] = true;
}

return $this->http->get(self::PATH.'/'.$this->uid.'/documents/'.$documentId, $query);
}
Expand Down
16 changes: 16 additions & 0 deletions tests/Endpoints/DocumentsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -681,6 +681,22 @@ public function testGetDocumentsWithVector(): void
self::assertCount(5, $response);
}

public function testGetDocumentWithVector(): void
{
$index = $this->createEmptyIndex($this->safeIndexName('movies'));

$index->updateEmbedders(['manual' => ['source' => 'userProvided', 'dimensions' => 3]])->wait();
$index->updateDocuments(self::VECTOR_MOVIES)->wait();

$documentId = self::VECTOR_MOVIES[0]['id'];

$response = $index->getDocument($documentId);
self::assertArrayNotHasKey('_vectors', $response);

$response = $index->getDocument($documentId, null, true);
self::assertArrayHasKey('_vectors', $response);
}

public function testGetDocumentsMessageHintException(): void
{
$responseMock = $this->createMock(ResponseInterface::class);
Expand Down
Loading