-
Notifications
You must be signed in to change notification settings - Fork 24.6k
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 a feature_vector
field.
#31102
Merged
Merged
Add a feature_vector
field.
#31102
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
[[feature-vector]] | ||
=== Feature vector datatype | ||
|
||
A `feature_vector` field can index numeric feature vectors, so that they can | ||
later be used to boost documents in queries with a | ||
<<query-dsl-feature-query,`feature`>> query. | ||
|
||
It is analogous to the <<feature,`feature`>> datatype but is better suited | ||
when the list of features is sparse so that it wouldn't be reasonable to add | ||
one field to the mappings for each of them. | ||
|
||
[source,js] | ||
-------------------------------------------------- | ||
PUT my_index | ||
{ | ||
"mappings": { | ||
"_doc": { | ||
"properties": { | ||
"topics": { | ||
"type": "feature_vector" <1> | ||
} | ||
} | ||
} | ||
} | ||
} | ||
|
||
PUT my_index/_doc/1 | ||
{ | ||
"topics": { <2> | ||
"politics": 20, | ||
"economics": 50.8 | ||
} | ||
} | ||
|
||
PUT my_index/_doc/2 | ||
{ | ||
"topics": { | ||
"politics": 5.2, | ||
"sports": 80.1 | ||
} | ||
} | ||
|
||
GET my_index/_search | ||
{ | ||
"query": { | ||
"feature": { | ||
"field": "topics.politics" | ||
} | ||
} | ||
} | ||
-------------------------------------------------- | ||
// CONSOLE | ||
<1> Feature vector fields must use the `feature_vector` field type | ||
<2> Feature vector fields must be a hash with string keys and strictly positive numeric values | ||
|
||
NOTE: `feature_vector` fields only support single-valued features and strictly | ||
positive values. Multi-valued fields and zero or negative values will be rejected. | ||
|
||
NOTE: `feature_vector` fields do not support sorting or aggregating and may | ||
only be queried using <<query-dsl-feature-query,`feature`>> queries. | ||
|
||
NOTE: `feature_vector` fields only preserve 9 significant bits for the | ||
precision, which translates to a relative error of about 0.4%. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if at least one of the example values above should be a fractional value to make it clearer that the field type accepts float values and not just integer values? It might also be worth adding a note to this effect below?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, @gibrown had a similar comment