Vector Search - `EXPERIMENTAL` by gmourier · Pull Request #248 · meilisearch/specifications

gmourier · 2023-06-23T09:32:12Z

🤖 API Diff

Summary

Describes the experimental vector search related properties and capabilities

Changes

Introduces vector and _semanticScore properties on search-api.md
Introduces the special properties _vectors for a document body
Describes related errors
- invalid_search_vector
- invalid_document_vectors_field
Add the experimental properties on open-api.yaml
Describes added telemetry

Out Of Scope

N/A

Attention To Reviewers

N/A

Misc

Update OpenAPI specification file
Update telemetry datapoints (if needed; Apply the Telemetry label)

github-actions · 2023-06-27T08:45:25Z

🚨 Breaking API change detected:

Modified (3)

[Breaking] DELETE /indexes/{indexUid}/documents/{documentId}
- [Breaking] Header removed: Content-Type
- [Breaking] Body removed
POST /indexes/{indexUid}/search
- Body modified
  - Attribute added: vector
POST /multi-search
- Body modified
  - Attribute modified: queries

Powered by Bump

macraig · 2023-07-07T09:15:12Z

+### Context
+
+This error occurs for the listed reasons:
+- if a value with a different type than `Array of Float` or `null` for `vector` is specified.


Is Array of Float an existing type?

An array of arrays and an empty array aren't supposed to work too?
Or is it not interesting to talk about here?

Is there a point in setting the value of the vector field to null?

@macraig what do you mean by existing type?

cc @Kero

What is the default value of the vector field at search-time? null or []?

If we don't accept [], the default value specified should be null for the field right?

Is there a point in setting the value of the vector field to null?

Depending on your code if you set a query and want to be sure not to use the vector.
[2023-07-13T16:05:55Z WARN meilisearch::search] Ignoring the query string `q` when used with the `vector` parameter.

alallema · 2023-07-09T11:58:42Z

+### Context
+
+This error occurs for the listed reasons:
+- if a value with a different type than `Array of Float` or `null` for `vector` is specified.


An array of arrays and an empty array aren't supposed to work too?
Or is it not interesting to talk about here?

alallema · 2023-07-09T12:00:45Z

+
+### Context
+
+These errors occurs when the `_vectors` field of a document payload is not valid. Either due to the type of it or the number of dimensions.


I thought the type was already checked in the invalid_search_vector. I'm not sure to understand when a synchronous or asynchronous error happens.

Co-authored-by: Maria Craig <marycraig90@gmail.com>

bidoubiwa

✨

