mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-13 08:25:26 +00:00
86e1655e4b
This commit adds support for version and version_type to the Term Vectors API. This could be useful in the following case whereby the user gets a document and later wants to generate its TVs. With version, this would ensure that only the TVs of that particular document are generated, and error out if the document has been updated in between. Closes #7480
103 lines
3.4 KiB
JSON
103 lines
3.4 KiB
JSON
{
|
|
"termvectors" : {
|
|
"documentation" : "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-termvectors.html",
|
|
"methods" : ["GET", "POST"],
|
|
"url" : {
|
|
"path" : "/{index}/{type}/_termvectors",
|
|
"paths" : ["/{index}/{type}/_termvectors", "/{index}/{type}/{id}/_termvectors"],
|
|
"parts" : {
|
|
"index" : {
|
|
"type" : "string",
|
|
"description" : "The index in which the document resides.",
|
|
"required" : true
|
|
},
|
|
"type" : {
|
|
"type" : "string",
|
|
"description" : "The type of the document.",
|
|
"required" : true
|
|
},
|
|
"id" : {
|
|
"type" : "string",
|
|
"description" : "The id of the document, when not specified a doc param should be supplied."
|
|
}
|
|
},
|
|
"params": {
|
|
"term_statistics" : {
|
|
"type" : "boolean",
|
|
"description" : "Specifies if total term frequency and document frequency should be returned.",
|
|
"default" : false,
|
|
"required" : false
|
|
},
|
|
"field_statistics" : {
|
|
"type" : "boolean",
|
|
"description" : "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.",
|
|
"default" : true,
|
|
"required" : false
|
|
},
|
|
"dfs" : {
|
|
"type" : "boolean",
|
|
"description" : "Specifies if distributed frequencies should be returned instead shard frequencies.",
|
|
"default" : false,
|
|
"required" : false
|
|
},
|
|
"fields" : {
|
|
"type" : "list",
|
|
"description" : "A comma-separated list of fields to return.",
|
|
"required" : false
|
|
},
|
|
"offsets" : {
|
|
"type" : "boolean",
|
|
"description" : "Specifies if term offsets should be returned.",
|
|
"default" : true,
|
|
"required" : false
|
|
},
|
|
"positions" : {
|
|
"type" : "boolean",
|
|
"description" : "Specifies if term positions should be returned.",
|
|
"default" : true,
|
|
"required" : false
|
|
},
|
|
"payloads" : {
|
|
"type" : "boolean",
|
|
"description" : "Specifies if term payloads should be returned.",
|
|
"default" : true,
|
|
"required" : false
|
|
},
|
|
"preference" : {
|
|
"type" : "string",
|
|
"description" : "Specify the node or shard the operation should be performed on (default: random).",
|
|
"required" : false
|
|
},
|
|
"routing" : {
|
|
"type" : "string",
|
|
"description" : "Specific routing value.",
|
|
"required" : false
|
|
},
|
|
"parent": {
|
|
"type" : "string",
|
|
"description" : "Parent id of documents.",
|
|
"required" : false
|
|
},
|
|
"realtime": {
|
|
"type": "boolean",
|
|
"description": "Specifies if request is real-time as opposed to near-real-time (default: true).",
|
|
"required": false
|
|
},
|
|
"version" : {
|
|
"type" : "number",
|
|
"description" : "Explicit version number for concurrency control"
|
|
},
|
|
"version_type": {
|
|
"type" : "enum",
|
|
"options" : ["internal", "external", "external_gte", "force"],
|
|
"description" : "Specific version type"
|
|
}
|
|
}
|
|
},
|
|
"body": {
|
|
"description" : "Define parameters and or supply a document to get termvectors for. See documentation.",
|
|
"required" : false
|
|
}
|
|
}
|
|
}
|