Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide Context in Explore Docs: Usage vs Get #918

Open
Robbie-Palmer opened this issue Jun 16, 2023 · 1 comment
Open

Provide Context in Explore Docs: Usage vs Get #918

Robbie-Palmer opened this issue Jun 16, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Robbie-Palmer
Copy link

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

@dandv dandv transferred this issue from weaviate/weaviate Jun 16, 2023
@dandv dandv added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 16, 2023
@narayanacharya6
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants