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

Add k-NN guide and samples #586

Merged
merged 1 commit into from
Jul 26, 2023
Merged

Conversation

Xtansia
Copy link
Collaborator

@Xtansia Xtansia commented Jul 26, 2023

Description

Documents how to perform approximate k-NN searches and adds complete running samples for the different k-NN queries.

Based off @dblock's work in opensearch-project/opensearch-py#449

Issues Resolved

Resolves #578
Resolves #558

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Thomas Farr <[email protected]>
- [Create a client using `ApacheHttpClient5Transport`](#create-a-client-using-apachehttpclient5transport)
- [Create a client using `RestClientTransport` (deprecated)](#create-a-client-using-restclienttransport-deprecated)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you

mainClass.set("org.opensearch.client.samples.Main")
}

tasks.named<JavaExec>("run") {
Copy link
Collaborator

@reta reta Jul 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not needed :-) Shouldn't the property be picked up if defined?


package org.opensearch.client.samples;

public class RandUtil {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably knn package is better place, I suspect we would have more samples added

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

@dblock dblock merged commit 94ef0cd into opensearch-project:main Jul 26, 2023
VachaShah pushed a commit to VachaShah/opensearch-java that referenced this pull request Sep 15, 2023
Signed-off-by: Thomas Farr <[email protected]>
Signed-off-by: Vacha Shah <[email protected]>
reta pushed a commit that referenced this pull request Sep 15, 2023
* Add k-NN guide and samples (#586)

Signed-off-by: Thomas Farr <[email protected]>
Signed-off-by: Vacha Shah <[email protected]>

* Reorganizing user guide and adding working samples (#610)

* Reorganizing user guide and moving code snippets to guides

Signed-off-by: Vacha Shah <[email protected]>

* Adding working samples for the client

Signed-off-by: Vacha Shah <[email protected]>

---------

Signed-off-by: Vacha Shah <[email protected]>

* Fixing compile errors for ApacheHttpClient5Transport

Signed-off-by: Vacha Shah <[email protected]>

---------

Signed-off-by: Thomas Farr <[email protected]>
Signed-off-by: Vacha Shah <[email protected]>
Co-authored-by: Thomas Farr <[email protected]>
@Xtansia Xtansia deleted the document/k-nn branch June 14, 2024 04:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Document A-NN [FEATURE] Update User guide for knn support (vector database)
3 participants