mtermvectors {elastic} | R Documentation |
Multi Termvectors
Description
Multi Termvectors
Usage
mtermvectors(
conn,
index = NULL,
type = NULL,
ids = NULL,
body = list(),
pretty = TRUE,
field_statistics = TRUE,
fields = NULL,
offsets = TRUE,
parent = NULL,
payloads = TRUE,
positions = TRUE,
preference = "random",
realtime = TRUE,
routing = NULL,
term_statistics = FALSE,
version = NULL,
version_type = NULL,
...
)
Arguments
conn |
an Elasticsearch connection object, see |
index |
(character) The index in which the document resides. |
type |
(character) The type of the document. |
ids |
(character) One or more document ids |
body |
(character) Define parameters and or supply a document to get termvectors for |
pretty |
(logical) pretty print. Default: |
field_statistics |
(character) Specifies if document count, sum of
document frequencies and sum of total term frequencies should be returned.
Default: |
fields |
(character) A comma-separated list of fields to return. |
offsets |
(character) Specifies if term offsets should be returned.
Default: |
parent |
(character) Parent id of documents. |
payloads |
(character) Specifies if term payloads should be returned.
Default: |
positions |
(character) Specifies if term positions should be returned.
Default: |
preference |
(character) Specify the node or shard the operation
should be performed on (Default: |
realtime |
(character) Specifies if request is real-time as opposed to
near-real-time (Default: |
routing |
(character) Specific routing value. |
term_statistics |
(character) Specifies if total term frequency and
document frequency should be returned. Default: |
version |
(character) Explicit version number for concurrency control |
version_type |
(character) Specific version type, valid choices are: 'internal', 'external', 'external_gte', 'force' |
... |
Curl args passed on to crul::verb-POST |
Details
Multi termvectors API allows to get multiple termvectors based on an index, type and id.
References
https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
See Also
Examples
## Not run:
x <- connect()
if (index_exists(x, 'omdb')) index_delete(x, "omdb")
omdb <- system.file("examples", "omdb.json", package = "elastic")
omdb <- type_remover(omdb)
invisible(docs_bulk(x, omdb))
out <- Search(x, "omdb", size = 2)$hits$hits
ids <- vapply(out, "[[", "", "_id")
# no index
body <- '{
"docs": [
{
"_index": "omdb",
"_id": "%s",
"term_statistics": true
},
{
"_index": "omdb",
"_id": "%s",
"fields": [
"Plot"
]
}
]
}'
mtermvectors(x, body = sprintf(body, ids[1], ids[2]))
# index given
body <- '{
"docs": [
{
"_id": "%s",
"fields": [
"Plot"
],
"term_statistics": true
},
{
"_id": "%s",
"fields": [
"Title"
]
}
]
}'
mtermvectors(x, 'omdb', body = sprintf(body, ids[1], ids[2]))
# parameters same for both documents, so can simplify
body <- '{
"ids" : ["%s", "%s"],
"parameters": {
"fields": [
"Plot"
],
"term_statistics": true
}
}'
mtermvectors(x, 'omdb', body = sprintf(body, ids[1], ids[2]))
# you can give user provided documents via the 'docs' parameter
## though you have to give index and type that exist in your Elasticsearch
## instance
body <- '{
"docs": [
{
"_index": "omdb",
"doc" : {
"Director" : "John Doe",
"Plot" : "twitter test test test"
}
},
{
"_index": "omdb",
"doc" : {
"Director" : "Jane Doe",
"Plot" : "Another twitter test ..."
}
}
]
}'
mtermvectors(x, body = body)
## End(Not run)