weaviate-io icon indicating copy to clipboard operation
weaviate-io copied to clipboard

Provide Context in Explore Docs: Usage vs Get

Open Robbie-Palmer opened this issue 2 years ago • 2 comments

The documentation on the Explore GraphQL Endpoint describes functionality similar to using Get with the nearText and nearVector functions Except it lacks features such as getting associated fields, nearImage, hybrid etc And it has additional features such as moveTo and MoveAwayFrom

It would be great if the documentation for this page started with more context about how it differs from Get What are the reasons it lacks some features such as nearImage and hybrid What are the reasons it has the features moveTo and MoveAwayFrom when Get does not And some examples of when one should be used vs the other or how they complement each other

Robbie-Palmer avatar Jun 16 '23 14:06 Robbie-Palmer

If the docs can state explicitly that you need the class to mention the vectorizer for the nearText to work because Explore is solely based on vectors and does not consider text search (based on this SO comment), that would be great.

Some documentation on how things work under the hood with moveTo and moveAwayFrom would also be really helpful.

narayanacharya6 avatar Jul 12 '23 20:07 narayanacharya6

@narayanacharya6, the quickstart guide now specifies that a vectorizer is needed.

network-charles avatar Sep 17 '24 22:09 network-charles