Skip to content

Commit

Permalink
Added the support of knn search
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick-S-2018 committed Feb 22, 2024
1 parent 269e1fd commit 5fecfdf
Show file tree
Hide file tree
Showing 19 changed files with 2,211 additions and 57 deletions.
9 changes: 9 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ docs/HighlightField.md
docs/InFilter.md
docs/IndexApi.md
docs/InsertDocumentRequest.md
docs/KnnQueryByDocId.md
docs/KnnQueryByVector.md
docs/MatchFilter.md
docs/MatchOp.md
docs/MatchOpFilter.md
Expand All @@ -36,6 +38,7 @@ docs/QueryFilter.md
docs/RangeFilter.md
docs/SearchApi.md
docs/SearchRequest.md
docs/SearchRequestKnn.md
docs/SearchResponse.md
docs/SearchResponseHits.md
docs/SortMVA.md
Expand Down Expand Up @@ -73,6 +76,8 @@ src/model/Highlight.js
src/model/HighlightField.js
src/model/InFilter.js
src/model/InsertDocumentRequest.js
src/model/KnnQueryByDocId.js
src/model/KnnQueryByVector.js
src/model/MatchFilter.js
src/model/MatchOp.js
src/model/MatchOpFilter.js
Expand All @@ -85,6 +90,7 @@ src/model/PercolateRequestQuery.js
src/model/QueryFilter.js
src/model/RangeFilter.js
src/model/SearchRequest.js
src/model/SearchRequestKnn.js
src/model/SearchResponse.js
src/model/SearchResponseHits.js
src/model/SortMVA.js
Expand Down Expand Up @@ -116,6 +122,8 @@ test/model/Highlight.spec.js
test/model/HighlightField.spec.js
test/model/InFilter.spec.js
test/model/InsertDocumentRequest.spec.js
test/model/KnnQueryByDocId.spec.js
test/model/KnnQueryByVector.spec.js
test/model/MatchFilter.spec.js
test/model/MatchOp.spec.js
test/model/MatchOpFilter.spec.js
Expand All @@ -128,6 +136,7 @@ test/model/PercolateRequestQuery.spec.js
test/model/QueryFilter.spec.js
test/model/RangeFilter.spec.js
test/model/SearchRequest.spec.js
test/model/SearchRequestKnn.spec.js
test/model/SearchResponse.spec.js
test/model/SearchResponseHits.spec.js
test/model/SortMVA.spec.js
Expand Down
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,12 @@

Сlient for Manticore Search.

❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-javascript/tree/4.0.0


## Requirements

Minimum Manticore Search version is 2.5.1 with HTTP protocol enabled.

| Manticore Search | manticoresearch-javascript | Node |
| ----------------- | ---------------------------- | ------------- |
| >= 6.2.0 | 4.0.0 | >= 10.0 |
| >= 6.2.0 | 3.3.1 | >= 10.0 |
| >= 4.2.1 | 3.0.x | >= 10.0 |
| >= 4.0.2 | 2.0.3 | >= 10.0 |
| >= 2.5.1 | 2.0.2 | >= 8.0 |


## Installation
Expand Down Expand Up @@ -108,6 +101,8 @@ Class | Method | HTTP request | Description
- [Manticoresearch.HighlightField](docs/HighlightField.md)
- [Manticoresearch.InFilter](docs/InFilter.md)
- [Manticoresearch.InsertDocumentRequest](docs/InsertDocumentRequest.md)
- [Manticoresearch.KnnQueryByDocId](docs/KnnQueryByDocId.md)
- [Manticoresearch.KnnQueryByVector](docs/KnnQueryByVector.md)
- [Manticoresearch.MatchFilter](docs/MatchFilter.md)
- [Manticoresearch.MatchOp](docs/MatchOp.md)
- [Manticoresearch.MatchOpFilter](docs/MatchOpFilter.md)
Expand All @@ -120,6 +115,7 @@ Class | Method | HTTP request | Description
- [Manticoresearch.QueryFilter](docs/QueryFilter.md)
- [Manticoresearch.RangeFilter](docs/RangeFilter.md)
- [Manticoresearch.SearchRequest](docs/SearchRequest.md)
- [Manticoresearch.SearchRequestKnn](docs/SearchRequestKnn.md)
- [Manticoresearch.SearchResponse](docs/SearchResponse.md)
- [Manticoresearch.SearchResponseHits](docs/SearchResponseHits.md)
- [Manticoresearch.SortMVA](docs/SortMVA.md)
Expand Down
14 changes: 14 additions & 0 deletions docs/KnnQueryByDocId.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Manticoresearch.KnnQueryByDocId

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**field** | **String** | | [default to '']
**docId** | **Number** | |
**k** | **Number** | |
**filter** | **Object** | |




14 changes: 14 additions & 0 deletions docs/KnnQueryByVector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Manticoresearch.KnnQueryByVector

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**field** | **String** | | [default to '']
**queryVector** | **[Number]** | |
**k** | **Number** | |
**filter** | **Object** | | [optional]




4 changes: 4 additions & 0 deletions docs/SearchRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**index** | **String** | | [default to '']
**knn** | [**SearchRequestKnn**](SearchRequestKnn.md) | | [optional]
**query** | **Object** | | [optional]
**fulltextFilter** | **Object** | | [optional]
**attrFilter** | **Object** | | [optional]
Expand All @@ -19,6 +20,9 @@ Name | Type | Description | Notes
**options** | **{String: Object}** | | [optional]
**profile** | **Boolean** | | [optional]
**trackScores** | **Boolean** | | [optional]
**queryVector** | **Object** | | [optional]
**docId** | **Object** | | [optional]
**k** | **Object** | | [optional]


## Building a search request
Expand Down
15 changes: 15 additions & 0 deletions docs/SearchRequestKnn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Manticoresearch.SearchRequestKnn

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**field** | **String** | | [default to '']
**queryVector** | **[Number]** | |
**k** | **Number** | |
**filter** | **Object** | |
**docId** | **Number** | |




Loading

0 comments on commit 5fecfdf

Please sign in to comment.