status: available in v1.10.0-RC.0 after https://github.com/meilisearch/meilisearch/pull/4815
rationale: the current parameters of the REST API are too numerous and confusing
Proposal:
query
, inputField
, inputType
, pathToEmbeddings
and embeddingObject
request
and response
Parameters explanation
request
: A JSON value that represents the request made by Meilisearch to the remote embedder. The text to embed must be replaced by the placeholder value “{{text}}”
.response
: A JSON value that represents a fragment of the response made by the remote embedder to Meilisearch. The embedding must be replaced by the placeholder value "{{embedding}}"
.Passing multiple texts and receiving multiple embeddings
"{{text}}"
placeholder value inside a JSON value that is the first item of an array in the request, and pass “{{..}}”
as the second item of the array."{{embedding}}"
placeholder value inside a JSON value that is the first item of an array in the response, and pass "{{..}}"
as the second item of the array.Error cases