* Bump openapi.yaml file * Facet Search API (#246) * Init specification * Adjust spec files to PR number * Fix content-type open-api * Remove fix content-type * Add the telemetry * Update text/0246-facet-search-api.md Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> * Update text/0034-telemetry-policies.md --------- Co-authored-by: Clément Renault <clement@meilisearch.com> Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> * Faceting Setting API - sortFacetValuesBy (#247) * init spec * Add property description and open-api.yaml * Removes future possibility * Update the telemetry * Update the error of the sortFacetValuesBy setting --------- Co-authored-by: Clément Renault <clement@meilisearch.com> * Vector Search - `EXPERIMENTAL` (#248) * Init spec * Fix the vector store fields * Add an information on the invalid_search_vector error code * Add an information on the invalid_vectors_field error codes * Define the new max_vector_size analytic * Update the open-api file with vector capabilities * Apply suggestions from code review * Update open-api.yaml Co-authored-by: Maria Craig <marycraig90@gmail.com> * Update open-api.yaml Co-authored-by: Maria Craig <marycraig90@gmail.com> * Update text/0118-search-api.md Co-authored-by: Maria Craig <marycraig90@gmail.com> * Update text/0061-error-format-and-definitions.md Co-authored-by: Maria Craig <marycraig90@gmail.com> --------- Co-authored-by: Kerollmops <clement@meilisearch.com> Co-authored-by: Maria Craig <marycraig90@gmail.com> * Tasks route total (#253) * Update the tasks route info to add the total field * Update the OpenApi of the tasks route * Document the latest metrics improvements (#242) * document the latest metrics improvements * Update text/0174-metrics-api.md Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Update text/0174-metrics-api.md Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * adds some details on the meilisearch_db_size metrics * update the open api metrics smaple * update a bad copy paste * Update open-api.yaml * prefix prometheus metrics by meilisearch_ * Introduce two new metrics --------- Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> Co-authored-by: Kerollmops <clement@meilisearch.com> --------- Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> Co-authored-by: Clément Renault <clement@meilisearch.com> Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> Co-authored-by: Clément Renault <renault.cle@gmail.com> Co-authored-by: Tamo <tamo@meilisearch.com>

Init spec

91f8f6e

gmourier added 🧪 Experimental The PR describes an experimental feature. In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels Jun 23, 2023

gmourier mentioned this pull request Jun 23, 2023

Release v1.3.0 #244

Merged

1 task

Kerollmops mentioned this pull request Jun 26, 2023

Experimental Feature: Vector Store meilisearch/meilisearch#3798

Closed

3 tasks

Kerollmops added 5 commits June 26, 2023 17:48

Fix the vector store fields

0745125

Add an information on the invalid_search_vector error code

8ba90f6

Add an information on the invalid_vectors_field error codes

4dc253c

Define the new max_vector_size analytic

740aa24

Update the open-api file with vector capabilities

c3d96ab

gmourier added OpenAPI Update OpenAPI specification. Telemetry Update the telemetry collect. Ready For Review Feature specification must be reviewed. and removed In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels Jun 27, 2023

gmourier requested review from brunoocasali and maryamsulemani97 and removed request for brunoocasali and maryamsulemani97 June 27, 2023 11:22

gmourier added In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. and removed Ready For Review Feature specification must be reviewed. labels Jun 27, 2023

gmourier commented Jun 27, 2023

View reviewed changes

gmourier added Ready For Review Feature specification must be reviewed. and removed In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels Jun 27, 2023

Apply suggestions from code review

d679564

gmourier added v1.3.0 Implemented Feature specification has been implemented. labels Jul 5, 2023

gmourier commented Jul 5, 2023

View reviewed changes

Comment thread text/0034-telemetry-policies.md

brunoocasali mentioned this pull request Jul 5, 2023

Changes regarding Meilisearch v1.3.0 meilisearch/integration-guides#280

Closed

gmourier requested a review from maryamsulemani97 July 7, 2023 06:26

gmourier requested review from alallema and macraig July 7, 2023 06:26

macraig reviewed Jul 7, 2023

View reviewed changes

alallema reviewed Jul 10, 2023

View reviewed changes

bidoubiwa mentioned this pull request Jul 10, 2023

Experimental vector search for MS v1.3.0 meilisearch/meilisearch-js#1535

Merged

gmourier and others added 4 commits July 13, 2023 17:39

Update open-api.yaml

78dc99c

Co-authored-by: Maria Craig <marycraig90@gmail.com>

Update open-api.yaml

c517e52

Co-authored-by: Maria Craig <marycraig90@gmail.com>

Update text/0118-search-api.md

81a0c64

Co-authored-by: Maria Craig <marycraig90@gmail.com>

Update text/0061-error-format-and-definitions.md

a5cb6b3

Co-authored-by: Maria Craig <marycraig90@gmail.com>

gmourier requested a review from Kerollmops July 13, 2023 15:49

maryamsulemani97 mentioned this pull request Jul 17, 2023

v1.3: Telemetry meilisearch/documentation#2492

Closed

bidoubiwa approved these changes Jul 18, 2023

View reviewed changes

macraig merged commit 1a3f49d into release-v1.3.0 Jul 31, 2023

macraig deleted the vector-search branch July 31, 2023 10:20


		### Context

		These errors occurs when the `_vectors` field of a document payload is not valid. Either due to the type of it or the number of dimensions.

Conversation

gmourier commented Jun 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Out Of Scope

Attention To Reviewers

Misc

Uh oh!

github-actions Bot commented Jun 27, 2023

Modified (3)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

macraig Jul 7, 2023

Choose a reason for hiding this comment

Uh oh!

alallema Jul 9, 2023

Choose a reason for hiding this comment

Uh oh!

bidoubiwa Jul 10, 2023

Choose a reason for hiding this comment

Uh oh!

gmourier Jul 13, 2023

Choose a reason for hiding this comment

Uh oh!

gmourier Jul 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alallema Jul 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alallema Jul 9, 2023

Choose a reason for hiding this comment

Uh oh!

alallema Jul 9, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bidoubiwa left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

gmourier commented Jun 23, 2023 •

edited

Loading

gmourier Jul 13, 2023 •

edited

Loading

alallema Jul 13, 2023 •

edited

Loading