honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-17 10:25:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] add doc for multi term vector api

Browse Source 
closes #3998
This commit is contained in:
Britta Weber 2013-11-25 19:42:55 +01:00
parent 3be5f3345e
commit dbef64009f
2 changed files with 95 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/search.asciidoc
View File

@ -100,3 +100,5 @@ include::search/percolate.asciidoc[]
include::search/more-like-this.asciidoc[]
include::search/termvectors.asciidoc[]
include::search/multi-termvectors.asciidoc[]

93
docs/reference/search/multi-termvectors.asciidoc Normal file
View File

@ -0,0 +1,93 @@
[[docs-multi-termvectors]]
== Multi termvectors API
Multi termvectors API allows to get multiple termvectors based on an index, type and id. The response includes a `docs`
array with all the fetched termvectors, each element having the structure
provided by the <<search-termvectors,termvectors>>
API. Here is an example:
[source,js]
--------------------------------------------------
curl 'localhost:9200/_mtermvectors' -d '{
{
"docs": [
{
"_index": "testidx",
"_type": "test",
"_id": "2",
"term_statistics": true
},
{
"_index": "testidx",
"_type": "test",
"_id": "1",
"fields": [
"text"
]
}
]
}'
--------------------------------------------------
See the <<search-termvectors,termvectors>> API for a description of possible parameters.
The `_mtermvectors` endpoint can also be used against an index (in which case it
is not required in the body):
[source,js]
--------------------------------------------------
curl 'localhost:9200/testidx/_mtermvectors' -d '{
"docs": [
{
"_type": "test",
"_id": "2",
"fields": [
"text"
],
"term_statistics": true
},
{
"_type": "test",
"_id": "1"
}
]
}'
--------------------------------------------------
And type:
[source,js]
--------------------------------------------------
curl 'localhost:9200/testidx/test/_mtermvectors' -d '{
"docs": [
{
"_id": "2",
"fields": [
"text"
],
"term_statistics": true
},
{
"_id": "1"
}
]
}'
--------------------------------------------------
If all requested documents are on same index and have same type and also the parameters are the same, the request can be simplified:
[source,js]
--------------------------------------------------
curl 'localhost:9200/testidx/test/_mtermvectors' -d '{
"ids" : ["1", "2"],
"parameters": {
"fields": [
"text"
],
"term_statistics": true,
…
}
}'
--------------------------------------------------
Parameters can aslo be set by passing them as uri parameters (see <<search-termvectors,termvectors>>). uri parameters are the default parameters and are overwritten by any parameter setting defined in the body.