Can't find documentation for the search via rest

Support
1

Description

I’m very lost in the rest API documentation. The AI Assistant told me i can use the rest api to search using this GET /v1/objects?class=JeopardyQuestion&nearText={"concepts":["animals in movies"]}&limit=2. It does work. The assistant cites this article Vector similarity search. But there seem to be only examples for graphql and no mention of rest.

I also can’t find anything in the description of this rest-site rest. It clearly works, but i can’t any documentation for it. I used google and the search on the page.

I’m new to weaviate and try to play a bit with it to evaluate it.
Can anyone point me to the correct page on how to use nearText search?
The example from the AI works, but i need documentation for this feature to be able to implement it at work.

Server Setup Information

  • Weaviate Server Version: weaviate:1.28.2
  • Deployment Method: docker
  • Multi Node? Number of Running Nodes: single node
  • Client Language and Version: ?
  • Multitenancy?: no

Any additional Information

2

hi @FullyLost !!

Welcome to our community :hugs:

In order to perform a bm25, or vector or hybrid search using rest, you need to send in a graphql query, as per this api reference:

Now, for each of the features, you will see tabs showing to use that feature using different clients. You can also find a tab for graphql, like in here:

Here is an example:

curl --request POST \
  --url http://localhost:8080/v1/graphql \
  --header 'Content-Type: application/json' \
  --data '{"query":"{Get{Test(nearText:{concepts:[\"dogs\"]}){text}}}"}'

One nice trick is to use a tool like insomnia, and use it to autocomplete while creating the graphql query:

image
image1406×952 43.6 KB

Then you can just generate a “curl command”

Let me know if that helps!