meilisearch / meilisearch/meilisearch-php

`getDocument` can't use `retrieveVectors`

Open
#809 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug good first issue
Dominant language
PHP
Stars
757
Forks
125
Avg merge
6d 8h
Merged PRs (30d)
2

Description

Description
The documentation says you can get the vector data from a single document by passing retrieveVectors as well.

https://www.meilisearch.com/docs/reference/api/documents#get-one-document

Expected behavior
Pass retrieveVectors: true to getDocument and get the vector data

Current behavior
getDocument signature doesn't include retrieveVectors

public function getDocument($documentId, ?array $fields = null)

https://github.com/meilisearch/meilisearch-php/blob/main/src/Endpoints/Delegates/HandlesDocuments.php#L15C5-L15C68

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/Endpoints/Delegates/HandlesDocuments.php at the getDocument signature shown in the issue, then compare it with the Meilisearch get-one-document documentation. The work is done when getDocument accepts retrieveVectors as documented and returns the requested vector data.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.