diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index b9474204bb..555e299981 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9090,46 +9090,46 @@ "/_inference/{inference_id}": { "get": { "tags": [ - "inference.get_model" + "inference.get" ], - "summary": "Get a model in the Inference API", - "description": "Get a model in the Inference API", + "summary": "Get an inference endpoint", + "description": "Get an inference endpoint", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" }, - "operationId": "inference-get-model-1", + "operationId": "inference-get-1", "parameters": [ { - "$ref": "#/components/parameters/inference.get_model#inference_id" + "$ref": "#/components/parameters/inference.get#inference_id" } ], "responses": { "200": { - "$ref": "#/components/responses/inference.get_model#200" + "$ref": "#/components/responses/inference.get#200" } } }, "put": { "tags": [ - "inference.put_model" + "inference.put" ], - "summary": "Configure a model for use in the Inference API", - "description": "Configure a model for use in the Inference API", + "summary": "Configure an inference endpoint for use in the Inference API", + "description": "Configure an inference endpoint for use in the Inference API", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html" }, - "operationId": "inference-put-model", + "operationId": "inference-put", "parameters": [ { - "$ref": "#/components/parameters/inference.put_model#inference_id" + "$ref": "#/components/parameters/inference.put#inference_id" } ], "requestBody": { - "$ref": "#/components/requestBodies/inference.put_model" + "$ref": "#/components/requestBodies/inference.put" }, "responses": { "200": { - "$ref": "#/components/responses/inference.put_model#200" + "$ref": "#/components/responses/inference.put#200" } } }, @@ -9137,8 +9137,8 @@ "tags": [ "inference.inference" ], - "summary": "Perform inference on a model", - "description": "Perform inference on a model", + "summary": "Perform inference", + "description": "Perform inference", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html" }, @@ -9162,22 +9162,22 @@ }, "delete": { "tags": [ - "inference.delete_model" + "inference.delete" ], - "summary": "Delete model in the Inference API", - "description": "Delete model in the Inference API", + "summary": "Delete an inference endpoint", + "description": "Delete an inference endpoint", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html" }, - "operationId": "inference-delete-model", + "operationId": "inference-delete", "parameters": [ { - "$ref": "#/components/parameters/inference.delete_model#inference_id" + "$ref": "#/components/parameters/inference.delete#inference_id" } ], "responses": { "200": { - "$ref": "#/components/responses/inference.delete_model#200" + "$ref": "#/components/responses/inference.delete#200" } } } @@ -9185,52 +9185,52 @@ "/_inference/{task_type}/{inference_id}": { "get": { "tags": [ - "inference.get_model" + "inference.get" ], - "summary": "Get a model in the Inference API", - "description": "Get a model in the Inference API", + "summary": "Get an inference endpoint", + "description": "Get an inference endpoint", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" }, - "operationId": "inference-get-model-2", + "operationId": "inference-get-2", "parameters": [ { - "$ref": "#/components/parameters/inference.get_model#task_type" + "$ref": "#/components/parameters/inference.get#task_type" }, { - "$ref": "#/components/parameters/inference.get_model#inference_id" + "$ref": "#/components/parameters/inference.get#inference_id" } ], "responses": { "200": { - "$ref": "#/components/responses/inference.get_model#200" + "$ref": "#/components/responses/inference.get#200" } } }, "put": { "tags": [ - "inference.put_model" + "inference.put" ], - "summary": "Configure a model for use in the Inference API", - "description": "Configure a model for use in the Inference API", + "summary": "Configure an inference endpoint for use in the Inference API", + "description": "Configure an inference endpoint for use in the Inference API", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html" }, - "operationId": "inference-put-model-1", + "operationId": "inference-put-1", "parameters": [ { - "$ref": "#/components/parameters/inference.put_model#task_type" + "$ref": "#/components/parameters/inference.put#task_type" }, { - "$ref": "#/components/parameters/inference.put_model#inference_id" + "$ref": "#/components/parameters/inference.put#inference_id" } ], "requestBody": { - "$ref": "#/components/requestBodies/inference.put_model" + "$ref": "#/components/requestBodies/inference.put" }, "responses": { "200": { - "$ref": "#/components/responses/inference.put_model#200" + "$ref": "#/components/responses/inference.put#200" } } }, @@ -9238,8 +9238,8 @@ "tags": [ "inference.inference" ], - "summary": "Perform inference on a model", - "description": "Perform inference on a model", + "summary": "Perform inference", + "description": "Perform inference", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html" }, @@ -9266,25 +9266,25 @@ }, "delete": { "tags": [ - "inference.delete_model" + "inference.delete" ], - "summary": "Delete model in the Inference API", - "description": "Delete model in the Inference API", + "summary": "Delete an inference endpoint", + "description": "Delete an inference endpoint", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html" }, - "operationId": "inference-delete-model-1", + "operationId": "inference-delete-1", "parameters": [ { - "$ref": "#/components/parameters/inference.delete_model#task_type" + "$ref": "#/components/parameters/inference.delete#task_type" }, { - "$ref": "#/components/parameters/inference.delete_model#inference_id" + "$ref": "#/components/parameters/inference.delete#inference_id" } ], "responses": { "200": { - "$ref": "#/components/responses/inference.delete_model#200" + "$ref": "#/components/responses/inference.delete#200" } } } @@ -9292,17 +9292,17 @@ "/_inference": { "get": { "tags": [ - "inference.get_model" + "inference.get" ], - "summary": "Get a model in the Inference API", - "description": "Get a model in the Inference API", + "summary": "Get an inference endpoint", + "description": "Get an inference endpoint", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" }, - "operationId": "inference-get-model", + "operationId": "inference-get", "responses": { "200": { - "$ref": "#/components/responses/inference.get_model#200" + "$ref": "#/components/responses/inference.get#200" } } } @@ -21105,7 +21105,7 @@ } } }, - "inference.delete_model#200": { + "inference.delete#200": { "description": "", "content": { "application/json": { @@ -21115,22 +21115,22 @@ } } }, - "inference.get_model#200": { + "inference.get#200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { - "models": { + "endpoints": { "type": "array", "items": { - "$ref": "#/components/schemas/inference._types:ModelConfigContainer" + "$ref": "#/components/schemas/inference._types:InferenceEndpointContainer" } } }, "required": [ - "models" + "endpoints" ] } } @@ -21146,12 +21146,12 @@ } } }, - "inference.put_model#200": { + "inference.put#200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/inference._types:ModelConfigContainer" + "$ref": "#/components/schemas/inference._types:InferenceEndpointContainer" } } } @@ -24957,7 +24957,7 @@ }, "style": "form" }, - "inference.delete_model#task_type": { + "inference.delete#task_type": { "in": "path", "name": "task_type", "description": "The task type", @@ -24968,7 +24968,7 @@ }, "style": "simple" }, - "inference.delete_model#inference_id": { + "inference.delete#inference_id": { "in": "path", "name": "inference_id", "description": "The inference Id", @@ -24979,7 +24979,7 @@ }, "style": "simple" }, - "inference.get_model#task_type": { + "inference.get#task_type": { "in": "path", "name": "task_type", "description": "The task type", @@ -24990,7 +24990,7 @@ }, "style": "simple" }, - "inference.get_model#inference_id": { + "inference.get#inference_id": { "in": "path", "name": "inference_id", "description": "The inference Id", @@ -25033,7 +25033,7 @@ }, "style": "form" }, - "inference.put_model#task_type": { + "inference.put#task_type": { "in": "path", "name": "task_type", "description": "The task type", @@ -25044,7 +25044,7 @@ }, "style": "simple" }, - "inference.put_model#inference_id": { + "inference.put#inference_id": { "in": "path", "name": "inference_id", "description": "The inference Id", @@ -28039,7 +28039,7 @@ "type": "string" }, "input": { - "description": "Text input to the model.\nEither a string or an array of strings.", + "description": "Inference input.\nEither a string or an array of strings.", "oneOf": [ { "type": "string" @@ -28063,11 +28063,11 @@ } } }, - "inference.put_model": { + "inference.put": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/inference._types:ModelConfig" + "$ref": "#/components/schemas/inference._types:InferenceEndpoint" } } }, @@ -52291,16 +52291,16 @@ "completion" ] }, - "inference._types:ModelConfigContainer": { + "inference._types:InferenceEndpointContainer": { "allOf": [ { - "$ref": "#/components/schemas/inference._types:ModelConfig" + "$ref": "#/components/schemas/inference._types:InferenceEndpoint" }, { "type": "object", "properties": { - "model_id": { - "description": "The model Id", + "inference_id": { + "description": "The inference Id", "type": "string" }, "task_type": { @@ -52308,13 +52308,13 @@ } }, "required": [ - "model_id", + "inference_id", "task_type" ] } ] }, - "inference._types:ModelConfig": { + "inference._types:InferenceEndpoint": { "type": "object", "properties": { "service": { diff --git a/output/schema/schema.json b/output/schema/schema.json index de5b24f1a5..6cf9c737e4 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -8595,17 +8595,17 @@ "visibility": "public" } }, - "description": "Delete model in the Inference API", + "description": "Delete an inference endpoint", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", - "name": "inference.delete_model", + "name": "inference.delete", "request": { "name": "Request", - "namespace": "inference.delete_model" + "namespace": "inference.delete" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "inference.delete_model" + "namespace": "inference.delete" }, "responseMediaType": [ "application/json" @@ -8640,17 +8640,17 @@ "visibility": "public" } }, - "description": "Get a model in the Inference API", + "description": "Get an inference endpoint", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", - "name": "inference.get_model", + "name": "inference.get", "request": { "name": "Request", - "namespace": "inference.get_model" + "namespace": "inference.get" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "inference.get_model" + "namespace": "inference.get" }, "responseMediaType": [ "application/json" @@ -8691,7 +8691,7 @@ "visibility": "public" } }, - "description": "Perform inference on a model", + "description": "Perform inference", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", "name": "inference.inference", "request": { @@ -8739,12 +8739,12 @@ "visibility": "public" } }, - "description": "Configure a model for use in the Inference API", + "description": "Configure an inference endpoint for use in the Inference API", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", - "name": "inference.put_model", + "name": "inference.put", "request": { "name": "Request", - "namespace": "inference.put_model" + "namespace": "inference.put" }, "requestBodyRequired": true, "requestMediaType": [ @@ -8752,7 +8752,7 @@ ], "response": { "name": "Response", - "namespace": "inference.put_model" + "namespace": "inference.put" }, "responseMediaType": [ "application/json" @@ -134149,6 +134149,94 @@ } } }, + { + "description": "Configuration options when storing the inference endpoint", + "kind": "interface", + "name": { + "name": "InferenceEndpoint", + "namespace": "inference._types" + }, + "properties": [ + { + "description": "The service type", + "name": "service", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Settings specific to the service", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ServiceSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "Task settings specific to the service and task type", + "name": "task_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskSettings", + "namespace": "inference._types" + } + } + } + ], + "specLocation": "inference/_types/Services.ts#L23-L39" + }, + { + "description": "Represents a infenence endpoint as returned by the GET API", + "inherits": { + "type": { + "name": "InferenceEndpoint", + "namespace": "inference._types" + } + }, + "kind": "interface", + "name": { + "name": "InferenceEndpointContainer", + "namespace": "inference._types" + }, + "properties": [ + { + "description": "The inference Id", + "name": "inference_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The task type", + "name": "task_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskType", + "namespace": "inference._types" + } + } + } + ], + "specLocation": "inference/_types/Services.ts#L41-L53" + }, { "description": "InferenceResult is an aggregation of mutually exclusive variants", "kind": "interface", @@ -134233,94 +134321,6 @@ "kind": "container" } }, - { - "description": "Configuration options when storing the model config", - "kind": "interface", - "name": { - "name": "ModelConfig", - "namespace": "inference._types" - }, - "properties": [ - { - "description": "The service type", - "name": "service", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Settings specific to the service", - "name": "service_settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ServiceSettings", - "namespace": "inference._types" - } - } - }, - { - "description": "Task settings specific to the service and model", - "name": "task_settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskSettings", - "namespace": "inference._types" - } - } - } - ], - "specLocation": "inference/_types/Services.ts#L23-L39" - }, - { - "description": "Represents a model as returned by the GET API", - "inherits": { - "type": { - "name": "ModelConfig", - "namespace": "inference._types" - } - }, - "kind": "interface", - "name": { - "name": "ModelConfigContainer", - "namespace": "inference._types" - }, - "properties": [ - { - "description": "The model Id", - "name": "model_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The model's task type", - "name": "task_type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskType", - "namespace": "inference._types" - } - } - } - ], - "specLocation": "inference/_types/Services.ts#L41-L53" - }, { "description": "The rerank result object representing a single ranked document\nid: the original index of the document in the request\nscore: the score of the document relative to the query\ntext: Optional, the text of the document, if requested", "kind": "interface", @@ -134508,7 +134508,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an inference service model", + "description": "Delete an inference endpoint", "inherits": { "type": { "name": "RequestBase", @@ -134518,7 +134518,7 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.delete_model" + "namespace": "inference.delete" }, "path": [ { @@ -134547,7 +134547,7 @@ } ], "query": [], - "specLocation": "inference/delete_model/DeleteModelRequest.ts#L24-L41" + "specLocation": "inference/delete/DeleteRequest.ts#L24-L41" }, { "body": { @@ -134563,9 +134563,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "inference.delete_model" + "namespace": "inference.delete" }, - "specLocation": "inference/delete_model/DeleteModelResponse.ts#L22-L24" + "specLocation": "inference/delete/DeleteResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -134574,7 +134574,7 @@ "body": { "kind": "no_body" }, - "description": "Get an inference service model", + "description": "Get an inference endpoint", "inherits": { "type": { "name": "RequestBase", @@ -134584,7 +134584,7 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.get_model" + "namespace": "inference.get" }, "path": [ { @@ -134613,21 +134613,24 @@ } ], "query": [], - "specLocation": "inference/get_model/GetModelRequest.ts#L24-L41" + "specLocation": "inference/get/GetRequest.ts#L24-L41" }, { "body": { "kind": "properties", "properties": [ { - "name": "models", + "aliases": [ + "models" + ], + "name": "endpoints", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ModelConfigContainer", + "name": "InferenceEndpointContainer", "namespace": "inference._types" } } @@ -134638,9 +134641,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "inference.get_model" + "namespace": "inference.get" }, - "specLocation": "inference/get_model/GetModelResponse.ts#L22-L26" + "specLocation": "inference/get/GetResponse.ts#L22-L27" }, { "attachedBehaviors": [ @@ -134662,7 +134665,7 @@ } }, { - "description": "Text input to the model.\nEither a string or an array of strings.", + "description": "Inference input.\nEither a string or an array of strings.", "name": "input", "required": true, "type": { @@ -134780,17 +134783,17 @@ "CommonQueryParameters" ], "body": { - "codegenName": "model_config", + "codegenName": "inference_config", "kind": "value", "value": { "kind": "instance_of", "type": { - "name": "ModelConfig", + "name": "InferenceEndpoint", "namespace": "inference._types" } } }, - "description": "Create an inference service model", + "description": "Create an inference endpoint", "inherits": { "type": { "name": "RequestBase", @@ -134800,7 +134803,7 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.put_model" + "namespace": "inference.put" }, "path": [ { @@ -134829,7 +134832,7 @@ } ], "query": [], - "specLocation": "inference/put_model/PutModelRequest.ts#L25-L44" + "specLocation": "inference/put/PutRequest.ts#L25-L44" }, { "body": { @@ -134837,7 +134840,7 @@ "value": { "kind": "instance_of", "type": { - "name": "ModelConfigContainer", + "name": "InferenceEndpointContainer", "namespace": "inference._types" } } @@ -134845,9 +134848,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "inference.put_model" + "namespace": "inference.put" }, - "specLocation": "inference/put_model/PutModelResponse.ts#L22-L24" + "specLocation": "inference/put/PutResponse.ts#L22-L24" }, { "inherits": { diff --git a/output/schema/schema/schema.json b/output/schema/schema/schema.json index 2de061d97b..b2ad8759b3 100644 --- a/output/schema/schema/schema.json +++ b/output/schema/schema/schema.json @@ -3073,6 +3073,750 @@ ], "visibility": "public" }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the last_seen timestamp in the connector document.", + "docId": "connector-checkin", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html", + "name": "connector.check_in", + "request": { + "name": "Request", + "namespace": "connector.check_in" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "connector.check_in" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_check_in" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Deletes a connector.", + "docId": "connector-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html", + "name": "connector.delete", + "request": { + "name": "Request", + "namespace": "connector.delete" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "connector.delete" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "DELETE" + ], + "path": "/_connector/{connector_id}" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Returns the details about a connector.", + "docId": "connector-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html", + "name": "connector.get", + "request": { + "name": "Request", + "namespace": "connector.get" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "connector.get" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_connector/{connector_id}" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the stats of last sync in the connector document.", + "docId": "connector-last-sync", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html", + "name": "connector.last_sync", + "request": { + "name": "Request", + "namespace": "connector.last_sync" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.last_sync" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_last_sync" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Lists all connectors.", + "docId": "connector-list", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html", + "name": "connector.list", + "request": { + "name": "Request", + "namespace": "connector.list" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "connector.list" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_connector" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Creates a connector.", + "docId": "connector-post", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", + "name": "connector.post", + "request": { + "name": "Request", + "namespace": "connector.post" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.post" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_connector" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Creates or updates a connector.", + "docId": "connector-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", + "name": "connector.put", + "request": { + "name": "Request", + "namespace": "connector.put" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.put" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the API key id and/or API key secret id fields in the connector document.", + "docId": "connector-update-api-key-id", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-api-key-id-api.html", + "name": "connector.update_api_key_id", + "request": { + "name": "Request", + "namespace": "connector.update_api_key_id" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_api_key_id" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_api_key_id" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the connector configuration.", + "docId": "connector-configuration", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-configuration-api.html", + "name": "connector.update_configuration", + "request": { + "name": "Request", + "namespace": "connector.update_configuration" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_configuration" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_configuration" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the error field in the connector document.", + "docId": "connector-update-error", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-error-api.html", + "name": "connector.update_error", + "request": { + "name": "Request", + "namespace": "connector.update_error" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_error" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_error" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the filtering field in the connector document.", + "docId": "connector-update-filtering", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", + "name": "connector.update_filtering", + "request": { + "name": "Request", + "namespace": "connector.update_filtering" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_filtering" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_filtering" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the index name of the connector.", + "docId": "connector-update-index-name", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-index-name-api.html", + "name": "connector.update_index_name", + "request": { + "name": "Request", + "namespace": "connector.update_index_name" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_index_name" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_index_name" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the name and/or description fields in the connector document.", + "docId": "connector-update-name", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-name-description-api.html", + "name": "connector.update_name", + "request": { + "name": "Request", + "namespace": "connector.update_name" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_name" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_name" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the is_native flag of the connector.", + "docId": "connector-update-native", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-native-api.html", + "name": "connector.update_native", + "request": { + "name": "Request", + "namespace": "connector.update_native" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_native" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_native" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the pipeline field in the connector document.", + "docId": "connector-update-pipeline", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-pipeline-api.html", + "name": "connector.update_pipeline", + "request": { + "name": "Request", + "namespace": "connector.update_pipeline" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_pipeline" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_pipeline" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the scheduling field in the connector document.", + "docId": "connector-update-scheduling", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-scheduling-api.html", + "name": "connector.update_scheduling", + "request": { + "name": "Request", + "namespace": "connector.update_scheduling" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_scheduling" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_scheduling" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the service type of the connector.", + "docId": "connector-update-service-type", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-service-type-api.html", + "name": "connector.update_service_type", + "request": { + "name": "Request", + "namespace": "connector.update_service_type" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_service_type" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_service_type" + } + ], + "visibility": "public" + }, + { + "availability": { + "serverless": { + "stability": "experimental", + "visibility": "public" + }, + "stack": { + "since": "8.12.0", + "stability": "experimental" + } + }, + "description": "Updates the status of the connector.", + "docId": "connector-update-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-status-api.html", + "name": "connector.update_status", + "request": { + "name": "Request", + "namespace": "connector.update_status" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "connector.update_status" + }, + "responseMediaType": [ + "application/json" + ], + "since": "8.12.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_status" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -7632,6 +8376,12 @@ "since": "8.11.0", "stability": "experimental", "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_inference" + }, { "methods": [ "GET" @@ -23545,6 +24295,26 @@ } ], "query": [ + { + "availability": { + "stack": { + "featureFlag": "es.index_mode_feature_flag_registered", + "since": "8.4.0", + "visibility": "feature_flag" + } + }, + "description": "Should this request force synthetic _source?\nUse this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.\nFetches with this enabled will be slower the enabling synthetic source natively in the index.", + "name": "force_synthetic_source", + "required": false, + "since": "8.4.0", + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "description": "Specifies the node or shard the operation should be performed on. Random by default.", "name": "preference", @@ -23672,7 +24442,7 @@ } } ], - "specLocation": "_global/get/GetRequest.ts#L31-L91" + "specLocation": "_global/get/GetRequest.ts#L31-L98" }, { "body": { @@ -26436,6 +27206,26 @@ } ], "query": [ + { + "availability": { + "stack": { + "featureFlag": "es.index_mode_feature_flag_registered", + "since": "8.4.0", + "visibility": "feature_flag" + } + }, + "description": "Should this request force synthetic _source?\nUse this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.\nFetches with this enabled will be slower the enabling synthetic source natively in the index.", + "name": "force_synthetic_source", + "required": false, + "since": "8.4.0", + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "description": "Specifies the node or shard the operation should be performed on. Random by default.", "name": "preference", @@ -26542,7 +27332,7 @@ } } ], - "specLocation": "_global/mget/MultiGetRequest.ts#L25-L91" + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L98" }, { "body": { @@ -26672,7 +27462,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L214-L217" + "specLocation": "_global/msearch/types.ts#L213-L216" }, { "generics": [ @@ -26722,7 +27512,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L204-L207" + "specLocation": "_global/msearch/types.ts#L203-L206" }, { "kind": "interface", @@ -26854,7 +27644,7 @@ { "kind": "instance_of", "type": { - "name": "KnnQuery", + "name": "KnnSearch", "namespace": "_types" } }, @@ -26863,7 +27653,7 @@ "value": { "kind": "instance_of", "type": { - "name": "KnnQuery", + "name": "KnnSearch", "namespace": "_types" } } @@ -27195,7 +27985,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L71-L202" + "specLocation": "_global/msearch/types.ts#L70-L201" }, { "description": "Contains parameters used to limit or change the subsequent search body request.", @@ -27327,7 +28117,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L53-L68" + "specLocation": "_global/msearch/types.ts#L52-L67" }, { "attachedBehaviors": [ @@ -27538,7 +28328,7 @@ "name": "RequestItem", "namespace": "_global.msearch" }, - "specLocation": "_global/msearch/types.ts#L48-L51", + "specLocation": "_global/msearch/types.ts#L47-L50", "type": { "items": [ { @@ -27608,7 +28398,7 @@ "name": "ResponseItem", "namespace": "_global.msearch" }, - "specLocation": "_global/msearch/types.ts#L209-L212", + "specLocation": "_global/msearch/types.ts#L208-L211", "type": { "items": [ { @@ -31159,7 +31949,7 @@ { "kind": "instance_of", "type": { - "name": "KnnQuery", + "name": "KnnSearch", "namespace": "_types" } }, @@ -31168,7 +31958,7 @@ "value": { "kind": "instance_of", "type": { - "name": "KnnQuery", + "name": "KnnSearch", "namespace": "_types" } } @@ -32088,9 +32878,29 @@ ], "kind": "union_of" } + }, + { + "availability": { + "stack": { + "featureFlag": "es.index_mode_feature_flag_registered", + "since": "8.4.0", + "visibility": "feature_flag" + } + }, + "description": "Should this request force synthetic _source?\nUse this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.\nFetches with this enabled will be slower the enabling synthetic source natively in the index.", + "name": "force_synthetic_source", + "required": false, + "since": "8.4.0", + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "_global/search/SearchRequest.ts#L53-L506" + "specLocation": "_global/search/SearchRequest.ts#L53-L513" }, { "body": { @@ -35082,6 +35892,47 @@ ], "specLocation": "_global/search/_types/suggester.ts#L427-L432" }, + { + "kind": "interface", + "name": { + "name": "LearningToRank", + "namespace": "_global.search._types" + }, + "properties": [ + { + "description": "The unique identifier of the trained model uploaded to Elasticsearch", + "name": "model_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Named parameters to be passed to the query templates used for feature", + "name": "params", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ], + "specLocation": "_global/search/_types/rescoring.ts#L88-L97" + }, { "kind": "interface", "name": { @@ -35960,9 +36811,21 @@ "namespace": "_global.search._types" }, "properties": [ + { + "containerProperty": true, + "name": "window_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { "name": "query", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -35972,18 +36835,22 @@ } }, { - "name": "window_size", + "name": "learning_to_rank", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "LearningToRank", + "namespace": "_global.search._types" } } } ], - "specLocation": "_global/search/_types/rescoring.ts#L23-L26" + "specLocation": "_global/search/_types/rescoring.ts#L25-L38", + "variants": { + "kind": "container", + "nonExhaustive": true + } }, { "kind": "interface", @@ -36045,7 +36912,7 @@ } } ], - "specLocation": "_global/search/_types/rescoring.ts#L28-L50" + "specLocation": "_global/search/_types/rescoring.ts#L40-L62" }, { "kind": "enum", @@ -36075,7 +36942,7 @@ "name": "ScoreMode", "namespace": "_global.search._types" }, - "specLocation": "_global/search/_types/rescoring.ts#L52-L74" + "specLocation": "_global/search/_types/rescoring.ts#L64-L86" }, { "kind": "interface", @@ -40306,6 +41173,22 @@ ], "specLocation": "_spec_utils/BaseNode.ts#L25-L32" }, + { + "description": "A `null` value that is to be interpreted as an actual value, unless other uses of `null` that are equivalent\nto a missing value. It is used for exemple in settings, where using the `NullValue` for a setting will reset\nit to its default value.", + "kind": "type_alias", + "name": { + "name": "NullValue", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/utils.ts#L22-L27", + "type": { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + }, { "description": "A set of flags that can be represented as a single enum value or a set of values that are encoded\nas a pipe-separated string\n\nDepending on the target language, code generators can use this hint to generate language specific\nflags enum constructs and the corresponding (de-)serialization code.", "generics": [ @@ -40390,6 +41273,40 @@ } } }, + { + "description": "`WithNullValue` allows for explicit null assignments in contexts where `null` should be interpreted as an\nactual value.", + "generics": [ + { + "name": "T", + "namespace": "_spec_utils" + } + ], + "kind": "type_alias", + "name": { + "name": "WithNullValue", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/utils.ts#L29-L33", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_spec_utils" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NullValue", + "namespace": "_spec_utils" + } + } + ], + "kind": "union_of" + } + }, { "kind": "interface", "name": { @@ -43619,11 +44536,114 @@ } }, { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { "name": "KnnQuery", "namespace": "_types" }, + "properties": [ + { + "description": "The name of the vector field to search against", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "The query vector", + "name": "query_vector", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryVector", + "namespace": "_types" + } + } + }, + { + "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", + "name": "query_vector_builder", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryVectorBuilder", + "namespace": "_types" + } + } + }, + { + "description": "The number of nearest neighbor candidates to consider per shard", + "name": "num_candidates", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Filters for the kNN search query", + "name": "filter", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The minimum similarity for a vector to be considered a match", + "name": "similarity", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/Knn.ts#L54-L67" + }, + { + "kind": "interface", + "name": { + "name": "KnnSearch", + "namespace": "_types" + }, "properties": [ { "description": "The name of the vector field to search against", @@ -43664,7 +44684,7 @@ { "description": "The final number of nearest neighbors to return as top hits", "name": "k", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -43676,7 +44696,7 @@ { "description": "The number of nearest neighbor candidates to consider per shard", "name": "num_candidates", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -43751,7 +44771,7 @@ } } ], - "specLocation": "_types/Knn.ts#L27-L49" + "specLocation": "_types/Knn.ts#L30-L52" }, { "kind": "interface", @@ -44965,7 +45985,7 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -44977,7 +45997,7 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -44989,7 +46009,7 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -45001,7 +46021,7 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -45037,7 +46057,7 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -45049,7 +46069,7 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -45094,7 +46114,7 @@ } } ], - "specLocation": "_types/Knn.ts#L51-L54", + "specLocation": "_types/Knn.ts#L69-L72", "variants": { "kind": "container" } @@ -47341,7 +48361,7 @@ } } ], - "specLocation": "_types/Knn.ts#L56-L59" + "specLocation": "_types/Knn.ts#L74-L77" }, { "kind": "enum", @@ -47991,7 +49011,7 @@ }, { "name": "_primary_term", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -48240,7 +49260,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L57-L63" + "specLocation": "_types/aggregations/bucket.ts#L55-L61" }, { "attachedBehaviors": [ @@ -48799,7 +49819,7 @@ "name": "AggregateOrder", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L976-L978", + "specLocation": "_types/aggregations/bucket.ts#L974-L976", "type": { "items": [ { @@ -48851,31 +49871,8 @@ "name": "Aggregation", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "meta", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } - } - }, - { - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/aggregations/Aggregation.ts#L22-L25" + "properties": [], + "specLocation": "_types/aggregations/Aggregation.ts#L20-L20" }, { "kind": "interface", @@ -50007,7 +51004,7 @@ } } ], - "specLocation": "_types/aggregations/AggregationContainer.ts#L106-L515", + "specLocation": "_types/aggregations/AggregationContainer.ts#L105-L514", "variants": { "kind": "container", "nonExhaustive": true @@ -50095,7 +51092,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L672-L685" + "specLocation": "_types/aggregations/bucket.ts#L670-L683" }, { "kind": "interface", @@ -50317,7 +51314,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L65-L100" + "specLocation": "_types/aggregations/bucket.ts#L63-L98" }, { "inherits": { @@ -50578,7 +51575,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L50-L55" + "specLocation": "_types/aggregations/bucket.ts#L48-L53" }, { "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.", @@ -51112,7 +52109,7 @@ "name": "CalendarInterval", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L249-L266" + "specLocation": "_types/aggregations/bucket.ts#L247-L264" }, { "inherits": { @@ -51366,7 +52363,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1037-L1101" + "specLocation": "_types/aggregations/bucket.ts#L1036-L1100" }, { "codegenNames": [ @@ -51378,7 +52375,7 @@ "name": "CategorizeTextAnalyzer", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1103-L1106", + "specLocation": "_types/aggregations/bucket.ts#L1102-L1105", "type": { "items": [ { @@ -51431,7 +52428,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L735-L744" + "specLocation": "_types/aggregations/bucket.ts#L733-L742" }, { "attachedBehaviors": [ @@ -51478,7 +52475,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L111-L116" + "specLocation": "_types/aggregations/bucket.ts#L109-L114" }, { "inherits": { @@ -51523,7 +52520,7 @@ "name": "CompositeAggregateKey", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L118-L118", + "specLocation": "_types/aggregations/bucket.ts#L116-L116", "type": { "key": { "kind": "instance_of", @@ -51608,7 +52605,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L120-L136" + "specLocation": "_types/aggregations/bucket.ts#L118-L134" }, { "kind": "interface", @@ -51686,7 +52683,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L157-L166" + "specLocation": "_types/aggregations/bucket.ts#L155-L164" }, { "kind": "interface", @@ -51744,7 +52741,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L138-L155" + "specLocation": "_types/aggregations/bucket.ts#L136-L153" }, { "attachedBehaviors": [ @@ -51847,7 +52844,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L174-L182" + "specLocation": "_types/aggregations/bucket.ts#L172-L180" }, { "inherits": { @@ -51885,7 +52882,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L184-L187" + "specLocation": "_types/aggregations/bucket.ts#L182-L185" }, { "inherits": { @@ -51912,7 +52909,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L170-L172" + "specLocation": "_types/aggregations/bucket.ts#L168-L170" }, { "inherits": { @@ -51927,7 +52924,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L168-L168" + "specLocation": "_types/aggregations/bucket.ts#L166-L166" }, { "description": "Result of the `cumulative_cardinality` aggregation", @@ -52046,7 +53043,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1108-L1112" + "specLocation": "_types/aggregations/bucket.ts#L1107-L1111" }, { "inherits": { @@ -52293,7 +53290,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L189-L247" + "specLocation": "_types/aggregations/bucket.ts#L187-L245" }, { "attachedBehaviors": [ @@ -52451,7 +53448,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L268-L294" + "specLocation": "_types/aggregations/bucket.ts#L266-L292" }, { "kind": "interface", @@ -52497,7 +53494,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L305-L318" + "specLocation": "_types/aggregations/bucket.ts#L303-L316" }, { "inherits": { @@ -52629,7 +53626,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L320-L341" + "specLocation": "_types/aggregations/bucket.ts#L318-L339" }, { "description": "Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance.", @@ -52770,7 +53767,7 @@ { "description": "Maximum value for the bound.", "name": "max", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -52782,7 +53779,7 @@ { "description": "Minimum value for the bound.", "name": "min", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -52792,7 +53789,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L489-L498" + "specLocation": "_types/aggregations/bucket.ts#L487-L496" }, { "inherits": { @@ -53132,7 +54129,7 @@ "name": "FieldDateMath", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L296-L303", + "specLocation": "_types/aggregations/bucket.ts#L294-L301", "type": { "items": [ { @@ -53270,7 +54267,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L358-L378" + "specLocation": "_types/aggregations/bucket.ts#L356-L376" }, { "attachedBehaviors": [ @@ -53443,7 +54440,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1159-L1183" + "specLocation": "_types/aggregations/bucket.ts#L1158-L1182" }, { "attachedBehaviors": [ @@ -53543,7 +54540,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1145-L1157" + "specLocation": "_types/aggregations/bucket.ts#L1144-L1156" }, { "kind": "enum", @@ -53797,7 +54794,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L380-L403" + "specLocation": "_types/aggregations/bucket.ts#L378-L401" }, { "inherits": { @@ -53900,7 +54897,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L405-L430" + "specLocation": "_types/aggregations/bucket.ts#L403-L428" }, { "attachedBehaviors": [ @@ -54250,7 +55247,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L432-L458" + "specLocation": "_types/aggregations/bucket.ts#L430-L456" }, { "attachedBehaviors": [ @@ -54358,7 +55355,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L460-L485" + "specLocation": "_types/aggregations/bucket.ts#L458-L483" }, { "attachedBehaviors": [ @@ -54392,7 +55389,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L487-L487" + "specLocation": "_types/aggregations/bucket.ts#L485-L485" }, { "kind": "interface", @@ -54414,7 +55411,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L746-L751" + "specLocation": "_types/aggregations/bucket.ts#L744-L749" }, { "kind": "interface", @@ -54658,7 +55655,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L500-L546" + "specLocation": "_types/aggregations/bucket.ts#L498-L544" }, { "attachedBehaviors": [ @@ -55299,7 +56296,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1114-L1143" + "specLocation": "_types/aggregations/bucket.ts#L1113-L1142" }, { "attachedBehaviors": [ @@ -55430,7 +56427,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L548-L557" + "specLocation": "_types/aggregations/bucket.ts#L546-L555" }, { "kind": "interface", @@ -55500,7 +56497,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L559-L572" + "specLocation": "_types/aggregations/bucket.ts#L557-L570" }, { "attachedBehaviors": [ @@ -56218,7 +57215,7 @@ "name": "MinimumInterval", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L102-L109" + "specLocation": "_types/aggregations/bucket.ts#L100-L107" }, { "kind": "type_alias", @@ -56226,7 +57223,7 @@ "name": "Missing", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/AggregationContainer.ts#L517-L517", + "specLocation": "_types/aggregations/AggregationContainer.ts#L516-L516", "type": { "items": [ { @@ -56317,7 +57314,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L574-L580" + "specLocation": "_types/aggregations/bucket.ts#L572-L578" }, { "kind": "enum", @@ -56336,7 +57333,7 @@ "name": "MissingOrder", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/AggregationContainer.ts#L518-L522" + "specLocation": "_types/aggregations/AggregationContainer.ts#L517-L521" }, { "kind": "type_alias", @@ -56667,7 +57664,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L624-L634" + "specLocation": "_types/aggregations/bucket.ts#L622-L632" }, { "inherits": { @@ -56812,7 +57809,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L582-L622" + "specLocation": "_types/aggregations/bucket.ts#L580-L620" }, { "attachedBehaviors": [ @@ -56901,7 +57898,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L753-L762" + "specLocation": "_types/aggregations/bucket.ts#L751-L760" }, { "attachedBehaviors": [ @@ -56948,7 +57945,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L636-L641" + "specLocation": "_types/aggregations/bucket.ts#L634-L639" }, { "inherits": { @@ -57058,7 +58055,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L643-L648" + "specLocation": "_types/aggregations/bucket.ts#L641-L646" }, { "kind": "interface", @@ -57067,7 +58064,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L764-L764" + "specLocation": "_types/aggregations/bucket.ts#L762-L762" }, { "inherits": { @@ -57480,7 +58477,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L650-L670" + "specLocation": "_types/aggregations/bucket.ts#L648-L668" }, { "attachedBehaviors": [ @@ -57656,7 +58653,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L687-L717" + "specLocation": "_types/aggregations/bucket.ts#L685-L715" }, { "inherits": { @@ -57801,7 +58798,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L719-L725" + "specLocation": "_types/aggregations/bucket.ts#L717-L723" }, { "attachedBehaviors": [ @@ -57849,7 +58846,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L727-L733" + "specLocation": "_types/aggregations/bucket.ts#L725-L731" }, { "kind": "enum", @@ -57871,7 +58868,7 @@ "name": "SamplerAggregationExecutionHint", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L343-L356" + "specLocation": "_types/aggregations/bucket.ts#L341-L354" }, { "kind": "interface", @@ -57892,7 +58889,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L766-L768" + "specLocation": "_types/aggregations/bucket.ts#L764-L766" }, { "inherits": { @@ -58398,7 +59395,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L770-L834" + "specLocation": "_types/aggregations/bucket.ts#L768-L832" }, { "attachedBehaviors": [ @@ -58660,7 +59657,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L836-L908" + "specLocation": "_types/aggregations/bucket.ts#L834-L906" }, { "inherits": { @@ -60054,7 +61051,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L910-L970" + "specLocation": "_types/aggregations/bucket.ts#L908-L968" }, { "kind": "enum", @@ -60072,7 +61069,7 @@ "name": "TermsAggregationCollectMode", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L980-L989" + "specLocation": "_types/aggregations/bucket.ts#L978-L987" }, { "kind": "enum", @@ -60094,7 +61091,7 @@ "name": "TermsAggregationExecutionHint", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L991-L996" + "specLocation": "_types/aggregations/bucket.ts#L989-L994" }, { "attachedBehaviors": [ @@ -60136,7 +61133,7 @@ "name": "TermsExclude", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1001-L1002", + "specLocation": "_types/aggregations/bucket.ts#L999-L1000", "type": { "items": [ { @@ -60171,7 +61168,7 @@ "name": "TermsInclude", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L998-L999", + "specLocation": "_types/aggregations/bucket.ts#L996-L997", "type": { "items": [ { @@ -60234,7 +61231,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1004-L1013" + "specLocation": "_types/aggregations/bucket.ts#L1002-L1011" }, { "kind": "interface", @@ -60930,9 +61927,20 @@ "namespace": "_types" } } + }, + { + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } } ], - "specLocation": "_types/aggregations/bucket.ts#L1015-L1035" + "specLocation": "_types/aggregations/bucket.ts#L1013-L1034" }, { "attachedBehaviors": [ @@ -61303,7 +62311,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L168-L171" + "specLocation": "_types/analysis/token_filters.ts#L170-L173" }, { "codegenNames": [ @@ -61528,7 +62536,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L173-L179" + "specLocation": "_types/analysis/token_filters.ts#L175-L181" }, { "inherits": { @@ -61673,7 +62681,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L181-L185" + "specLocation": "_types/analysis/token_filters.ts#L183-L187" }, { "kind": "interface", @@ -62149,7 +63157,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L187-L192" + "specLocation": "_types/analysis/token_filters.ts#L189-L194" }, { "kind": "interface", @@ -62279,7 +63287,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L194-L198" + "specLocation": "_types/analysis/token_filters.ts#L196-L200" }, { "inherits": { @@ -62301,693 +63309,9 @@ "kind": "literal_value", "value": "html_strip" } - } - ], - "specLocation": "_types/analysis/char_filters.ts#L43-L45" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "HunspellTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "hunspell" - } - }, - { - "name": "dedup", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "dictionary", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "locale", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "longest_only", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L200-L206" - }, - { - "inherits": { - "type": { - "name": "CompoundWordTokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "HyphenationDecompounderTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "hyphenation_decompounder" - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L58-L60" - }, - { - "kind": "interface", - "name": { - "name": "IcuAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_analyzer" - } - }, - { - "name": "method", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationType", - "namespace": "_types.analysis" - } - } - }, - { - "name": "mode", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationMode", - "namespace": "_types.analysis" - } - } - } - ], - "specLocation": "_types/analysis/icu-plugin.ts#L67-L71" - }, - { - "kind": "enum", - "members": [ - { - "name": "shifted" - }, - { - "name": "non-ignorable" - } - ], - "name": { - "name": "IcuCollationAlternate", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L89-L92" - }, - { - "kind": "enum", - "members": [ - { - "name": "lower" - }, - { - "name": "upper" - } - ], - "name": { - "name": "IcuCollationCaseFirst", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L94-L97" - }, - { - "kind": "enum", - "members": [ - { - "name": "no" - }, - { - "name": "identical" - } - ], - "name": { - "name": "IcuCollationDecomposition", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L99-L102" - }, - { - "kind": "enum", - "members": [ - { - "name": "primary" - }, - { - "name": "secondary" - }, - { - "name": "tertiary" - }, - { - "name": "quaternary" - }, - { - "name": "identical" - } - ], - "name": { - "name": "IcuCollationStrength", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L104-L110" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "IcuCollationTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_collation" - } }, { - "name": "alternate", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationAlternate", - "namespace": "_types.analysis" - } - } - }, - { - "name": "caseFirst", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationCaseFirst", - "namespace": "_types.analysis" - } - } - }, - { - "name": "caseLevel", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "country", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "decomposition", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationDecomposition", - "namespace": "_types.analysis" - } - } - }, - { - "name": "hiraganaQuaternaryMode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "language", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "numeric", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "rules", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "strength", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationStrength", - "namespace": "_types.analysis" - } - } - }, - { - "name": "variableTop", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "variant", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/analysis/icu-plugin.ts#L51-L65" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "IcuFoldingTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_folding" - } - }, - { - "name": "unicode_set_filter", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/analysis/icu-plugin.ts#L46-L49" - }, - { - "inherits": { - "type": { - "name": "CharFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "IcuNormalizationCharFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_normalizer" - } - }, - { - "name": "mode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationMode", - "namespace": "_types.analysis" - } - } - }, - { - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationType", - "namespace": "_types.analysis" - } - } - } - ], - "specLocation": "_types/analysis/icu-plugin.ts#L40-L44" - }, - { - "kind": "enum", - "members": [ - { - "name": "decompose" - }, - { - "name": "compose" - } - ], - "name": { - "name": "IcuNormalizationMode", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L78-L81" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "IcuNormalizationTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_normalizer" - } - }, - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationType", - "namespace": "_types.analysis" - } - } - } - ], - "specLocation": "_types/analysis/icu-plugin.ts#L35-L38" - }, - { - "kind": "enum", - "members": [ - { - "name": "nfc" - }, - { - "name": "nfkc" - }, - { - "name": "nfkc_cf" - } - ], - "name": { - "name": "IcuNormalizationType", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L83-L87" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "IcuTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_tokenizer" - } - }, - { - "name": "rule_files", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/analysis/icu-plugin.ts#L30-L33" - }, - { - "kind": "enum", - "members": [ - { - "name": "forward" - }, - { - "name": "reverse" - } - ], - "name": { - "name": "IcuTransformDirection", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L73-L76" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "IcuTransformTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_transform" - } - }, - { - "name": "dir", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuTransformDirection", - "namespace": "_types.analysis" - } - } - }, - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/analysis/icu-plugin.ts#L24-L28" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "KStemTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "kstem" - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L239-L241" - }, - { - "kind": "enum", - "members": [ - { - "name": "include" - }, - { - "name": "exclude" - } - ], - "name": { - "name": "KeepTypesMode", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/token_filters.ts#L213-L216" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "KeepTypesTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "keep_types" - } - }, - { - "name": "mode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "KeepTypesMode", - "namespace": "_types.analysis" - } - } - }, - { - "name": "types", + "name": "escaped_tags", "required": false, "type": { "kind": "array_of", @@ -63001,7 +63325,705 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L218-L222" + "specLocation": "_types/analysis/char_filters.ts#L43-L46" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "HunspellTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "hunspell" + } + }, + { + "name": "dedup", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "dictionary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "locale", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "longest_only", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L202-L208" + }, + { + "inherits": { + "type": { + "name": "CompoundWordTokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "HyphenationDecompounderTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "hyphenation_decompounder" + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L58-L60" + }, + { + "kind": "interface", + "name": { + "name": "IcuAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_analyzer" + } + }, + { + "name": "method", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationType", + "namespace": "_types.analysis" + } + } + }, + { + "name": "mode", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationMode", + "namespace": "_types.analysis" + } + } + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L67-L71" + }, + { + "kind": "enum", + "members": [ + { + "name": "shifted" + }, + { + "name": "non-ignorable" + } + ], + "name": { + "name": "IcuCollationAlternate", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L89-L92" + }, + { + "kind": "enum", + "members": [ + { + "name": "lower" + }, + { + "name": "upper" + } + ], + "name": { + "name": "IcuCollationCaseFirst", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L94-L97" + }, + { + "kind": "enum", + "members": [ + { + "name": "no" + }, + { + "name": "identical" + } + ], + "name": { + "name": "IcuCollationDecomposition", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L99-L102" + }, + { + "kind": "enum", + "members": [ + { + "name": "primary" + }, + { + "name": "secondary" + }, + { + "name": "tertiary" + }, + { + "name": "quaternary" + }, + { + "name": "identical" + } + ], + "name": { + "name": "IcuCollationStrength", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L104-L110" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "IcuCollationTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_collation" + } + }, + { + "name": "alternate", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuCollationAlternate", + "namespace": "_types.analysis" + } + } + }, + { + "name": "caseFirst", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuCollationCaseFirst", + "namespace": "_types.analysis" + } + } + }, + { + "name": "caseLevel", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "country", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "decomposition", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuCollationDecomposition", + "namespace": "_types.analysis" + } + } + }, + { + "name": "hiraganaQuaternaryMode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "language", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "numeric", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "rules", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "strength", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuCollationStrength", + "namespace": "_types.analysis" + } + } + }, + { + "name": "variableTop", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "variant", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L51-L65" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "IcuFoldingTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_folding" + } + }, + { + "name": "unicode_set_filter", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L46-L49" + }, + { + "inherits": { + "type": { + "name": "CharFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "IcuNormalizationCharFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_normalizer" + } + }, + { + "name": "mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationMode", + "namespace": "_types.analysis" + } + } + }, + { + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationType", + "namespace": "_types.analysis" + } + } + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L40-L44" + }, + { + "kind": "enum", + "members": [ + { + "name": "decompose" + }, + { + "name": "compose" + } + ], + "name": { + "name": "IcuNormalizationMode", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L78-L81" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "IcuNormalizationTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_normalizer" + } + }, + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationType", + "namespace": "_types.analysis" + } + } + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L35-L38" + }, + { + "kind": "enum", + "members": [ + { + "name": "nfc" + }, + { + "name": "nfkc" + }, + { + "name": "nfkc_cf" + } + ], + "name": { + "name": "IcuNormalizationType", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L83-L87" + }, + { + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "IcuTokenizer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_tokenizer" + } + }, + { + "name": "rule_files", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L30-L33" + }, + { + "kind": "enum", + "members": [ + { + "name": "forward" + }, + { + "name": "reverse" + } + ], + "name": { + "name": "IcuTransformDirection", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L73-L76" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "IcuTransformTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_transform" + } + }, + { + "name": "dir", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuTransformDirection", + "namespace": "_types.analysis" + } + } + }, + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L24-L28" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "KStemTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "kstem" + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L241-L243" + }, + { + "kind": "enum", + "members": [ + { + "name": "include" + }, + { + "name": "exclude" + } + ], + "name": { + "name": "KeepTypesMode", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/token_filters.ts#L215-L218" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "KeepTypesTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "keep_types" + } + }, + { + "name": "mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "KeepTypesMode", + "namespace": "_types.analysis" + } + } + }, + { + "name": "types", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L220-L224" }, { "inherits": { @@ -63061,7 +64083,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L224-L229" + "specLocation": "_types/analysis/token_filters.ts#L226-L231" }, { "kind": "interface", @@ -63161,7 +64183,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L231-L237" + "specLocation": "_types/analysis/token_filters.ts#L233-L239" }, { "inherits": { @@ -63747,7 +64769,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L243-L247" + "specLocation": "_types/analysis/token_filters.ts#L245-L249" }, { "inherits": { @@ -63826,7 +64848,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L249-L253" + "specLocation": "_types/analysis/token_filters.ts#L251-L255" }, { "kind": "interface", @@ -63879,7 +64901,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L255-L258" + "specLocation": "_types/analysis/token_filters.ts#L257-L260" }, { "inherits": { @@ -63952,7 +64974,7 @@ } } ], - "specLocation": "_types/analysis/char_filters.ts#L47-L51" + "specLocation": "_types/analysis/char_filters.ts#L48-L52" }, { "inherits": { @@ -64010,7 +65032,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L260-L264" + "specLocation": "_types/analysis/token_filters.ts#L262-L266" }, { "inherits": { @@ -64076,7 +65098,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L266-L271" + "specLocation": "_types/analysis/token_filters.ts#L268-L273" }, { "inherits": { @@ -64269,7 +65291,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L273-L276" + "specLocation": "_types/analysis/token_filters.ts#L275-L278" }, { "inherits": { @@ -64610,7 +65632,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L278-L282" + "specLocation": "_types/analysis/token_filters.ts#L280-L284" }, { "inherits": { @@ -64667,7 +65689,7 @@ } } ], - "specLocation": "_types/analysis/char_filters.ts#L53-L58" + "specLocation": "_types/analysis/char_filters.ts#L54-L59" }, { "inherits": { @@ -64735,7 +65757,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L284-L290" + "specLocation": "_types/analysis/token_filters.ts#L286-L292" }, { "inherits": { @@ -65036,7 +66058,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L292-L294" + "specLocation": "_types/analysis/token_filters.ts#L294-L296" }, { "inherits": { @@ -65071,7 +66093,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L296-L299" + "specLocation": "_types/analysis/token_filters.ts#L298-L301" }, { "inherits": { @@ -65095,7 +66117,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L301-L303" + "specLocation": "_types/analysis/token_filters.ts#L303-L305" }, { "inherits": { @@ -65119,7 +66141,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L305-L307" + "specLocation": "_types/analysis/token_filters.ts#L307-L309" }, { "inherits": { @@ -65424,7 +66446,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L309-L312" + "specLocation": "_types/analysis/token_filters.ts#L311-L314" }, { "kind": "interface", @@ -65548,7 +66570,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L314-L318" + "specLocation": "_types/analysis/token_filters.ts#L316-L320" }, { "inherits": { @@ -65586,7 +66608,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L320-L324" + "specLocation": "_types/analysis/token_filters.ts#L322-L326" }, { "kind": "interface", @@ -65833,6 +66855,17 @@ } } }, + { + "name": "synonyms_set", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "name": "tokenizer", "required": false, @@ -65856,7 +66889,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L110-L119" + "specLocation": "_types/analysis/token_filters.ts#L110-L120" }, { "inherits": { @@ -65937,6 +66970,17 @@ } } }, + { + "name": "synonyms_set", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "name": "tokenizer", "required": false, @@ -65960,7 +67004,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L121-L130" + "specLocation": "_types/analysis/token_filters.ts#L122-L132" }, { "kind": "enum", @@ -66000,7 +67044,7 @@ "name": "TokenFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/token_filters.ts#L344-L346", + "specLocation": "_types/analysis/token_filters.ts#L346-L348", "type": { "items": [ { @@ -66048,7 +67092,7 @@ "name": "TokenFilterDefinition", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/token_filters.ts#L348-L400", + "specLocation": "_types/analysis/token_filters.ts#L350-L402", "type": { "items": [ { @@ -66579,7 +67623,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L326-L328" + "specLocation": "_types/analysis/token_filters.ts#L328-L330" }, { "inherits": { @@ -66614,7 +67658,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L330-L333" + "specLocation": "_types/analysis/token_filters.ts#L332-L335" }, { "inherits": { @@ -66684,7 +67728,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L335-L338" + "specLocation": "_types/analysis/token_filters.ts#L337-L340" }, { "inherits": { @@ -66708,7 +67752,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L340-L342" + "specLocation": "_types/analysis/token_filters.ts#L342-L344" }, { "kind": "interface", @@ -66976,7 +68020,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L149-L166" + "specLocation": "_types/analysis/token_filters.ts#L151-L168" }, { "inherits": { @@ -67158,7 +68202,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L132-L147" + "specLocation": "_types/analysis/token_filters.ts#L134-L149" }, { "inherits": { @@ -68136,7 +69180,7 @@ "required": true, "type": { "kind": "literal_value", - "value": "{dynamic_property}" + "value": "{dynamic_type}" } }, { @@ -70849,6 +71893,9 @@ { "name": "boolean" }, + { + "name": "composite" + }, { "name": "date" }, @@ -70875,7 +71922,7 @@ "name": "RuntimeFieldType", "namespace": "_types.mapping" }, - "specLocation": "_types/mapping/RuntimeFields.ts#L56-L65" + "specLocation": "_types/mapping/RuntimeFields.ts#L56-L66" }, { "kind": "type_alias", @@ -75115,792 +76162,6 @@ } } }, - { - "name": "per_field_analyzer", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } - } - }, - { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "name": "version_type", - "required": false, - "serverDefault": "'internal'", - "type": { - "kind": "instance_of", - "type": { - "name": "VersionType", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/query_dsl/specialized.ts#L165-L184" - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MatchAllQuery", - "namespace": "_types.query_dsl" - }, - "properties": [], - "specLocation": "_types/query_dsl/MatchAllQuery.ts#L22-L22" - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MatchBoolPrefixQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "Analyzer used to convert the text in the query value into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", - "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", - "name": "fuzziness", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fuzziness", - "namespace": "_types" - } - } - }, - { - "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", - "name": "fuzzy_rewrite", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" - } - } - }, - { - "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.", - "name": "fuzzy_transpositions", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Maximum number of terms to which the query will expand.\nCan be applied to the term subqueries constructed for all terms but the final term.", - "name": "max_expansions", - "required": false, - "serverDefault": 50, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", - "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", - "name": "minimum_should_match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" - } - } - }, - { - "description": "Boolean logic used to interpret text in the query value.\nApplied to the constructed bool query.", - "name": "operator", - "required": false, - "serverDefault": "'or'", - "type": { - "kind": "instance_of", - "type": { - "name": "Operator", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Number of beginning characters left unchanged for fuzzy matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", - "name": "prefix_length", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Terms you wish to find in the provided field.\nThe last term is used in a prefix query.", - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L349-L403" - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MatchNoneQuery", - "namespace": "_types.query_dsl" - }, - "properties": [], - "specLocation": "_types/query_dsl/MatchNoneQuery.ts#L22-L22" - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MatchPhrasePrefixQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "Analyzer used to convert text in the query value into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Maximum number of terms to which the last provided term of the query value will expand.", - "name": "max_expansions", - "required": false, - "serverDefault": 50, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Text you wish to find in the provided field.", - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Maximum number of positions allowed between matching tokens.", - "name": "slop", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", - "name": "zero_terms_query", - "required": false, - "serverDefault": "none", - "type": { - "kind": "instance_of", - "type": { - "name": "ZeroTermsQuery", - "namespace": "_types.query_dsl" - } - } - } - ], - "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L428-L454" - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MatchPhraseQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "Analyzer used to convert the text in the query value into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Query terms that are analyzed and turned into a phrase query.", - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Maximum number of positions allowed between matching tokens.", - "name": "slop", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", - "name": "zero_terms_query", - "required": false, - "serverDefault": "'none'", - "type": { - "kind": "instance_of", - "type": { - "name": "ZeroTermsQuery", - "namespace": "_types.query_dsl" - } - } - } - ], - "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L405-L426" - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MatchQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "Analyzer used to convert the text in the query value into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", - "name": "auto_generate_synonyms_phrase_query", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "deprecation": { - "description": "", - "version": "7.3.0" - }, - "name": "cutoff_frequency", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "description": "Maximum edit distance allowed for matching.", - "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", - "name": "fuzziness", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fuzziness", - "namespace": "_types" - } - } - }, - { - "description": "Method used to rewrite the query.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", - "name": "fuzzy_rewrite", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" - } - } - }, - { - "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", - "name": "fuzzy_transpositions", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.", - "name": "lenient", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Maximum number of terms to which the query will expand.", - "name": "max_expansions", - "required": false, - "serverDefault": 50, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Minimum number of clauses that must match for a document to be returned.", - "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", - "name": "minimum_should_match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" - } - } - }, - { - "description": "Boolean logic used to interpret text in the query value.", - "name": "operator", - "required": false, - "serverDefault": "'or'", - "type": { - "kind": "instance_of", - "type": { - "name": "Operator", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Number of beginning characters left unchanged for fuzzy matching.", - "name": "prefix_length", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Text, number, boolean value or date you wish to find in the provided field.", - "name": "query", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", - "name": "zero_terms_query", - "required": false, - "serverDefault": "'none'", - "type": { - "kind": "instance_of", - "type": { - "name": "ZeroTermsQuery", - "namespace": "_types.query_dsl" - } - } - } - ], - "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L282-L347" - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MoreLikeThisQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Each term in the formed query could be further boosted by their tf-idf score.\nThis sets the boost factor to use when using this feature.\nDefaults to deactivated (0).", - "name": "boost_terms", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "description": "Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`).", - "name": "fail_on_unsupported_field", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "A list of fields to fetch and analyze the text from.\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.", - "name": "fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - }, - { - "description": "Specifies whether the input documents should also be included in the search results returned.", - "name": "include", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Specifies free form text and/or a single or multiple documents for which you want to find similar documents.", - "name": "like", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" - } - }, - { - "description": "The maximum document frequency above which the terms are ignored from the input document.", - "name": "max_doc_freq", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The maximum number of query terms that can be selected.", - "name": "max_query_terms", - "required": false, - "serverDefault": 25, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The maximum word length above which the terms are ignored.\nDefaults to unbounded (`0`).", - "name": "max_word_length", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The minimum document frequency below which the terms are ignored from the input document.", - "name": "min_doc_freq", - "required": false, - "serverDefault": 5, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", - "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", - "name": "minimum_should_match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" - } - } - }, - { - "description": "The minimum term frequency below which the terms are ignored from the input document.", - "name": "min_term_freq", - "required": false, - "serverDefault": 2, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The minimum word length below which the terms are ignored.", - "name": "min_word_length", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, { "description": "Overrides the default analyzer.", "name": "per_field_analyzer", @@ -75935,6 +76196,770 @@ } } }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "version_type", + "required": false, + "serverDefault": "'internal'", + "type": { + "kind": "instance_of", + "type": { + "name": "VersionType", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L162-L184" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchAllQuery", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/MatchAllQuery.ts#L22-L22" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchBoolPrefixQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Analyzer used to convert the text in the query value into tokens.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", + "name": "fuzziness", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fuzziness", + "namespace": "_types" + } + } + }, + { + "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", + "name": "fuzzy_rewrite", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MultiTermQueryRewrite", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.", + "name": "fuzzy_transpositions", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Maximum number of terms to which the query will expand.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "name": "max_expansions", + "required": false, + "serverDefault": 50, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", + "name": "minimum_should_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MinimumShouldMatch", + "namespace": "_types" + } + } + }, + { + "description": "Boolean logic used to interpret text in the query value.\nApplied to the constructed bool query.", + "name": "operator", + "required": false, + "serverDefault": "'or'", + "type": { + "kind": "instance_of", + "type": { + "name": "Operator", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Number of beginning characters left unchanged for fuzzy matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "name": "prefix_length", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Terms you wish to find in the provided field.\nThe last term is used in a prefix query.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L349-L403" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchNoneQuery", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/MatchNoneQuery.ts#L22-L22" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchPhrasePrefixQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Analyzer used to convert text in the query value into tokens.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Maximum number of terms to which the last provided term of the query value will expand.", + "name": "max_expansions", + "required": false, + "serverDefault": 50, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Text you wish to find in the provided field.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Maximum number of positions allowed between matching tokens.", + "name": "slop", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", + "name": "zero_terms_query", + "required": false, + "serverDefault": "none", + "type": { + "kind": "instance_of", + "type": { + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" + } + } + } + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L428-L454" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchPhraseQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Analyzer used to convert the text in the query value into tokens.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Query terms that are analyzed and turned into a phrase query.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Maximum number of positions allowed between matching tokens.", + "name": "slop", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "name": "zero_terms_query", + "required": false, + "serverDefault": "'none'", + "type": { + "kind": "instance_of", + "type": { + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" + } + } + } + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L405-L426" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Analyzer used to convert the text in the query value into tokens.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", + "name": "auto_generate_synonyms_phrase_query", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "deprecation": { + "description": "", + "version": "7.3.0" + }, + "name": "cutoff_frequency", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "description": "Maximum edit distance allowed for matching.", + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", + "name": "fuzziness", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fuzziness", + "namespace": "_types" + } + } + }, + { + "description": "Method used to rewrite the query.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", + "name": "fuzzy_rewrite", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MultiTermQueryRewrite", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", + "name": "fuzzy_transpositions", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.", + "name": "lenient", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Maximum number of terms to which the query will expand.", + "name": "max_expansions", + "required": false, + "serverDefault": 50, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Minimum number of clauses that must match for a document to be returned.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", + "name": "minimum_should_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MinimumShouldMatch", + "namespace": "_types" + } + } + }, + { + "description": "Boolean logic used to interpret text in the query value.", + "name": "operator", + "required": false, + "serverDefault": "'or'", + "type": { + "kind": "instance_of", + "type": { + "name": "Operator", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Number of beginning characters left unchanged for fuzzy matching.", + "name": "prefix_length", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Text, number, boolean value or date you wish to find in the provided field.", + "name": "query", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "name": "zero_terms_query", + "required": false, + "serverDefault": "'none'", + "type": { + "kind": "instance_of", + "type": { + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" + } + } + } + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L282-L347" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MoreLikeThisQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Each term in the formed query could be further boosted by their tf-idf score.\nThis sets the boost factor to use when using this feature.\nDefaults to deactivated (0).", + "name": "boost_terms", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "description": "Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`).", + "name": "fail_on_unsupported_field", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "A list of fields to fetch and analyze the text from.\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.", + "name": "fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + }, + { + "description": "Specifies whether the input documents should also be included in the search results returned.", + "name": "include", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specifies free form text and/or a single or multiple documents for which you want to find similar documents.", + "name": "like", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Like", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Like", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The maximum document frequency above which the terms are ignored from the input document.", + "name": "max_doc_freq", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of query terms that can be selected.", + "name": "max_query_terms", + "required": false, + "serverDefault": 25, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum word length above which the terms are ignored.\nDefaults to unbounded (`0`).", + "name": "max_word_length", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The minimum document frequency below which the terms are ignored from the input document.", + "name": "min_doc_freq", + "required": false, + "serverDefault": 5, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", + "name": "minimum_should_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MinimumShouldMatch", + "namespace": "_types" + } + } + }, + { + "description": "The minimum term frequency below which the terms are ignored from the input document.", + "name": "min_term_freq", + "required": false, + "serverDefault": 2, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The minimum word length below which the terms are ignored.", + "name": "min_word_length", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, { "description": "An array of stop words.\nAny word in this set is ignored.", "name": "stop_words", @@ -75998,7 +77023,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L78-L163" + "specLocation": "_types/query_dsl/specialized.ts#L78-L160" }, { "inherits": { @@ -79676,9 +80701,10 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L131-L170", + "specLocation": "_types/query_dsl/span.ts#L131-L173", "variants": { - "kind": "container" + "kind": "container", + "nonExhaustive": true } }, { @@ -81166,7 +82192,7 @@ { "kind": "instance_of", "type": { - "name": "KnnQuery", + "name": "KnnSearch", "namespace": "_types" } }, @@ -81175,7 +82201,7 @@ "value": { "kind": "instance_of", "type": { - "name": "KnnQuery", + "name": "KnnSearch", "namespace": "_types" } } @@ -100949,18 +101975,6 @@ "body": { "kind": "properties", "properties": [ - { - "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that\ntemplate even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false` then data streams matching the template must always be explicitly created.", - "name": "allow_auto_create", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "description": "The template to be applied which includes mappings, settings, or aliases configuration.", "name": "template", @@ -100996,6 +102010,18 @@ "namespace": "_types" } } + }, + { + "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", + "name": "deprecated", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ] }, @@ -101051,9 +102077,20 @@ "namespace": "_types" } } + }, + { + "name": "cause", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L29-L99" + "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L26-L96" }, { "body": { @@ -104658,133 +105695,116 @@ "specLocation": "cluster/stats/ClusterStatsResponse.ts#L25-L51" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Deletes the specified dangling index", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "dangling_indices.delete_dangling_index" + "name": "Connector", + "namespace": "connector._types" }, - "path": [ + "properties": [ { - "description": "The UUID of the dangling index", - "name": "index_uuid", + "name": "api_key_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "configuration", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "ConnectorConfiguration", + "namespace": "connector._types" } } - } - ], - "query": [ + }, { - "description": "Must be set to true in order to delete the dangling index", - "name": "accept_data_loss", + "name": "custom_scheduling", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ConnectorCustomScheduling", + "namespace": "connector._types" } } }, { - "description": "Specify timeout for connection to master", - "name": "master_timeout", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Explicit operation timeout", - "name": "timeout", + "name": "error", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L37" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", + }, + { + "name": "features", + "required": true, "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "ConnectorFeatures", + "namespace": "connector._types" + } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "dangling_indices.delete_dangling_index" - }, - "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Imports the specified dangling index", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "dangling_indices.import_dangling_index" - }, - "path": [ + }, { - "description": "The UUID of the dangling index", - "name": "index_uuid", + "name": "filtering", "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FilteringConfig", + "namespace": "connector._types" + } + } + } + }, + { + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Uuid", + "name": "Id", "namespace": "_types" } } - } - ], - "query": [ + }, { - "description": "Must be set to true in order to import the dangling index", - "name": "accept_data_loss", + "name": "index_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "is_native", "required": true, "type": { "kind": "instance_of", @@ -104795,60 +105815,96 @@ } }, { - "description": "Specify timeout for connection to master", - "name": "master_timeout", + "name": "language", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_access_control_sync_error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_access_control_sync_scheduled_at", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_access_control_sync_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncStatus", + "namespace": "connector._types" + } + } + }, + { + "name": "last_deleted_document_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } }, { - "description": "Explicit operation timeout", - "name": "timeout", + "name": "last_incremental_sync_scheduled_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_indexed_document_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } - } - ], - "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L37" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", + }, + { + "name": "last_seen", + "required": false, "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "dangling_indices.import_dangling_index" - }, - "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "DanglingIndex", - "namespace": "dangling_indices.list_dangling_indices" - }, - "properties": [ + }, { - "name": "index_name", - "required": true, + "name": "last_sync_error", + "required": false, "type": { "kind": "instance_of", "type": { @@ -104858,8 +105914,8 @@ } }, { - "name": "index_uuid", - "required": true, + "name": "last_sync_scheduled_at", + "required": false, "type": { "kind": "instance_of", "type": { @@ -104869,153 +105925,188 @@ } }, { - "name": "creation_date_millis", + "name": "last_sync_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncStatus", + "namespace": "connector._types" + } + } + }, + { + "name": "last_synced", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IngestPipelineParams", + "namespace": "connector._types" + } + } + }, + { + "name": "scheduling", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", - "namespace": "_types" + "name": "SchedulingConfiguration", + "namespace": "connector._types" } } }, { - "name": "node_ids", + "name": "service_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L29-L34" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns all dangling indices.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "dangling_indices.list_dangling_indices" - }, - "path": [], - "query": [], - "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L26" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "dangling_indices", - "required": true, + }, + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DanglingIndex", - "namespace": "dangling_indices.list_dangling_indices" - } - } + "name": "ConnectorStatus", + "namespace": "connector._types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "dangling_indices.list_dangling_indices" - }, - "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L23-L27" + }, + { + "name": "sync_now", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L237-L266" }, { "kind": "interface", "name": { - "name": "Policy", - "namespace": "enrich._types" + "name": "ConnectorConfigProperties", + "namespace": "connector._types" }, "properties": [ { - "name": "enrich_fields", - "required": true, + "name": "category", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "indices", + "name": "default_value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "ScalarValue", "namespace": "_types" } } }, { - "name": "match_field", + "name": "depends_on", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Dependency", + "namespace": "connector._types" + } + } + } + }, + { + "name": "display", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "DisplayType", + "namespace": "connector._types" } } }, { - "name": "query", - "required": false, + "name": "label", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "name", + "name": "options", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SelectOption", + "namespace": "connector._types" + } + } + } + }, + { + "name": "order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } }, { - "name": "elasticsearch_version", + "name": "placeholder", "required": false, "type": { "kind": "instance_of", @@ -105024,197 +106115,177 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "enrich/_types/Policy.ts#L34-L41" - }, - { - "kind": "enum", - "members": [ + }, { - "name": "geo_match" + "name": "required", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "match" + "name": "sensitive", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "range" - } - ], - "name": { - "name": "PolicyType", - "namespace": "enrich._types" - }, - "specLocation": "enrich/_types/Policy.ts#L28-L32" - }, - { - "kind": "interface", - "name": { - "name": "Summary", - "namespace": "enrich._types" - }, - "properties": [ + "name": "tooltip", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { - "name": "config", + "name": "type", "required": true, "type": { - "key": { + "kind": "instance_of", + "type": { + "name": "ConnectorFieldType", + "namespace": "connector._types" + } + } + }, + { + "name": "ui_restrictions", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "PolicyType", - "namespace": "enrich._types" + "name": "string", + "namespace": "_builtins" } - }, - "kind": "dictionary_of", - "singleKey": true, + } + } + }, + { + "name": "validations", + "required": true, + "type": { + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "Policy", - "namespace": "enrich._types" + "name": "Validation", + "namespace": "connector._types" } } } - } - ], - "specLocation": "enrich/_types/Policy.ts#L24-L26" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Deletes an existing enrich policy and its enrich index.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "enrich.delete_policy" - }, - "path": [ + }, { - "description": "Enrich policy to delete.", - "name": "name", + "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "ScalarValue", "namespace": "_types" } } } ], - "query": [], - "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L23-L36" + "specLocation": "connector/_types/Connector.ts#L82-L98" }, { - "body": { - "kind": "value", + "kind": "type_alias", + "name": { + "name": "ConnectorConfiguration", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L100-L103", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "ConnectorConfigProperties", + "namespace": "connector._types" } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "enrich.delete_policy" - }, - "specLocation": "enrich/delete_policy/DeleteEnrichPolicyResponse.ts#L22-L24" + } }, { - "kind": "enum", - "members": [ - { - "name": "SCHEDULED" - }, - { - "name": "RUNNING" - }, - { - "name": "COMPLETE" - }, - { - "name": "FAILED" - } - ], + "kind": "type_alias", "name": { - "name": "EnrichPolicyPhase", - "namespace": "enrich.execute_policy" + "name": "ConnectorCustomScheduling", + "namespace": "connector._types" }, - "specLocation": "enrich/execute_policy/types.ts#L24-L29" + "specLocation": "connector/_types/Connector.ts#L127-L127", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "CustomScheduling", + "namespace": "connector._types" + } + } + } }, { "kind": "interface", "name": { - "name": "ExecuteEnrichPolicyStatus", - "namespace": "enrich.execute_policy" + "name": "ConnectorFeatures", + "namespace": "connector._types" }, "properties": [ { - "name": "phase", - "required": true, + "name": "document_level_security", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EnrichPolicyPhase", - "namespace": "enrich.execute_policy" + "name": "FeatureEnabled", + "namespace": "connector._types" } } - } - ], - "specLocation": "enrich/execute_policy/types.ts#L20-L22" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Creates the enrich index for an existing enrich policy.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "enrich.execute_policy" - }, - "path": [ + }, { - "description": "Enrich policy to execute.", - "name": "name", - "required": true, + "name": "filtering_advanced_config", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "description": "If `true`, the request blocks other enrich policy execution requests until complete.", - "name": "wait_for_completion", + "name": "filtering_rules", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -105222,402 +106293,3715 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L23-L44" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "status", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExecuteEnrichPolicyStatus", - "namespace": "enrich.execute_policy" - } - } - }, - { - "name": "task_id", - "required": false, + }, + { + "name": "incremental_sync", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "TaskId", - "namespace": "_types" - } + "name": "FeatureEnabled", + "namespace": "connector._types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "enrich.execute_policy" - }, - "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyResponse.ts#L23-L28" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns information about an enrich policy.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "enrich.get_policy" - }, - "path": [ + }, { - "description": "Comma-separated list of enrich policy names used to limit the request.\nTo return information for all enrich policies, omit this parameter.", - "name": "name", + "name": "sync_rules", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "SyncRulesFeature", + "namespace": "connector._types" } } } ], - "query": [], - "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L23-L37" + "specLocation": "connector/_types/Connector.ts#L223-L229" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "policies", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Summary", - "namespace": "enrich._types" - } - } - } - } - ] - }, - "kind": "response", + "kind": "enum", + "members": [ + { + "name": "str" + }, + { + "name": "int" + }, + { + "name": "list" + }, + { + "name": "bool" + } + ], "name": { - "name": "Response", - "namespace": "enrich.get_policy" + "name": "ConnectorFieldType", + "namespace": "connector._types" }, - "specLocation": "enrich/get_policy/GetEnrichPolicyResponse.ts#L22-L24" + "specLocation": "connector/_types/Connector.ts#L42-L47" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", - "name": "geo_match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Policy", - "namespace": "enrich._types" - } - } - }, - { - "description": "Matches enrich data to incoming documents based on a `term` query.", - "name": "match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Policy", - "namespace": "enrich._types" - } - } - }, - { - "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", - "name": "range", - "required": false, + "kind": "interface", + "name": { + "name": "ConnectorScheduling", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "enabled", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Policy", - "namespace": "enrich._types" - } + "name": "boolean", + "namespace": "_builtins" } } - ] - }, - "description": "Creates an enrich policy.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "enrich.put_policy" - }, - "path": [ + }, { - "description": "Name of the enrich policy to create or update.", - "name": "name", + "description": "The interval is expressed using the crontab syntax", + "name": "interval", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "query": [], - "specLocation": "enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L52" + "specLocation": "connector/_types/Connector.ts#L105-L109" }, { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } + "kind": "enum", + "members": [ + { + "name": "created" + }, + { + "name": "needs_configuration" + }, + { + "name": "configured" + }, + { + "name": "connected" + }, + { + "name": "error" } - }, - "kind": "response", + ], "name": { - "name": "Response", - "namespace": "enrich.put_policy" + "name": "ConnectorStatus", + "namespace": "connector._types" }, - "specLocation": "enrich/put_policy/PutEnrichPolicyResponse.ts#L22-L24" + "specLocation": "connector/_types/Connector.ts#L129-L135" }, { "kind": "interface", "name": { - "name": "CacheStats", - "namespace": "enrich.stats" + "name": "CustomScheduling", + "namespace": "connector._types" }, "properties": [ { - "name": "node_id", + "name": "configuration_overrides", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "CustomSchedulingConfigurationOverrides", + "namespace": "connector._types" } } }, { - "name": "count", + "name": "enabled", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "hits", + "name": "interval", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "misses", - "required": true, + "name": "last_synced", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "evictions", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "enrich/stats/types.ts#L37-L43" + "specLocation": "connector/_types/Connector.ts#L119-L125" }, { "kind": "interface", "name": { - "name": "CoordinatorStats", - "namespace": "enrich.stats" + "name": "CustomSchedulingConfigurationOverrides", + "namespace": "connector._types" }, "properties": [ { - "name": "executed_searches_total", - "required": true, + "name": "max_crawl_depth", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "node_id", - "required": true, + "name": "sitemap_discovery_disabled", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "queue_size", - "required": true, + "name": "domain_allowlist", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "remote_requests_current", - "required": true, + "name": "sitemap_urls", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "remote_requests_total", - "required": true, + "name": "seed_urls", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "enrich/stats/types.ts#L29-L35" + "specLocation": "connector/_types/Connector.ts#L111-L117" }, { "kind": "interface", "name": { - "name": "ExecutingPolicy", - "namespace": "enrich.stats" + "name": "Dependency", + "namespace": "connector._types" }, "properties": [ { - "name": "name", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "task", + "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TaskInfo", - "namespace": "tasks._types" + "name": "ScalarValue", + "namespace": "_types" } } } ], - "specLocation": "enrich/stats/types.ts#L24-L27" + "specLocation": "connector/_types/Connector.ts#L29-L32" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Returns enrich coordinator statistics and information about enrich policies that are currently executing.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" + "kind": "enum", + "members": [ + { + "name": "textbox" + }, + { + "name": "textarea" + }, + { + "name": "numeric" + }, + { + "name": "toggle" + }, + { + "name": "dropdown" } - }, - "kind": "request", + ], "name": { - "name": "Request", - "namespace": "enrich.stats" + "name": "DisplayType", + "namespace": "connector._types" }, - "path": [], - "query": [], - "specLocation": "enrich/stats/EnrichStatsRequest.ts#L22-L28" + "specLocation": "connector/_types/Connector.ts#L34-L40" }, { - "body": { - "kind": "properties", - "properties": [ - { - "description": "Objects containing information about each coordinating ingest node for configured enrich processors.", - "name": "coordinator_stats", - "required": true, + "kind": "interface", + "name": { + "name": "FeatureEnabled", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "enabled", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CoordinatorStats", - "namespace": "enrich.stats" - } - } + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L214-L216" + }, + { + "kind": "interface", + "name": { + "name": "FilteringAdvancedSnippet", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "created_at", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "updated_at", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "value", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L191-L195" + }, + { + "kind": "interface", + "name": { + "name": "FilteringConfig", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "active", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FilteringRules", + "namespace": "connector._types" + } + } + }, + { + "name": "domain", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "draft", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FilteringRules", + "namespace": "connector._types" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L208-L212" + }, + { + "kind": "enum", + "members": [ + { + "name": "exclude" + }, + { + "name": "include" + } + ], + "name": { + "name": "FilteringPolicy", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L154-L157" + }, + { + "kind": "interface", + "name": { + "name": "FilteringRule", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "created_at", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "order", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "policy", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FilteringPolicy", + "namespace": "connector._types" + } + } + }, + { + "name": "rule", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FilteringRuleRule", + "namespace": "connector._types" + } + } + }, + { + "name": "updated_at", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "value", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L169-L178" + }, + { + "kind": "enum", + "members": [ + { + "name": "contains" + }, + { + "name": "ends_with" + }, + { + "name": "equals" + }, + { + "name": "regex" + }, + { + "name": "starts_with" + }, + { + "codegenName": "greater_than", + "name": ">" + }, + { + "codegenName": "less_than", + "name": "<" + } + ], + "name": { + "name": "FilteringRuleRule", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L159-L167" + }, + { + "kind": "interface", + "name": { + "name": "FilteringRules", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "advanced_snippet", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FilteringAdvancedSnippet", + "namespace": "connector._types" + } + } + }, + { + "name": "rules", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FilteringRule", + "namespace": "connector._types" + } + } + } + }, + { + "name": "validation", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FilteringRulesValidation", + "namespace": "connector._types" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L202-L206" + }, + { + "kind": "interface", + "name": { + "name": "FilteringRulesValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "errors", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FilteringValidation", + "namespace": "connector._types" + } + } + } + }, + { + "name": "state", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FilteringValidationState", + "namespace": "connector._types" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L197-L200" + }, + { + "kind": "interface", + "name": { + "name": "FilteringValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "ids", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "messages", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L180-L183" + }, + { + "kind": "enum", + "members": [ + { + "name": "edited" + }, + { + "name": "invalid" + }, + { + "name": "valid" + } + ], + "name": { + "name": "FilteringValidationState", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L185-L189" + }, + { + "kind": "interface", + "name": { + "name": "GreaterThanValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "greater_than" + } + }, + { + "name": "constraint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L62-L65" + }, + { + "kind": "interface", + "name": { + "name": "IncludedInValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "included_in" + } + }, + { + "name": "constraint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L72-L75" + }, + { + "kind": "interface", + "name": { + "name": "IngestPipelineParams", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "extract_binary_content", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "reduce_whitespace", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "run_ml_inference", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L147-L152" + }, + { + "kind": "interface", + "name": { + "name": "LessThanValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "less_than" + } + }, + { + "name": "constraint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L57-L60" + }, + { + "kind": "interface", + "name": { + "name": "ListTypeValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "list_type" + } + }, + { + "name": "constraint", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ScalarValue", + "namespace": "_types" + } + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L67-L70" + }, + { + "kind": "interface", + "name": { + "name": "RegexValidation", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "regex" + } + }, + { + "name": "constraint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L77-L80" + }, + { + "kind": "interface", + "name": { + "name": "SchedulingConfiguration", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "access_control", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ConnectorScheduling", + "namespace": "connector._types" + } + } + }, + { + "name": "full", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ConnectorScheduling", + "namespace": "connector._types" + } + } + }, + { + "name": "incremental", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ConnectorScheduling", + "namespace": "connector._types" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L231-L235" + }, + { + "kind": "interface", + "name": { + "name": "SelectOption", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "label", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "value", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L24-L27" + }, + { + "kind": "interface", + "name": { + "name": "SyncRulesFeature", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "advanced", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FeatureEnabled", + "namespace": "connector._types" + } + } + }, + { + "name": "basic", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FeatureEnabled", + "namespace": "connector._types" + } + } + } + ], + "specLocation": "connector/_types/Connector.ts#L218-L221" + }, + { + "kind": "enum", + "members": [ + { + "name": "canceling" + }, + { + "name": "canceled" + }, + { + "name": "completed" + }, + { + "name": "error" + }, + { + "name": "in_progress" + }, + { + "name": "pending" + }, + { + "name": "suspended" + } + ], + "name": { + "name": "SyncStatus", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L137-L145" + }, + { + "kind": "type_alias", + "name": { + "name": "Validation", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L49-L55", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "LessThanValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GreaterThanValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ListTypeValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IncludedInValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RegexValidation", + "namespace": "connector._types" + } + } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "type" + } + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Updates the last_seen field in the connector, and sets it to current timestamp", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.check_in" + }, + "path": [ + { + "description": "The unique identifier of the connector to be checked in", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/check_in/ConnectorCheckInRequest.ts#L22-L36" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.check_in" + }, + "specLocation": "connector/check_in/ConnectorCheckInResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes a connector.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.delete" + }, + "path": [ + { + "description": "The unique identifier of the connector to be deleted", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L36" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.delete" + }, + "specLocation": "connector/delete/ConnectorDeleteResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves a connector.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.get" + }, + "path": [ + { + "description": "The unique identifier of the connector", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L36" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "Connector", + "namespace": "connector._types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.get" + }, + "specLocation": "connector/get/ConnectorGetResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "last_access_control_sync_error", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + }, + { + "name": "last_access_control_sync_scheduled_at", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_access_control_sync_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncStatus", + "namespace": "connector._types" + } + } + }, + { + "name": "last_deleted_document_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "last_incremental_sync_scheduled_at", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_indexed_document_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "last_seen", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + }, + { + "name": "last_sync_error", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + }, + { + "name": "last_sync_scheduled_at", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "last_sync_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncStatus", + "namespace": "connector._types" + } + } + }, + { + "name": "last_synced", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Updates last sync stats in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.last_sync" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/last_sync/ConnectorUpdateLastSyncRequest.ts#L25-L55" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.last_sync" + }, + "specLocation": "connector/last_sync/ConnectorUpdateLastSyncResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns existing connectors.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.list" + }, + "path": [], + "query": [ + { + "description": "Starting offset (default: 0)", + "name": "from", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Specifies a max number of results to get", + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of connector index names to fetch connector documents for", + "name": "index_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of connector names to fetch connector documents for", + "name": "connector_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of connector service types to fetch connector documents for", + "name": "service_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "description": "A wildcard query string that filters connectors with matching name, description or index name", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/list/ConnectorListRequest.ts#L23-L57" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "results", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Connector", + "namespace": "connector._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.list" + }, + "specLocation": "connector/list/ConnectorListResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "index_name", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + }, + { + "name": "is_native", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "language", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "service_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Creates a connector.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.post" + }, + "path": [], + "query": [], + "specLocation": "connector/post/ConnectorPostRequest.ts#L22-L42" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.post" + }, + "specLocation": "connector/post/ConnectorPostResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "index_name", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + }, + { + "name": "is_native", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "language", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "service_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Creates or updates a connector.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.put" + }, + "path": [ + { + "description": "The unique identifier of the connector to be created or updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/put/ConnectorPutRequest.ts#L23-L49" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.put" + }, + "specLocation": "connector/put/ConnectorPutResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "api_key_id", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + }, + { + "name": "api_key_secret_id", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + } + ] + }, + "description": "Updates the API key id in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_api_key_id" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_api_key_id" + }, + "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "configuration", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ConnectorConfiguration", + "namespace": "connector._types" + } + } + }, + { + "name": "values", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "description": "Updates the configuration field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_configuration" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L47" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_configuration" + }, + "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "error", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + } + ] + }, + "description": "Updates the filtering field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_error" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_error" + }, + "specLocation": "connector/update_error/ConnectorUpdateErrorResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "filtering", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FilteringConfig", + "namespace": "connector._types" + } + } + } + } + ] + }, + "description": "Updates the filtering field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_filtering" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_filtering" + }, + "specLocation": "connector/update_filtering/ConnectorUpdateFilteringResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "index_name", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "WithNullValue", + "namespace": "_spec_utils" + } + } + } + ] + }, + "description": "Updates the index_name in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_index_name" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_index_name" + }, + "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Updates the name and description fields in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_name" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_name/ConnectorUpdateNameRequest.ts#L22-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_name" + }, + "specLocation": "connector/update_name/ConnectorUpdateNameResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "is_native", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Updates the is_native flag in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_native" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_native/ConnectorUpdateNativeRequest.ts#L22-L42" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_native" + }, + "specLocation": "connector/update_native/ConnectorUpdateNativeResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "pipeline", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IngestPipelineParams", + "namespace": "connector._types" + } + } + } + ] + }, + "description": "Updates the pipeline field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_pipeline" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_pipeline" + }, + "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "scheduling", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SchedulingConfiguration", + "namespace": "connector._types" + } + } + } + ] + }, + "description": "Updates the scheduling field in the connector document", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_scheduling" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_scheduling" + }, + "specLocation": "connector/update_scheduling/ConnectorUpdateSchedulingResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "service_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Updates the service type of the connector", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_service_type" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts#L22-L42" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_service_type" + }, + "specLocation": "connector/update_service_type/ConnectorUpdateServiceTypeResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ConnectorStatus", + "namespace": "connector._types" + } + } + } + ] + }, + "description": "Updates the status of the connector", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "connector.update_status" + }, + "path": [ + { + "description": "The unique identifier of the connector to be updated", + "name": "connector_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/update_status/ConnectorUpdateStatusRequest.ts#L23-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "connector.update_status" + }, + "specLocation": "connector/update_status/ConnectorUpdateStatusResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes the specified dangling index", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "dangling_indices.delete_dangling_index" + }, + "path": [ + { + "description": "The UUID of the dangling index", + "name": "index_uuid", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Uuid", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Must be set to true in order to delete the dangling index", + "name": "accept_data_loss", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L37" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "dangling_indices.delete_dangling_index" + }, + "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Imports the specified dangling index", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "dangling_indices.import_dangling_index" + }, + "path": [ + { + "description": "The UUID of the dangling index", + "name": "index_uuid", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Uuid", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Must be set to true in order to import the dangling index", + "name": "accept_data_loss", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L37" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "dangling_indices.import_dangling_index" + }, + "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "DanglingIndex", + "namespace": "dangling_indices.list_dangling_indices" + }, + "properties": [ + { + "name": "index_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "index_uuid", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "creation_date_millis", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + }, + { + "name": "node_ids", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" + } + } + } + ], + "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L29-L34" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns all dangling indices.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "dangling_indices.list_dangling_indices" + }, + "path": [], + "query": [], + "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L26" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "dangling_indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DanglingIndex", + "namespace": "dangling_indices.list_dangling_indices" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "dangling_indices.list_dangling_indices" + }, + "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L23-L27" + }, + { + "kind": "interface", + "name": { + "name": "Policy", + "namespace": "enrich._types" + }, + "properties": [ + { + "name": "enrich_fields", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "name": "indices", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "name": "match_field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "elasticsearch_version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "enrich/_types/Policy.ts#L34-L41" + }, + { + "kind": "enum", + "members": [ + { + "name": "geo_match" + }, + { + "name": "match" + }, + { + "name": "range" + } + ], + "name": { + "name": "PolicyType", + "namespace": "enrich._types" + }, + "specLocation": "enrich/_types/Policy.ts#L28-L32" + }, + { + "kind": "interface", + "name": { + "name": "Summary", + "namespace": "enrich._types" + }, + "properties": [ + { + "name": "config", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "PolicyType", + "namespace": "enrich._types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "Policy", + "namespace": "enrich._types" + } + } + } + } + ], + "specLocation": "enrich/_types/Policy.ts#L24-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an existing enrich policy and its enrich index.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.delete_policy" + }, + "path": [ + { + "description": "Enrich policy to delete.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L23-L36" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "enrich.delete_policy" + }, + "specLocation": "enrich/delete_policy/DeleteEnrichPolicyResponse.ts#L22-L24" + }, + { + "kind": "enum", + "members": [ + { + "name": "SCHEDULED" + }, + { + "name": "RUNNING" + }, + { + "name": "COMPLETE" + }, + { + "name": "FAILED" + } + ], + "name": { + "name": "EnrichPolicyPhase", + "namespace": "enrich.execute_policy" + }, + "specLocation": "enrich/execute_policy/types.ts#L24-L29" + }, + { + "kind": "interface", + "name": { + "name": "ExecuteEnrichPolicyStatus", + "namespace": "enrich.execute_policy" + }, + "properties": [ + { + "name": "phase", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EnrichPolicyPhase", + "namespace": "enrich.execute_policy" + } + } + } + ], + "specLocation": "enrich/execute_policy/types.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Creates the enrich index for an existing enrich policy.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.execute_policy" + }, + "path": [ + { + "description": "Enrich policy to execute.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "If `true`, the request blocks other enrich policy execution requests until complete.", + "name": "wait_for_completion", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExecuteEnrichPolicyStatus", + "namespace": "enrich.execute_policy" + } + } + }, + { + "name": "task_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskId", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "enrich.execute_policy" + }, + "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about an enrich policy.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.get_policy" + }, + "path": [ + { + "description": "Comma-separated list of enrich policy names used to limit the request.\nTo return information for all enrich policies, omit this parameter.", + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L23-L37" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "policies", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Summary", + "namespace": "enrich._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "enrich.get_policy" + }, + "specLocation": "enrich/get_policy/GetEnrichPolicyResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", + "name": "geo_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Policy", + "namespace": "enrich._types" + } + } + }, + { + "description": "Matches enrich data to incoming documents based on a `term` query.", + "name": "match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Policy", + "namespace": "enrich._types" + } + } + }, + { + "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", + "name": "range", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Policy", + "namespace": "enrich._types" + } + } + } + ] + }, + "description": "Creates an enrich policy.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.put_policy" + }, + "path": [ + { + "description": "Name of the enrich policy to create or update.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L52" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "enrich.put_policy" + }, + "specLocation": "enrich/put_policy/PutEnrichPolicyResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "CacheStats", + "namespace": "enrich.stats" + }, + "properties": [ + { + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "hits", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "misses", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "evictions", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "enrich/stats/types.ts#L37-L43" + }, + { + "kind": "interface", + "name": { + "name": "CoordinatorStats", + "namespace": "enrich.stats" + }, + "properties": [ + { + "name": "executed_searches_total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "queue_size", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "remote_requests_current", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "remote_requests_total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "enrich/stats/types.ts#L29-L35" + }, + { + "kind": "interface", + "name": { + "name": "ExecutingPolicy", + "namespace": "enrich.stats" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "task", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskInfo", + "namespace": "tasks._types" + } + } + } + ], + "specLocation": "enrich/stats/types.ts#L24-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns enrich coordinator statistics and information about enrich policies that are currently executing.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.stats" + }, + "path": [], + "query": [], + "specLocation": "enrich/stats/EnrichStatsRequest.ts#L22-L28" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "Objects containing information about each coordinating ingest node for configured enrich processors.", + "name": "coordinator_stats", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CoordinatorStats", + "namespace": "enrich.stats" + } + } } }, { @@ -113060,7 +117444,7 @@ { "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.", "name": "name", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -121217,7 +125601,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L97-L119" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L121-L143" }, { "attachedBehaviors": [ @@ -121284,7 +125668,7 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -121314,6 +125698,45 @@ "namespace": "_types" } } + }, + { + "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", + "name": "allow_auto_create", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", + "name": "ignore_missing_component_templates", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", + "name": "deprecated", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ] }, @@ -121356,9 +125779,34 @@ "namespace": "_builtins" } } + }, + { + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "User defined reason for creating/updating the index template", + "name": "cause", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L36-L95" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L119" }, { "body": { @@ -122005,19 +126453,6 @@ } } }, - { - "description": "If `true`, returns settings in flat format.", - "name": "flat_settings", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an error.", "name": "master_timeout", @@ -122032,32 +126467,30 @@ } }, { - "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", + "description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.", + "name": "order", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.", - "name": "order", + "name": "cause", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L105" + "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L95" }, { "body": { @@ -125305,112 +129738,7 @@ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", - "name": "allow_auto_create", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", - "docId": "avoid-index-pattern-collisions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html#avoid-index-pattern-collisions", - "name": "index_patterns", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - }, - { - "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", - "name": "composed_of", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - }, - { - "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", - "name": "template", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexTemplateMapping", - "namespace": "indices.put_index_template" - } - } - }, - { - "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", - "name": "data_stream", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamVisibility", - "namespace": "indices._types" - } - } - }, - { - "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", - "name": "priority", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", - "name": "_meta", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } - } - } - ] + "kind": "no_body" }, "description": "", "inherits": { @@ -125426,7 +129754,7 @@ }, "path": [ { - "description": "Index or template name to simulate", + "description": "Name of the index to simulate", "name": "name", "required": true, "type": { @@ -125440,20 +129768,7 @@ ], "query": [ { - "description": "If `true`, the template passed in the body is only used if no existing\ntemplates match the same index patterns. If `false`, the simulation uses\nthe template with the highest priority. Note that the template is not\npermanently added or updated in either case; it is only used for the\nsimulation.", - "name": "create", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Period to wait for a connection to the master node. If no response is received\nbefore the timeout expires, the request fails and returns an error.", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -125490,19 +129805,45 @@ } } ], - "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L33-L115" + "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L24-L49" }, { "body": { "kind": "properties", - "properties": [] + "properties": [ + { + "name": "overlapping", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Overlapping", + "namespace": "indices.simulate_template" + } + } + } + }, + { + "name": "template", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Template", + "namespace": "indices.simulate_template" + } + } + } + ] }, "kind": "response", "name": { "name": "Response", "namespace": "indices.simulate_index_template" }, - "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateResponse.ts#L20-L22" + "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateResponse.ts#L25-L30" }, { "kind": "interface", @@ -125544,15 +129885,139 @@ "CommonQueryParameters" ], "body": { - "codegenName": "template", - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexTemplate", - "namespace": "indices._types" + "kind": "properties", + "properties": [ + { + "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", + "name": "allow_auto_create", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", + "docId": "avoid-index-pattern-collisions", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html#avoid-index-pattern-collisions", + "name": "index_patterns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", + "name": "composed_of", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + }, + { + "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "name": "template", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexTemplateMapping", + "namespace": "indices.put_index_template" + } + } + }, + { + "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", + "name": "data_stream", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamVisibility", + "namespace": "indices._types" + } + } + }, + { + "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", + "name": "priority", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } + }, + { + "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", + "name": "ignore_missing_component_templates", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", + "name": "deprecated", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - } + ] }, "description": "Returns the index configuration that would be applied by a particular index template.", "inherits": { @@ -125632,7 +130097,7 @@ } } ], - "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L25-L61" + "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L119" }, { "body": { @@ -128269,6 +132734,28 @@ }, "specLocation": "indices/validate_query/IndicesValidateQueryResponse.ts#L23-L30" }, + { + "description": "The completion result object", + "kind": "interface", + "name": { + "name": "CompletionResult", + "namespace": "inference._types" + }, + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "inference/_types/Results.ts#L59-L64" + }, { "description": "Text Embedding results containing bytes are represented as Dense\nVectors of bytes.", "kind": "type_alias", @@ -128356,9 +132843,37 @@ } } } + }, + { + "name": "completion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CompletionResult", + "namespace": "inference._types" + } + } + } + }, + { + "name": "rerank", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RankedDocument", + "namespace": "inference._types" + } + } + } } ], - "specLocation": "inference/_types/Results.ts#L59-L67", + "specLocation": "inference/_types/Results.ts#L77-L87", "variants": { "kind": "container" } @@ -128451,6 +132966,50 @@ ], "specLocation": "inference/_types/Services.ts#L41-L53" }, + { + "description": "The rerank result object representing a single ranked document\nid: the original index of the document in the request\nscore: the score of the document relative to the query\ntext: Optional, the text of the document, if requested", + "kind": "interface", + "name": { + "name": "RankedDocument", + "namespace": "inference._types" + }, + "properties": [ + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "score", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + }, + { + "name": "text", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "inference/_types/Results.ts#L66-L76" + }, { "kind": "type_alias", "name": { @@ -128529,13 +133088,19 @@ }, { "name": "text_embedding" + }, + { + "name": "rerank" + }, + { + "name": "completion" } ], "name": { "name": "TaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/TaskType.ts#L20-L26" + "specLocation": "inference/_types/TaskType.ts#L20-L28" }, { "description": "The text embedding result object for byte representation", @@ -128682,7 +133247,7 @@ { "description": "The inference Id", "name": "inference_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -128729,6 +133294,18 @@ "body": { "kind": "properties", "properties": [ + { + "description": "Query input, required for rerank task.\nNot required for other tasks.", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "description": "Text input to the model.\nEither a string or an array of strings.", "name": "input", @@ -128808,8 +133385,22 @@ } } ], - "query": [], - "specLocation": "inference/inference/InferenceRequest.ts#L25-L53" + "query": [ + { + "description": "Specifies the amount of time to wait for the inference request to complete.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "inference/inference/InferenceRequest.ts#L26-L66" }, { "body": { @@ -136909,7 +141500,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L239-L252" + "specLocation": "ml/_types/Datafeed.ts#L238-L251" }, { "kind": "enum", @@ -136928,7 +141519,7 @@ "name": "ChunkingMode", "namespace": "ml._types" }, - "specLocation": "ml/_types/Datafeed.ts#L233-L237" + "specLocation": "ml/_types/Datafeed.ts#L232-L236" }, { "kind": "interface", @@ -137531,7 +142122,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L37-L58" + "specLocation": "ml/_types/Datafeed.ts#L36-L57" }, { "kind": "interface", @@ -137789,7 +142380,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L60-L117" + "specLocation": "ml/_types/Datafeed.ts#L59-L116" }, { "kind": "interface", @@ -137835,7 +142426,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L198-L212" + "specLocation": "ml/_types/Datafeed.ts#L197-L211" }, { "kind": "enum", @@ -137857,7 +142448,7 @@ "name": "DatafeedState", "namespace": "ml._types" }, - "specLocation": "ml/_types/Datafeed.ts#L133-L138" + "specLocation": "ml/_types/Datafeed.ts#L132-L137" }, { "kind": "interface", @@ -137942,7 +142533,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L140-L169" + "specLocation": "ml/_types/Datafeed.ts#L139-L168" }, { "kind": "interface", @@ -138051,7 +142642,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L171-L196" + "specLocation": "ml/_types/Datafeed.ts#L170-L195" }, { "kind": "interface", @@ -140302,7 +144893,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L119-L130" + "specLocation": "ml/_types/Datafeed.ts#L118-L129" }, { "kind": "enum", @@ -144566,7 +149157,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L214-L231" + "specLocation": "ml/_types/Datafeed.ts#L213-L230" }, { "kind": "enum", @@ -155965,7 +160556,7 @@ "since": "8.0.0" } }, - "description": "If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.", + "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", "name": "defer_definition_decompression", "required": false, "since": "8.0.0", @@ -155976,9 +160567,28 @@ "namespace": "_builtins" } } + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.8.0" + } + }, + "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", + "name": "wait_for_completion", + "required": false, + "since": "8.8.0", + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L29-L113" + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L29-L124" }, { "body": { @@ -171738,6 +176348,25 @@ } } }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.14.0" + } + }, + "description": "Realm type of the principal for which this API key was created", + "name": "realm_type", + "required": false, + "since": "8.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "description": "Principal for which this API key was created", "name": "username", @@ -171750,6 +176379,25 @@ } } }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.14.0" + } + }, + "description": "The profile uid for the API key owner principal, if requested and if it exists", + "name": "profile_uid", + "required": false, + "since": "8.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "availability": { "serverless": {}, @@ -171837,7 +176485,7 @@ } } ], - "specLocation": "security/_types/ApiKey.ts#L27-L77" + "specLocation": "security/_types/ApiKey.ts#L27-L89" }, { "kind": "interface", @@ -172749,7 +177397,7 @@ }, { "name": "roles", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { @@ -172761,17 +177409,6 @@ } } }, - { - "name": "rules", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "RoleMappingRule", - "namespace": "security._types" - } - } - }, { "name": "role_templates", "required": false, @@ -172785,9 +177422,20 @@ } } } + }, + { + "name": "rules", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RoleMappingRule", + "namespace": "security._types" + } + } } ], - "specLocation": "security/_types/RoleMapping.ts#L25-L31" + "specLocation": "security/_types/RoleMapping.ts#L25-L33" }, { "kind": "interface", @@ -175761,9 +180409,29 @@ "namespace": "_builtins" } } + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.14.0" + } + }, + "description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.", + "name": "with_profile_uid", + "required": false, + "serverDefault": false, + "since": "8.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L79" + "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L86" }, { "body": { @@ -178850,7 +183518,7 @@ } } ], - "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L45" + "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L47" }, { "body": { @@ -179080,7 +183748,7 @@ { "kind": "type_alias", "name": { - "name": "APIKeyAggregate", + "name": "ApiKeyAggregate", "namespace": "security.query_api_keys" }, "specLocation": "security/query_api_keys/types.ts#L123-L140", @@ -179188,7 +183856,7 @@ { "kind": "interface", "name": { - "name": "APIKeyAggregationContainer", + "name": "ApiKeyAggregationContainer", "namespace": "security.query_api_keys" }, "properties": [ @@ -179213,7 +183881,7 @@ "value": { "kind": "instance_of", "type": { - "name": "APIKeyAggregationContainer", + "name": "ApiKeyAggregationContainer", "namespace": "security.query_api_keys" } } @@ -179280,7 +183948,7 @@ "type": { "kind": "instance_of", "type": { - "name": "APIKeyQueryContainer", + "name": "ApiKeyQueryContainer", "namespace": "security.query_api_keys" } } @@ -179294,7 +183962,7 @@ "type": { "kind": "instance_of", "type": { - "name": "APIKeyFiltersAggregation", + "name": "ApiKeyFiltersAggregation", "namespace": "security.query_api_keys" } } @@ -179368,7 +184036,7 @@ }, "kind": "interface", "name": { - "name": "APIKeyFiltersAggregation", + "name": "ApiKeyFiltersAggregation", "namespace": "security.query_api_keys" }, "properties": [ @@ -179381,7 +184049,7 @@ { "kind": "instance_of", "type": { - "name": "APIKeyQueryContainer", + "name": "ApiKeyQueryContainer", "namespace": "security.query_api_keys" } } @@ -179437,7 +184105,7 @@ { "kind": "interface", "name": { - "name": "APIKeyQueryContainer", + "name": "ApiKeyQueryContainer", "namespace": "security.query_api_keys" }, "properties": [ @@ -179684,7 +184352,7 @@ "value": { "kind": "instance_of", "type": { - "name": "APIKeyAggregationContainer", + "name": "ApiKeyAggregationContainer", "namespace": "security.query_api_keys" } } @@ -179697,7 +184365,7 @@ "type": { "kind": "instance_of", "type": { - "name": "APIKeyQueryContainer", + "name": "ApiKeyQueryContainer", "namespace": "security.query_api_keys" } } @@ -179788,9 +184456,49 @@ "namespace": "_builtins" } } + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.14.0" + } + }, + "description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.", + "name": "with_profile_uid", + "required": false, + "serverDefault": false, + "since": "8.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.14.0" + } + }, + "description": "Determines whether aggregation names are prefixed by their respective types in the response.", + "name": "typed_keys", + "required": false, + "serverDefault": false, + "since": "8.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L86" + "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L99" }, { "body": { @@ -179852,7 +184560,7 @@ "value": { "kind": "instance_of", "type": { - "name": "APIKeyAggregate", + "name": "ApiKeyAggregate", "namespace": "security.query_api_keys" } } diff --git a/output/typescript/types.ts b/output/typescript/types.ts index a76fd41813..c695290bf7 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -12058,25 +12058,25 @@ export type InferenceDenseByteVector = byte[] export type InferenceDenseVector = float[] -export interface InferenceInferenceResult { - text_embedding_bytes?: InferenceTextEmbeddingByteResult[] - text_embedding?: InferenceTextEmbeddingResult[] - sparse_embedding?: InferenceSparseEmbeddingResult[] - completion?: InferenceCompletionResult[] - rerank?: InferenceRankedDocument[] -} - -export interface InferenceModelConfig { +export interface InferenceInferenceEndpoint { service: string service_settings: InferenceServiceSettings task_settings: InferenceTaskSettings } -export interface InferenceModelConfigContainer extends InferenceModelConfig { - model_id: string +export interface InferenceInferenceEndpointContainer extends InferenceInferenceEndpoint { + inference_id: string task_type: InferenceTaskType } +export interface InferenceInferenceResult { + text_embedding_bytes?: InferenceTextEmbeddingByteResult[] + text_embedding?: InferenceTextEmbeddingResult[] + sparse_embedding?: InferenceSparseEmbeddingResult[] + completion?: InferenceCompletionResult[] + rerank?: InferenceRankedDocument[] +} + export interface InferenceRankedDocument { index: integer score: float @@ -12103,20 +12103,21 @@ export interface InferenceTextEmbeddingResult { embedding: InferenceDenseVector } -export interface InferenceDeleteModelRequest extends RequestBase { +export interface InferenceDeleteRequest extends RequestBase { task_type?: InferenceTaskType inference_id: Id } -export type InferenceDeleteModelResponse = AcknowledgedResponseBase +export type InferenceDeleteResponse = AcknowledgedResponseBase -export interface InferenceGetModelRequest extends RequestBase { +export interface InferenceGetRequest extends RequestBase { task_type?: InferenceTaskType inference_id?: Id } -export interface InferenceGetModelResponse { - models: InferenceModelConfigContainer[] +export interface InferenceGetResponse { + endpoints: InferenceInferenceEndpointContainer[] + models: InferenceInferenceEndpointContainer[] } export interface InferenceInferenceRequest extends RequestBase { @@ -12132,13 +12133,13 @@ export interface InferenceInferenceRequest extends RequestBase { export type InferenceInferenceResponse = InferenceInferenceResult -export interface InferencePutModelRequest extends RequestBase { +export interface InferencePutRequest extends RequestBase { task_type?: InferenceTaskType inference_id: Id - body?: InferenceModelConfig + body?: InferenceInferenceEndpoint } -export type InferencePutModelResponse = InferenceModelConfigContainer +export type InferencePutResponse = InferenceInferenceEndpointContainer export interface IngestAppendProcessor extends IngestProcessorBase { field: Field diff --git a/specification/_json_spec/inference.delete_model.json b/specification/_json_spec/inference.delete.json similarity index 87% rename from specification/_json_spec/inference.delete_model.json rename to specification/_json_spec/inference.delete.json index 21a79657fd..67f9a43823 100644 --- a/specification/_json_spec/inference.delete_model.json +++ b/specification/_json_spec/inference.delete.json @@ -1,8 +1,8 @@ { - "inference.delete_model": { + "inference.delete": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", - "description": "Delete model in the Inference API" + "description": "Delete an inference endpoint" }, "stability": "experimental", "visibility": "public", @@ -31,7 +31,7 @@ }, "inference_id": { "type": "string", - "description": "The model Id" + "description": "The inference Id" } } } diff --git a/specification/_json_spec/inference.get_model.json b/specification/_json_spec/inference.get.json similarity index 92% rename from specification/_json_spec/inference.get_model.json rename to specification/_json_spec/inference.get.json index 5f76b48e8e..661f696f43 100644 --- a/specification/_json_spec/inference.get_model.json +++ b/specification/_json_spec/inference.get.json @@ -1,8 +1,8 @@ { - "inference.get_model": { + "inference.get": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", - "description": "Get a model in the Inference API" + "description": "Get an inference endpoint" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/inference.inference.json b/specification/_json_spec/inference.inference.json index d7731c3588..6afa0a8ce6 100644 --- a/specification/_json_spec/inference.inference.json +++ b/specification/_json_spec/inference.inference.json @@ -2,7 +2,7 @@ "inference.inference": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", - "description": "Perform inference on a model" + "description": "Perform inference" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/inference.put_model.json b/specification/_json_spec/inference.put.json similarity index 84% rename from specification/_json_spec/inference.put_model.json rename to specification/_json_spec/inference.put.json index b1531eae1e..2c7d3fbf14 100644 --- a/specification/_json_spec/inference.put_model.json +++ b/specification/_json_spec/inference.put.json @@ -1,8 +1,8 @@ { - "inference.put_model": { + "inference.put": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", - "description": "Configure a model for use in the Inference API" + "description": "Configure an inference endpoint for use in the Inference API" }, "stability": "experimental", "visibility": "public", @@ -39,7 +39,7 @@ ] }, "body": { - "description": "The model's task and service settings" + "description": "The inference endpoint's task and service settings" } } } diff --git a/specification/inference/_types/Services.ts b/specification/inference/_types/Services.ts index e2d453b416..96fccb4266 100644 --- a/specification/inference/_types/Services.ts +++ b/specification/inference/_types/Services.ts @@ -21,9 +21,9 @@ import { TaskType } from '../_types/TaskType' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** - * Configuration options when storing the model config + * Configuration options when storing the inference endpoint */ -export class ModelConfig { +export class InferenceEndpoint { /** * The service type */ @@ -33,21 +33,21 @@ export class ModelConfig { */ service_settings: ServiceSettings /** - * Task settings specific to the service and model + * Task settings specific to the service and task type */ task_settings: TaskSettings } /** - * Represents a model as returned by the GET API + * Represents an inference endpoint as returned by the GET API */ -export class ModelConfigContainer extends ModelConfig { +export class InferenceEndpointContainer extends InferenceEndpoint { /** - * The model Id + * The inference Id */ - model_id: string + inference_id: string /** - * The model's task type + * The task type */ task_type: TaskType } diff --git a/specification/inference/delete_model/DeleteModelRequest.ts b/specification/inference/delete/DeleteRequest.ts similarity index 94% rename from specification/inference/delete_model/DeleteModelRequest.ts rename to specification/inference/delete/DeleteRequest.ts index 0eb590d339..690f8a38f3 100644 --- a/specification/inference/delete_model/DeleteModelRequest.ts +++ b/specification/inference/delete/DeleteRequest.ts @@ -22,8 +22,8 @@ import { Id } from '@_types/common' import { TaskType } from '@inference/_types/TaskType' /** - * Delete an inference service model - * @rest_spec_name inference.delete_model + * Delete an inference endpoint + * @rest_spec_name inference.delete * @availability stack since=8.11.0 stability=experimental visibility=public * @availability serverless stability=experimental visibility=public */ diff --git a/specification/inference/delete_model/DeleteModelResponse.ts b/specification/inference/delete/DeleteResponse.ts similarity index 100% rename from specification/inference/delete_model/DeleteModelResponse.ts rename to specification/inference/delete/DeleteResponse.ts diff --git a/specification/inference/get_model/GetModelRequest.ts b/specification/inference/get/GetRequest.ts similarity index 94% rename from specification/inference/get_model/GetModelRequest.ts rename to specification/inference/get/GetRequest.ts index 4fa6f0597e..a37c0a250e 100644 --- a/specification/inference/get_model/GetModelRequest.ts +++ b/specification/inference/get/GetRequest.ts @@ -22,8 +22,8 @@ import { Id } from '@_types/common' import { TaskType } from '@inference/_types/TaskType' /** - * Get an inference service model - * @rest_spec_name inference.get_model + * Get an inference endpoint + * @rest_spec_name inference.get * @availability stack since=8.11.0 stability=experimental visibility=public * @availability serverless stability=experimental visibility=public */ diff --git a/specification/inference/get_model/GetModelResponse.ts b/specification/inference/get/GetResponse.ts similarity index 87% rename from specification/inference/get_model/GetModelResponse.ts rename to specification/inference/get/GetResponse.ts index 3979782732..f2da5c550d 100644 --- a/specification/inference/get_model/GetModelResponse.ts +++ b/specification/inference/get/GetResponse.ts @@ -17,10 +17,10 @@ * under the License. */ -import { ModelConfigContainer } from '@inference/_types/Services' +import { InferenceEndpointContainer } from '@inference/_types/Services' export class Response { body: { - models: Array + endpoints: Array } } diff --git a/specification/inference/inference/InferenceRequest.ts b/specification/inference/inference/InferenceRequest.ts index 5aedcfe1bf..1bca46a44a 100644 --- a/specification/inference/inference/InferenceRequest.ts +++ b/specification/inference/inference/InferenceRequest.ts @@ -54,7 +54,7 @@ export interface Request extends RequestBase { */ query?: string /** - * Text input to the model. + * Inference input. * Either a string or an array of strings. */ input: string | Array diff --git a/specification/inference/put_model/PutModelRequest.ts b/specification/inference/put/PutRequest.ts similarity index 86% rename from specification/inference/put_model/PutModelRequest.ts rename to specification/inference/put/PutRequest.ts index d4c7807e97..6ca1ecc1b3 100644 --- a/specification/inference/put_model/PutModelRequest.ts +++ b/specification/inference/put/PutRequest.ts @@ -19,12 +19,12 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' -import { ModelConfig } from '@inference/_types/Services' +import { InferenceEndpoint } from '@inference/_types/Services' import { TaskType } from '@inference/_types/TaskType' /** - * Create an inference service model - * @rest_spec_name inference.put_model + * Create an inference endpoint + * @rest_spec_name inference.put * @availability stack since=8.11.0 stability=experimental visibility=public * @availability serverless stability=experimental visibility=public */ @@ -39,6 +39,6 @@ export interface Request extends RequestBase { */ inference_id: Id } - /** @codegen_name model_config */ - body: ModelConfig + /** @codegen_name inference_config */ + body: InferenceEndpoint } diff --git a/specification/inference/put_model/PutModelResponse.ts b/specification/inference/put/PutResponse.ts similarity index 88% rename from specification/inference/put_model/PutModelResponse.ts rename to specification/inference/put/PutResponse.ts index ee8a538716..f08fb59869 100644 --- a/specification/inference/put_model/PutModelResponse.ts +++ b/specification/inference/put/PutResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { ModelConfigContainer } from '@inference/_types/Services' +import { InferenceEndpointContainer } from '@inference/_types/Services' export class Response { - body: ModelConfigContainer + body: InferenceEndpointContainer }