@elastic/schemas 0.5.1 → 0.6.0

package/lib/kibana/json/agent-builder.post-agent-builder-converse-async.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-agent-builder-converse-async", "x-api": { "id": "agent-builder.post-agent-builder-converse-async", "name": "post-agent-builder-converse-async", "namespace": "agent-builder" }, "x-method": "POST", "x-path": "/api/agent_builder/converse/async", "x-destructive": true, "type": "object", "properties": { "_execution_mode": { "enum": ["local", "task_manager"], "description": "**Experimental; added in 9.4.0.** define how to execute the agent (local execution or via task_manager)", "x-found-in": "body" }, "action": { "enum": ["regenerate"], "description": "The action to perform. \"regenerate\" re-executes the last round with the original input. Requires conversation_id.", "x-found-in": "body" }, "agent_id": { "type": "string", "description": "The ID of the agent to chat with. Defaults to the default Elastic AI agent.", "x-found-in": "body" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": {}, "description": "Payload of the attachment. Required unless `origin` is provided (content is resolved once at send time)." }, "description": { "type": "string", "description": "Human-readable label for the attachment." }, "group_id": { "type": "string", "description": "Stable identifier for the logical group this attachment belongs to. Attachments sharing the same group_id were submitted together as a single logical entity." }, "hidden": { "type": "boolean", "description": "When true, the attachment will not be displayed in the UI." }, "id": { "type": "string", "description": "Optional id for the attachment." }, "origin": { "type": "string", "description": "Origin string (for example, saved object ID) for by-reference attachments. When provided without `data`, the content is resolved once using the attachment type’s `resolve` hook." }, "type": { "type": "string", "description": "Type of the attachment." } }, "required": ["type"] }, "description": "**Technical Preview; added in 9.3.0.** Optional attachments to send with the message.", "x-found-in": "body" }, "browser_api_tools": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of what the browser API tool does." }, "id": { "type": "string", "description": "Unique identifier for the browser API tool." }, "schema": { "description": "JSON Schema defining the tool parameters (JsonSchema7Type)." } }, "required": ["id", "description", "schema"] }, "description": "Optional browser API tools to be registered as LLM tools with browser.* namespace. These tools execute on the client side.", "x-found-in": "body" }, "capabilities": { "type": "object", "properties": { "visualizations": { "type": "boolean", "description": "When true, allows the agent to render tabular data from tool results as interactive visualizations using custom XML elements in responses." } }, "description": "Controls agent capabilities during conversation. Currently supports visualization rendering for tabular tool results.", "x-found-in": "body" }, "configuration_overrides": { "type": "object", "properties": { "instructions": { "type": "string", "description": "Custom instructions for the agent." }, "tools": { "type": "array", "items": { "type": "object", "properties": { "tool_ids": { "type": "array", "items": { "type": "string" } } }, "required": ["tool_ids"] }, "description": "Tool selection to enable for this execution." } }, "description": "Runtime configuration overrides. These override the stored agent configuration for this execution only.", "x-found-in": "body" }, "connector_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Optional connector ID for the agent to use for model routing. Mutually exclusive with `inference_id`; omit or use only one.", "x-found-in": "body" }, "conversation_id": { "type": "string", "description": "Optional existing conversation ID to continue a previous conversation.", "x-found-in": "body" }, "execution_id": { "type": "string", "description": "Optional client-generated execution ID. Provide it to address this execution later (for example, to abort it). Must be unique; defaults to a server-generated ID.", "x-found-in": "body" }, "inference_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Optional inference endpoint ID for model routing (public alias for the same internal identifier as `connector_id`). Mutually exclusive with `connector_id`.", "x-found-in": "body" }, "input": { "type": "string", "description": "The user input message to send to the agent.", "x-found-in": "body" }, "prompts": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "object", "properties": { "allow": { "type": "boolean" } }, "required": ["allow"] }, { "type": "object", "properties": { "authorized": { "type": "boolean" } }, "required": ["authorized"] }, { "type": "object", "properties": { "answers": { "type": "array", "items": { "type": "object", "properties": { "choice": { "type": "array", "items": { "type": "number" } }, "custom": { "type": "string" }, "skipped": { "type": "boolean" } } } } }, "required": ["answers"] }] }, "description": "Use this field to respond to a `confirmation`, `authorization`, or `ask_user_question` prompt. Send an `allow` boolean to answer a `confirmation` prompt, an `authorized` boolean to answer an `authorization` prompt, or an `answers` array (one entry per question) to answer an `ask_user_question` prompt.", "x-found-in": "body" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-agent-builder-converse-async", "x-api": { "id": "agent-builder.post-agent-builder-converse-async", "name": "post-agent-builder-converse-async", "namespace": "agent-builder" }, "x-method": "POST", "x-path": "/api/agent_builder/converse/async", "x-destructive": true, "x-response-type": ["text/event-stream"], "type": "object", "properties": { "_execution_mode": { "enum": ["local", "task_manager"], "description": "**Experimental; added in 9.4.0.** define how to execute the agent (local execution or via task_manager)", "x-found-in": "body" }, "action": { "enum": ["regenerate"], "description": "The action to perform. \"regenerate\" re-executes the last round with the original input. Requires conversation_id.", "x-found-in": "body" }, "agent_id": { "type": "string", "description": "The ID of the agent to chat with. Defaults to the default Elastic AI agent.", "x-found-in": "body" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": {}, "description": "Payload of the attachment. Required unless `origin` is provided (content is resolved once at send time)." }, "description": { "type": "string", "description": "Human-readable label for the attachment." }, "group_id": { "type": "string", "description": "Stable identifier for the logical group this attachment belongs to. Attachments sharing the same group_id were submitted together as a single logical entity." }, "hidden": { "type": "boolean", "description": "When true, the attachment will not be displayed in the UI." }, "id": { "type": "string", "description": "Optional id for the attachment." }, "origin": { "type": "string", "description": "Origin string (for example, saved object ID) for by-reference attachments. When provided without `data`, the content is resolved once using the attachment type’s `resolve` hook." }, "type": { "type": "string", "description": "Type of the attachment." } }, "required": ["type"] }, "description": "**Technical Preview; added in 9.3.0.** Optional attachments to send with the message.", "x-found-in": "body" }, "browser_api_tools": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of what the browser API tool does." }, "id": { "type": "string", "description": "Unique identifier for the browser API tool." }, "schema": { "description": "JSON Schema defining the tool parameters (JsonSchema7Type)." } }, "required": ["id", "description", "schema"] }, "description": "Optional browser API tools to be registered as LLM tools with browser.* namespace. These tools execute on the client side.", "x-found-in": "body" }, "capabilities": { "type": "object", "properties": { "visualizations": { "type": "boolean", "description": "When true, allows the agent to render tabular data from tool results as interactive visualizations using custom XML elements in responses." } }, "description": "Controls agent capabilities during conversation. Currently supports visualization rendering for tabular tool results.", "x-found-in": "body" }, "configuration_overrides": { "type": "object", "properties": { "instructions": { "type": "string", "description": "Custom instructions for the agent." }, "tools": { "type": "array", "items": { "type": "object", "properties": { "tool_ids": { "type": "array", "items": { "type": "string" } } }, "required": ["tool_ids"] }, "description": "Tool selection to enable for this execution." } }, "description": "Runtime configuration overrides. These override the stored agent configuration for this execution only.", "x-found-in": "body" }, "connector_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Optional connector ID for the agent to use for model routing. Mutually exclusive with `inference_id`; omit or use only one.", "x-found-in": "body" }, "conversation_id": { "type": "string", "description": "Optional existing conversation ID to continue a previous conversation.", "x-found-in": "body" }, "execution_id": { "type": "string", "description": "Optional client-generated execution ID. Provide it to address this execution later (for example, to abort it). Must be unique; defaults to a server-generated ID.", "x-found-in": "body" }, "inference_id": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "Optional inference endpoint ID for model routing (public alias for the same internal identifier as `connector_id`). Mutually exclusive with `connector_id`.", "x-found-in": "body" }, "input": { "type": "string", "description": "The user input message to send to the agent.", "x-found-in": "body" }, "prompts": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "object", "properties": { "allow": { "type": "boolean" } }, "required": ["allow"] }, { "type": "object", "properties": { "authorized": { "type": "boolean" } }, "required": ["authorized"] }, { "type": "object", "properties": { "answers": { "type": "array", "items": { "type": "object", "properties": { "choice": { "type": "array", "items": { "type": "number" } }, "custom": { "type": "string" }, "skipped": { "type": "boolean" } } } } }, "required": ["answers"] }] }, "description": "Use this field to respond to a `confirmation`, `authorization`, or `ask_user_question` prompt. Send an `allow` boolean to answer a `confirmation` prompt, an `authorized` boolean to answer an `authorization` prompt, or an `answers` array (one entry per question) to answer an `ask_user_question` prompt.", "x-found-in": "body" } } }

package/lib/kibana/json/elastic-package-manager-epm.post-fleet-epm-packages.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-epm-packages", "x-api": { "id": "elastic-package-manager-epm.post-fleet-epm-packages", "name": "post-fleet-epm-packages", "namespace": "elastic-package-manager-epm" }, "x-method": "POST", "x-path": "/api/fleet/epm/packages", "x-destructive": true, "type": "object", "properties": { "ignoreMappingUpdateErrors": { "type": "boolean", "description": "When true, ignore mapping update errors during installation", "x-found-in": "query" }, "skipDataStreamRollover": { "type": "boolean", "description": "When true, skip data stream rollover after installation", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-fleet-epm-packages", "x-api": { "id": "elastic-package-manager-epm.post-fleet-epm-packages", "name": "post-fleet-epm-packages", "namespace": "elastic-package-manager-epm" }, "x-method": "POST", "x-path": "/api/fleet/epm/packages", "x-destructive": true, "x-body-format": ["application/gzip", "application/gzip; application/zip"], "x-response-type": ["application/gzip; application/zip", "json"], "type": "object", "properties": { "ignoreMappingUpdateErrors": { "type": "boolean", "description": "When true, ignore mapping update errors during installation", "x-found-in": "query" }, "skipDataStreamRollover": { "type": "boolean", "description": "When true, skip data stream rollover after installation", "x-found-in": "query" } } }

package/lib/kibana/json/saved-objects.post-saved-objects-export.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-saved-objects-export", "x-api": { "id": "saved-objects.post-saved-objects-export", "name": "post-saved-objects-export", "namespace": "saved-objects" }, "x-method": "POST", "x-path": "/api/saved_objects/_export", "x-destructive": true, "x-response-type": "ndjson", "type": "object", "properties": { "excludeExportDetails": { "type": "boolean", "description": "Do not add export details entry at the end of the stream.", "x-found-in": "body" }, "hasReference": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] } }], "x-found-in": "body" }, "includeReferencesDeep": { "type": "boolean", "description": "Includes all of the referenced objects in the exported objects.", "x-found-in": "body" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] }, "description": "A list of objects to export. NOTE: this optional parameter cannot be combined with the `types` option", "x-found-in": "body" }, "search": { "type": "string", "description": "Search for documents to export using the Elasticsearch Simple Query String syntax.", "x-found-in": "body" }, "type": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The saved object types to include in the export. Use `*` to export all the types. Valid options depend on enabled plugins, but may include `visualization`, `dashboard`, `search`, `index-pattern`, `tag`, `config`, `config-global`, `lens`, `map`, `event-annotation-group`, `query`, `url`, `action`, `alert`, `alerting_rule_template`, `apm-indices`, `cases-user-actions`, `cases`, `cases-comments`, `infrastructure-monitoring-log-view`, `ml-trained-model`, `osquery-saved-query`, `osquery-pack`, `osquery-pack-asset`.", "x-found-in": "body" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "post-saved-objects-export", "x-api": { "id": "saved-objects.post-saved-objects-export", "name": "post-saved-objects-export", "namespace": "saved-objects" }, "x-method": "POST", "x-path": "/api/saved_objects/_export", "x-destructive": true, "x-response-type": ["ndjson"], "type": "object", "properties": { "excludeExportDetails": { "type": "boolean", "description": "Do not add export details entry at the end of the stream.", "x-found-in": "body" }, "hasReference": { "oneOf": [{ "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] } }], "x-found-in": "body" }, "includeReferencesDeep": { "type": "boolean", "description": "Includes all of the referenced objects in the exported objects.", "x-found-in": "body" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": ["type", "id"] }, "description": "A list of objects to export. NOTE: this optional parameter cannot be combined with the `types` option", "x-found-in": "body" }, "search": { "type": "string", "description": "Search for documents to export using the Elasticsearch Simple Query String syntax.", "x-found-in": "body" }, "type": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The saved object types to include in the export. Use `*` to export all the types. Valid options depend on enabled plugins, but may include `visualization`, `dashboard`, `search`, `index-pattern`, `tag`, `config`, `config-global`, `lens`, `map`, `event-annotation-group`, `query`, `url`, `action`, `alert`, `alerting_rule_template`, `apm-indices`, `cases-user-actions`, `cases`, `cases-comments`, `infrastructure-monitoring-log-view`, `ml-trained-model`, `osquery-saved-query`, `osquery-pack`, `osquery-pack-asset`.", "x-found-in": "body" } } }

package/lib/kibana/json/security-ai-assistant-api.chat-complete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ChatComplete", "x-api": { "id": "security-ai-assistant-api.chat-complete", "name": "chat-complete", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/chat/complete", "x-destructive": false, "type": "object", "properties": { "content_references_disabled": { "type": "boolean", "description": "If true, the response will not include content references.", "x-found-in": "query" }, "body": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_ChatCompleteProps", "x-found-in": "body", "x-body-root": true } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ChatComplete", "x-api": { "id": "security-ai-assistant-api.chat-complete", "name": "chat-complete", "namespace": "security-ai-assistant-api" }, "x-method": "POST", "x-path": "/api/security_ai_assistant/chat/complete", "x-destructive": false, "x-response-type": ["application/octet-stream"], "type": "object", "properties": { "content_references_disabled": { "type": "boolean", "description": "If true, the response will not include content references.", "x-found-in": "query" }, "body": { "$ref": "./_defs.json#/$defs/Security_AI_Assistant_API_ChatCompleteProps", "x-found-in": "body", "x-body-root": true } } }

package/lib/kibana/json/security-detections-api.export-rules.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportRules", "x-api": { "id": "security-detections-api.export-rules", "name": "export-rules", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/rules/_export", "x-destructive": true, "x-response-type": "ndjson", "type": "object", "properties": { "exclude_export_details": { "type": "boolean", "description": "Determines whether a summary of the exported rules is returned.", "x-found-in": "query" }, "file_name": { "type": "string", "description": "File name for saving the exported rules.\n> info\n> When using cURL to export rules to a file, use the -O and -J options to save the rules to the file name specified in the URL.\n", "x-found-in": "query" }, "body": { "oneOf": [{ "type": "object", "properties": { "objects": { "type": "array", "items": { "type": "object", "properties": { "rule_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleSignatureId" } }, "required": ["rule_id"] }, "description": "Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified." } }, "required": ["objects"] }, { "type": "null" }], "x-found-in": "body", "x-body-root": true } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportRules", "x-api": { "id": "security-detections-api.export-rules", "name": "export-rules", "namespace": "security-detections-api" }, "x-method": "POST", "x-path": "/api/detection_engine/rules/_export", "x-destructive": true, "x-response-type": ["ndjson"], "type": "object", "properties": { "exclude_export_details": { "type": "boolean", "description": "Determines whether a summary of the exported rules is returned.", "x-found-in": "query" }, "file_name": { "type": "string", "description": "File name for saving the exported rules.\n> info\n> When using cURL to export rules to a file, use the -O and -J options to save the rules to the file name specified in the URL.\n", "x-found-in": "query" }, "body": { "oneOf": [{ "type": "object", "properties": { "objects": { "type": "array", "items": { "type": "object", "properties": { "rule_id": { "$ref": "./_defs.json#/$defs/Security_Detections_API_RuleSignatureId" } }, "required": ["rule_id"] }, "description": "Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified." } }, "required": ["objects"] }, { "type": "null" }], "x-found-in": "body", "x-body-root": true } } }

package/lib/kibana/json/security-endpoint-management-api.endpoint-file-download.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "EndpointFileDownload", "x-api": { "id": "security-endpoint-management-api.endpoint-file-download", "name": "endpoint-file-download", "namespace": "security-endpoint-management-api" }, "x-method": "GET", "x-path": "/api/endpoint/action/{action_id}/file/{file_id}/download", "x-destructive": false, "type": "object", "properties": { "action_id": { "type": "string", "description": "The ID of the response action that generated the file.", "x-found-in": "path" }, "file_id": { "type": "string", "description": "The file identifier is constructed in one of two ways:\n- For Elastic Defend agents (`agentType` of `endpoint`): combine the `action_id` and `agent_id` values using a dot (`.`) separator:\n`{file_id}` = `{action_id}.{agent_id}`\n- For all other agent types: the `file_id` is the `agent_id` for which the response action was sent to.\n", "x-found-in": "path" } }, "required": ["action_id", "file_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "EndpointFileDownload", "x-api": { "id": "security-endpoint-management-api.endpoint-file-download", "name": "endpoint-file-download", "namespace": "security-endpoint-management-api" }, "x-method": "GET", "x-path": "/api/endpoint/action/{action_id}/file/{file_id}/download", "x-destructive": false, "x-response-type": ["application/octet-stream"], "type": "object", "properties": { "action_id": { "type": "string", "description": "The ID of the response action that generated the file.", "x-found-in": "path" }, "file_id": { "type": "string", "description": "The file identifier is constructed in one of two ways:\n- For Elastic Defend agents (`agentType` of `endpoint`): combine the `action_id` and `agent_id` values using a dot (`.`) separator:\n`{file_id}` = `{action_id}.{agent_id}`\n- For all other agent types: the `file_id` is the `agent_id` for which the response action was sent to.\n", "x-found-in": "path" } }, "required": ["action_id", "file_id"] }

package/lib/kibana/json/security-endpoint-management-api.endpoint-script-library-download-script.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "EndpointScriptLibraryDownloadScript", "x-api": { "id": "security-endpoint-management-api.endpoint-script-library-download-script", "name": "endpoint-script-library-download-script", "namespace": "security-endpoint-management-api" }, "x-method": "GET", "x-path": "/api/endpoint/scripts_library/{script_id}/download", "x-destructive": false, "type": "object", "properties": { "script_id": { "type": "string", "description": "The ID of the script entry.", "x-found-in": "path" } }, "required": ["script_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "EndpointScriptLibraryDownloadScript", "x-api": { "id": "security-endpoint-management-api.endpoint-script-library-download-script", "name": "endpoint-script-library-download-script", "namespace": "security-endpoint-management-api" }, "x-method": "GET", "x-path": "/api/endpoint/scripts_library/{script_id}/download", "x-destructive": false, "x-response-type": ["application/octet-stream"], "type": "object", "properties": { "script_id": { "type": "string", "description": "The ID of the script entry.", "x-found-in": "path" } }, "required": ["script_id"] }

package/lib/kibana/json/security-exceptions-api.export-exception-list.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportExceptionList", "x-api": { "id": "security-exceptions-api.export-exception-list", "name": "export-exception-list", "namespace": "security-exceptions-api" }, "x-method": "POST", "x-path": "/api/exception_lists/_export", "x-destructive": true, "x-response-type": "ndjson", "type": "object", "properties": { "id": { "$ref": "./_defs.json#/$defs/Security_Exceptions_API_ExceptionListId", "description": "Exception list's internal `id` (UUID) returned on create; use with `list_id` and `namespace_type` for an unambiguous target.", "x-found-in": "query" }, "list_id": { "$ref": "./_defs.json#/$defs/Security_Exceptions_API_ExceptionListHumanId", "description": "Human-readable `list_id` of the exception list to export, as shown in the UI and API responses.", "x-found-in": "query" }, "namespace_type": { "$ref": "./_defs.json#/$defs/Security_Exceptions_API_ExceptionNamespaceType", "description": "`single` exports a list in the current Kibana space; `agnostic` exports a global (space-agnostic) list.\n", "x-found-in": "query" }, "include_expired_exceptions": { "enum": ["true", "false"], "description": "Determines whether to include expired exceptions in the exported list. Expiration date defined by `expire_time`.", "x-found-in": "query" } }, "required": ["id", "list_id", "namespace_type", "include_expired_exceptions"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportExceptionList", "x-api": { "id": "security-exceptions-api.export-exception-list", "name": "export-exception-list", "namespace": "security-exceptions-api" }, "x-method": "POST", "x-path": "/api/exception_lists/_export", "x-destructive": true, "x-response-type": ["ndjson"], "type": "object", "properties": { "id": { "$ref": "./_defs.json#/$defs/Security_Exceptions_API_ExceptionListId", "description": "Exception list's internal `id` (UUID) returned on create; use with `list_id` and `namespace_type` for an unambiguous target.", "x-found-in": "query" }, "list_id": { "$ref": "./_defs.json#/$defs/Security_Exceptions_API_ExceptionListHumanId", "description": "Human-readable `list_id` of the exception list to export, as shown in the UI and API responses.", "x-found-in": "query" }, "namespace_type": { "$ref": "./_defs.json#/$defs/Security_Exceptions_API_ExceptionNamespaceType", "description": "`single` exports a list in the current Kibana space; `agnostic` exports a global (space-agnostic) list.\n", "x-found-in": "query" }, "include_expired_exceptions": { "enum": ["true", "false"], "description": "Determines whether to include expired exceptions in the exported list. Expiration date defined by `expire_time`.", "x-found-in": "query" } }, "required": ["id", "list_id", "namespace_type", "include_expired_exceptions"] }

package/lib/kibana/json/security-lists-api.export-list-items.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportListItems", "x-api": { "id": "security-lists-api.export-list-items", "name": "export-list-items", "namespace": "security-lists-api" }, "x-method": "POST", "x-path": "/api/lists/items/_export", "x-destructive": true, "x-response-type": "ndjson", "type": "object", "properties": { "list_id": { "$ref": "./_defs.json#/$defs/Security_Lists_API_ListId", "description": "Value list's `id` to export.", "x-found-in": "query" } }, "required": ["list_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportListItems", "x-api": { "id": "security-lists-api.export-list-items", "name": "export-list-items", "namespace": "security-lists-api" }, "x-method": "POST", "x-path": "/api/lists/items/_export", "x-destructive": true, "x-response-type": ["ndjson"], "type": "object", "properties": { "list_id": { "$ref": "./_defs.json#/$defs/Security_Lists_API_ListId", "description": "Value list's `id` to export.", "x-found-in": "query" } }, "required": ["list_id"] }

package/lib/kibana/json/security-timeline-api.export-timelines.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportTimelines", "x-api": { "id": "security-timeline-api.export-timelines", "name": "export-timelines", "namespace": "security-timeline-api" }, "x-method": "POST", "x-path": "/api/timeline/_export", "x-destructive": true, "x-response-type": "ndjson", "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the file to export", "x-found-in": "query" }, "ids": { "oneOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "x-found-in": "body" } }, "required": ["file_name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ExportTimelines", "x-api": { "id": "security-timeline-api.export-timelines", "name": "export-timelines", "namespace": "security-timeline-api" }, "x-method": "POST", "x-path": "/api/timeline/_export", "x-destructive": true, "x-response-type": ["ndjson"], "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the file to export", "x-found-in": "query" }, "ids": { "oneOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], "x-found-in": "body" } }, "required": ["file_name"] }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/schemas",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Request and response schemas for all Elastic APIs",
   "main": "lib/cjs/index.js",
   "scripts": {

package/src/cloud/json/get_organization_idp_metadata.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-organization-idp-metadata","x-api":{"id":"organizations.get-organization-idp-metadata","name":"get-organization-idp-metadata","namespace":"organizations"},"x-method":"GET","x-path":"/api/v1/organizations/{organization_id}/idp/metadata.xml","x-destructive":false,"type":"object","properties":{"organization_id":{"type":"string","description":"Identifier for the Organization","x-found-in":"path"}},"required":["organization_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"get-organization-idp-metadata","x-api":{"id":"organizations.get-organization-idp-metadata","name":"get-organization-idp-metadata","namespace":"organizations"},"x-method":"GET","x-path":"/api/v1/organizations/{organization_id}/idp/metadata.xml","x-destructive":false,"x-response-type":["application/xml"],"type":"object","properties":{"organization_id":{"type":"string","description":"Identifier for the Organization","x-found-in":"path"}},"required":["organization_id"]}

package/src/cloud/json/upload_extension.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"upload-extension","x-api":{"id":"extensions.upload-extension","name":"upload-extension","namespace":"extensions"},"x-method":"PUT","x-path":"/api/v1/deployments/extensions/{extension_id}","x-destructive":true,"type":"object","properties":{"extension_id":{"type":"string","description":"Id of an extension","x-found-in":"path"}},"required":["extension_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"upload-extension","x-api":{"id":"extensions.upload-extension","name":"upload-extension","namespace":"extensions"},"x-method":"PUT","x-path":"/api/v1/deployments/extensions/{extension_id}","x-destructive":true,"x-body-format":["multipart"],"type":"object","properties":{"extension_id":{"type":"string","description":"Id of an extension","x-found-in":"path"}},"required":["extension_id"]}

package/src/es/json/_global.reindex.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"_global.reindex__Destination":{"type":"object","properties":{"index":{"type":"string","description":"The name of the data stream, index, or index alias you are copying to."},"op_type":{"$ref":"./_types.json#/$defs/_types__OpType","description":"If it is `create`, the operation will only index documents that do not already exist (also known as \"put if absent\").\n\nIMPORTANT: To reindex to a data stream destination, this argument must be `create`."},"pipeline":{"type":"string","description":"The name of the pipeline to use."},"routing":{"type":"string","description":"By default, a document's routing is preserved unless it's changed by the script.\nIf it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.\nIf it is `discard`, the routing on the bulk request sent for each match is set to `null`.\nIf it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`).\nNot allowed when `index.slice.enabled` is `true` for the destination index; use `_slice` instead."},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The versioning to use for the indexing operation."}},"required":["index"]},"_global.reindex__Source":{"type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"The name of the data stream, index, or alias you are copying from.\nIt accepts a comma-separated list to reindex from multiple sources."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The documents to reindex, which is defined with Query DSL."},"remote":{"$ref":"./_global.reindex.json#/$defs/_global.reindex__RemoteSource","description":"A remote instance of Elasticsearch that you want to index from.","x-availability":{"stack":{"since":"5.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}}},"size":{"type":"number","description":"The number of documents to index per batch.\nUse it when you are indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB."},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Slice the reindex request manually using the provided slice ID and total number of slices."},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"A comma-separated list of `<field>:<direction>` pairs to sort by before indexing.\nUse it in conjunction with `max_docs` to control what documents are reindexed.\n\nWARNING: Sort in reindex is deprecated.\nSorting in reindex was never guaranteed to index documents in order and prevents further development of reindex such as resilience and performance improvements.\nIf used in combination with `max_docs`, consider using a query filter instead.","x-deprecated":{"since":"7.6.0"}},"source_fields":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"If `true`, reindex all source fields.\nSet it to a list to reindex select fields."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields"}},"required":["index"]},"_global.reindex__RemoteSource":{"type":"object","properties":{"connect_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The remote connection timeout."},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"An object containing the headers of the request."},"host":{"type":"string","description":"The URL for the remote instance of Elasticsearch that you want to index from.\nThis information is required when you're indexing from remote."},"username":{"type":"string","description":"The username to use for authentication with the remote host (required when using basic auth)."},"password":{"type":"string","description":"The password to use for authentication with the remote host (required when using basic auth)."},"api_key":{"type":"string","description":"The API key to use for authentication with the remote host (as an alternative to basic auth when the remote cluster is in Elastic Cloud).\n(It is not permitted to set this and also to set an `Authorization` header via `headers`.)","x-availability":{"stack":{"since":"9.3.0"},"serverless":{}}},"socket_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The remote socket read timeout."}},"required":["host"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"_global.reindex__Destination":{"type":"object","properties":{"index":{"type":"string","description":"The name of the data stream, index, or index alias you are copying to."},"op_type":{"$ref":"./_types.json#/$defs/_types__OpType","description":"If it is `create`, the operation will only index documents that do not already exist (also known as \"put if absent\").\n\nIMPORTANT: To reindex to a data stream destination, this argument must be `create`."},"pipeline":{"type":"string","description":"The name of the pipeline to use."},"routing":{"type":"string","description":"By default, a document's routing is preserved unless it's changed by the script.\nIf it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.\nIf it is `discard`, the routing on the bulk request sent for each match is set to `null`.\nIf it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`).\nNot allowed when `index.slice.enabled` is `true` for the destination index; use `_slice` instead."},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The versioning to use for the indexing operation."}},"required":["index"]},"_global.reindex__Source":{"type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"The name of the data stream, index, or alias you are copying from.\nIt accepts a comma-separated list to reindex from multiple sources."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The documents to reindex, which is defined with Query DSL."},"remote":{"$ref":"./_global.reindex.json#/$defs/_global.reindex__RemoteSource","description":"A remote instance of Elasticsearch that you want to index from.","x-availability":{"stack":{"since":"5.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}}},"size":{"type":"number","description":"The number of documents to index per batch.\nUse it when you are indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB."},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Slice the reindex request manually using the provided slice ID and total number of slices."},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"A comma-separated list of `<field>:<direction>` pairs to sort by before indexing.\nUse it in conjunction with `max_docs` to control what documents are reindexed.\n\nWARNING: Sort in reindex is deprecated.\nSorting in reindex was never guaranteed to index documents in order and prevents further development of reindex such as resilience and performance improvements.\nIf used in combination with `max_docs`, consider using a query filter instead.","x-deprecated":{"since":"7.6.0"}},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"If `true`, reindex all source fields.\nSet it to a list to reindex select fields.","x-codegen-name":"source_fields"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields"}},"required":["index"]},"_global.reindex__RemoteSource":{"type":"object","properties":{"connect_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The remote connection timeout."},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"An object containing the headers of the request."},"host":{"type":"string","description":"The URL for the remote instance of Elasticsearch that you want to index from.\nThis information is required when you're indexing from remote."},"username":{"type":"string","description":"The username to use for authentication with the remote host (required when using basic auth)."},"password":{"type":"string","description":"The password to use for authentication with the remote host (required when using basic auth)."},"api_key":{"type":"string","description":"The API key to use for authentication with the remote host (as an alternative to basic auth when the remote cluster is in Elastic Cloud).\n(It is not permitted to set this and also to set an `Authorization` header via `headers`.)","x-availability":{"stack":{"since":"9.3.0"},"serverless":{}}},"socket_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The remote socket read timeout."}},"required":["host"]}}}

package/src/es/json/_global.search._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"_global.search._types__HitsMetadata":{"type":"object","properties":{"total":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TotalHits"},{"type":"number"}],"description":"Total hit count information, present only if `track_total_hits` wasn't `false` in the search request."},"hits":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Hit"}},"max_score":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["hits"]},"_global.search._types__TotalHits":{"type":"object","properties":{"relation":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TotalHitsRelation"},"value":{"type":"number"}},"required":["relation","value"]},"_global.search._types__TotalHitsRelation":{"enum":["eq","gte"]},"_global.search._types__Hit":{"type":"object","properties":{"_index":{"type":"string"},"_id":{"type":"string"},"_score":{"anyOf":[{"type":"number"},{"type":"null"}]},"_explanation":{"$ref":"./_global.explain.json#/$defs/_global.explain__Explanation"},"fields":{"type":"object","additionalProperties":{}},"highlight":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"inner_hits":{"type":"object","additionalProperties":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__InnerHitsResult"}},"matched_queries":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"object","additionalProperties":{"type":"number"}}]},"_nested":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__NestedIdentity"},"_ignored":{"type":"array","items":{"type":"string"}},"ignored_field_values":{"type":"object","additionalProperties":{"type":"array","items":{}}},"_shard":{"type":"string"},"_node":{"type":"string"},"_routing":{"type":"string"},"_source":{},"_rank":{"type":"number"},"_seq_no":{"type":"number"},"_primary_term":{"type":"number"},"_version":{"type":"number"},"sort":{"$ref":"./_types.json#/$defs/_types__SortResults"}},"required":["_index"]},"_global.search._types__InnerHitsResult":{"type":"object","properties":{"hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HitsMetadata"}},"required":["hits"]},"_global.search._types__NestedIdentity":{"type":"object","properties":{"field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"offset":{"type":"number"},"_nested":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__NestedIdentity"}},"required":["field","offset"]},"_global.search._types__Profile":{"type":"object","properties":{"shards":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__ShardProfile"}},"request":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SearchRequestCoordinatorMetadata","description":"When profiling is enabled, the original query source and target indices from the coordinating request."}},"required":["shards"]},"_global.search._types__ShardProfile":{"type":"object","properties":{"aggregations":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfile"}},"cluster":{"type":"string"},"dfs":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsProfile"},"fetch":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FetchProfile"},"id":{"type":"string"},"index":{"type":"string"},"node_id":{"type":"string"},"searches":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SearchProfile"}},"shard_id":{"type":"number"}},"required":["aggregations","cluster","id","index","node_id","searches","shard_id"]},"_global.search._types__AggregationProfile":{"type":"object","properties":{"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationBreakdown"},"description":{"type":"string"},"time_in_nanos":{},"type":{"type":"string"},"debug":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfileDebug"},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfile"}}},"required":["breakdown","description","time_in_nanos","type"]},"_global.search._types__AggregationBreakdown":{"type":"object","properties":{"build_aggregation":{"type":"number"},"build_aggregation_count":{"type":"number"},"build_leaf_collector":{"type":"number"},"build_leaf_collector_count":{"type":"number"},"collect":{"type":"number"},"collect_count":{"type":"number"},"initialize":{"type":"number"},"initialize_count":{"type":"number"},"post_collection":{"type":"number"},"post_collection_count":{"type":"number"},"reduce":{"type":"number"},"reduce_count":{"type":"number"}},"required":["build_aggregation","build_aggregation_count","build_leaf_collector","build_leaf_collector_count","collect","collect_count","initialize","initialize_count","reduce","reduce_count"]},"_global.search._types__AggregationProfileDebug":{"type":"object","properties":{"segments_with_multi_valued_ords":{"type":"number"},"collection_strategy":{"type":"string"},"segments_with_single_valued_ords":{"type":"number"},"total_buckets":{"type":"number"},"built_buckets":{"type":"number"},"result_strategy":{"type":"string"},"has_filter":{"type":"boolean"},"delegate":{"type":"string"},"delegate_debug":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfileDebug"},"chars_fetched":{"type":"number"},"extract_count":{"type":"number"},"extract_ns":{"type":"number"},"values_fetched":{"type":"number"},"collect_analyzed_ns":{"type":"number"},"collect_analyzed_count":{"type":"number"},"surviving_buckets":{"type":"number"},"ordinals_collectors_used":{"type":"number"},"ordinals_collectors_overhead_too_high":{"type":"number"},"string_hashing_collectors_used":{"type":"number"},"numeric_collectors_used":{"type":"number"},"empty_collectors_used":{"type":"number"},"deferred_aggregators":{"type":"array","items":{"type":"string"}},"segments_with_doc_count_field":{"type":"number"},"segments_with_deleted_docs":{"type":"number"},"filters":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfileDelegateDebugFilter"}},"segments_counted":{"type":"number"},"segments_collected":{"type":"number"},"map_reducer":{"type":"string"},"brute_force_used":{"type":"number"},"dynamic_pruning_attempted":{"type":"number"},"dynamic_pruning_used":{"type":"number"},"skipped_due_to_no_data":{"type":"number"}}},"_global.search._types__AggregationProfileDelegateDebugFilter":{"type":"object","properties":{"results_from_metadata":{"type":"number"},"query":{"type":"string"},"specialized_for":{"type":"string"},"segments_counted_in_constant_time":{"type":"number"}}},"_global.search._types__DfsProfile":{"type":"object","properties":{"statistics":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsStatisticsProfile"},"knn":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsKnnProfile"}}}},"_global.search._types__DfsStatisticsProfile":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_nanos":{},"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsStatisticsBreakdown"},"debug":{"type":"object","additionalProperties":{}},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsStatisticsProfile"}}},"required":["type","description","time_in_nanos","breakdown"]},"_global.search._types__DfsStatisticsBreakdown":{"type":"object","properties":{"collection_statistics":{"type":"number"},"collection_statistics_count":{"type":"number"},"create_weight":{"type":"number"},"create_weight_count":{"type":"number"},"rewrite":{"type":"number"},"rewrite_count":{"type":"number"},"term_statistics":{"type":"number"},"term_statistics_count":{"type":"number"}},"required":["collection_statistics","collection_statistics_count","create_weight","create_weight_count","rewrite","rewrite_count","term_statistics","term_statistics_count"]},"_global.search._types__DfsKnnProfile":{"type":"object","properties":{"vector_operations_count":{"type":"number"},"query":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnQueryProfileResult"}},"rewrite_time":{"type":"number"},"collector":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnCollectorResult"}}},"required":["query","rewrite_time","collector"]},"_global.search._types__KnnQueryProfileResult":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_nanos":{},"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnQueryProfileBreakdown"},"debug":{"type":"object","additionalProperties":{}},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnQueryProfileResult"}}},"required":["type","description","time_in_nanos","breakdown"]},"_global.search._types__KnnQueryProfileBreakdown":{"type":"object","properties":{"advance":{"type":"number"},"advance_count":{"type":"number"},"build_scorer":{"type":"number"},"build_scorer_count":{"type":"number"},"compute_max_score":{"type":"number"},"compute_max_score_count":{"type":"number"},"count_weight":{"type":"number"},"count_weight_count":{"type":"number"},"create_weight":{"type":"number"},"create_weight_count":{"type":"number"},"match":{"type":"number"},"match_count":{"type":"number"},"next_doc":{"type":"number"},"next_doc_count":{"type":"number"},"score":{"type":"number"},"score_count":{"type":"number"},"set_min_competitive_score":{"type":"number"},"set_min_competitive_score_count":{"type":"number"},"shallow_advance":{"type":"number"},"shallow_advance_count":{"type":"number"}},"required":["advance","advance_count","build_scorer","build_scorer_count","compute_max_score","compute_max_score_count","count_weight","count_weight_count","create_weight","create_weight_count","match","match_count","next_doc","next_doc_count","score","score_count","set_min_competitive_score","set_min_competitive_score_count","shallow_advance","shallow_advance_count"]},"_global.search._types__KnnCollectorResult":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":"string"},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_nanos":{},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnCollectorResult"}}},"required":["name","reason","time_in_nanos"]},"_global.search._types__FetchProfile":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"time_in_nanos":{},"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FetchProfileBreakdown"},"debug":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FetchProfileDebug"},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FetchProfile"}}},"required":["type","description","time_in_nanos","breakdown"]},"_global.search._types__FetchProfileBreakdown":{"type":"object","properties":{"load_source":{"type":"number"},"load_source_count":{"type":"number"},"load_stored_fields":{"type":"number"},"load_stored_fields_count":{"type":"number"},"next_reader":{"type":"number"},"next_reader_count":{"type":"number"},"process_count":{"type":"number"},"process":{"type":"number"}}},"_global.search._types__FetchProfileDebug":{"type":"object","properties":{"stored_fields":{"type":"array","items":{"type":"string"}},"fast_path":{"type":"number"}}},"_global.search._types__SearchProfile":{"type":"object","properties":{"collector":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Collector"}},"query":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__QueryProfile"}},"rewrite_time":{"type":"number"}},"required":["collector","query","rewrite_time"]},"_global.search._types__Collector":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":"string"},"time_in_nanos":{},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Collector"}}},"required":["name","reason","time_in_nanos"]},"_global.search._types__QueryProfile":{"type":"object","properties":{"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__QueryBreakdown"},"description":{"type":"string"},"time_in_nanos":{},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__QueryProfile"}}},"required":["breakdown","description","time_in_nanos","type"]},"_global.search._types__QueryBreakdown":{"type":"object","properties":{"advance":{"type":"number"},"advance_count":{"type":"number"},"build_scorer":{"type":"number"},"build_scorer_count":{"type":"number"},"create_weight":{"type":"number"},"create_weight_count":{"type":"number"},"match":{"type":"number"},"match_count":{"type":"number"},"shallow_advance":{"type":"number"},"shallow_advance_count":{"type":"number"},"next_doc":{"type":"number"},"next_doc_count":{"type":"number"},"score":{"type":"number"},"score_count":{"type":"number"},"compute_max_score":{"type":"number"},"compute_max_score_count":{"type":"number"},"count_weight":{"type":"number"},"count_weight_count":{"type":"number"},"set_min_competitive_score":{"type":"number"},"set_min_competitive_score_count":{"type":"number"}},"required":["advance","advance_count","build_scorer","build_scorer_count","create_weight","create_weight_count","match","match_count","shallow_advance","shallow_advance_count","next_doc","next_doc_count","score","score_count","compute_max_score","compute_max_score_count","count_weight","count_weight_count","set_min_competitive_score","set_min_competitive_score_count"]},"_global.search._types__SearchRequestCoordinatorMetadata":{"type":"object","properties":{"source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SearchRequestBody","description":"Original query source from the search request (`SearchSourceBuilder` as JSON)."},"indices":{"type":"array","items":{"type":"string"},"description":"Target index expressions from the request (before index resolution)."}},"description":"Coordinator snapshot of the original search request, serialized under `profile.request` when profiling is enabled.\nIntroduced in Elasticsearch 9.5; omitted when the cluster contains mixed-version nodes that do not serialize this metadata."},"_global.search._types__SearchRequestBody":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Defines the aggregations that are run as part of the search request."},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse","description":"Collapses search results the values of the specified field."},"explain":{"type":"boolean","description":"If `true`, the request returns detailed information about score computation as part of a hit."},"ext":{"type":"object","additionalProperties":{},"description":"Configuration of search extensions defined by Elasticsearch plugins."},"from":{"type":"number","description":"The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter."},"highlight":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Highlight","description":"Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results."},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the  response does not include the total number of hits matching the query."},"indices_boost":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"}},"description":"Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score."},"docvalue_fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response."},"knn":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__KnnSearch"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__KnnSearch"}}],"description":"The approximate kNN search to run.","x-availability":{"stack":{"since":"8.4.0"},"serverless":{}}},"rank":{"$ref":"./_types.json#/$defs/_types__RankContainer","description":"The Reciprocal Rank Fusion (RRF) to use.","x-availability":{"stack":{"since":"8.8.0"}}},"min_score":{"type":"number","description":"The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results or results collected by aggregations."},"post_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results."},"profile":{"type":"boolean","description":"Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The search definition using the Query DSL."},"rescore":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Rescore"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Rescore"}}],"description":"Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases."},"retriever":{"$ref":"./_types.json#/$defs/_types__RetrieverContainer","description":"A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.","x-availability":{"stack":{"since":"8.14.0","stability":"stable"},"serverless":{"stability":"stable"}}},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"},"description":"Retrieve a script evaluation (based on different fields) for each hit."},"search_after":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Used to retrieve the next page of hits using a set of sort values from the previous page."},"size":{"type":"number","description":"The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property."},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Split a scrolled search into multiple slices that can be consumed independently."},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"A comma-separated list of <field>:<direction> pairs."},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`."},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response."},"suggest":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Suggester","description":"Defines a suggester that provides similar looking terms based on a provided text."},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early."},"timeout":{"type":"string","description":"The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout."},"track_scores":{"type":"boolean","description":"If `true`, calculate and return document scores, even if the scores are not used for sorting."},"version":{"type":"boolean","description":"If `true`, the request returns the document version as part of a hit."},"seq_no_primary_term":{"type":"boolean","description":"If `true`, the request returns sequence number and primary term of the last modification of each hit."},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response."},"pit":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference","description":"Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `<index>` in the request path."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name."},"stats":{"type":"array","items":{"type":"string"},"description":"The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API."}}},"_global.search._types__InnerHits":{"type":"object","properties":{"name":{"type":"string","description":"The name for the particular inner hit definition in the response.\nUseful when a search request contains multiple inner hits."},"size":{"type":"number","description":"The maximum number of hits to return per `inner_hits`."},"from":{"type":"number","description":"Inner hit starting document offset."},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse"},"docvalue_fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"}},"explain":{"type":"boolean"},"highlight":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Highlight"},"ignore_unmapped":{"type":"boolean"},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"}},"seq_no_primary_term":{"type":"boolean"},"field":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."}},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"}},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"How the inner hits should be sorted per `inner_hits`.\nBy default, inner hits are sorted by score."},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields"},"track_scores":{"type":"boolean"},"version":{"type":"boolean"}}},"_global.search._types__FieldCollapse":{"type":"object","properties":{"field":{"type":"string","description":"The field to collapse the result set on"},"inner_hits":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__InnerHits"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__InnerHits"}}],"description":"The number of inner hits and their sort order"},"max_concurrent_group_searches":{"type":"number","description":"The number of concurrent requests allowed to retrieve the inner_hits per group"},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse"}},"required":["field"]},"_global.search._types__Highlight":{"type":"object","properties":{"type":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterType"},"boundary_chars":{"type":"string","description":"A string that contains each boundary character."},"boundary_max_scan":{"type":"number","description":"How far to scan for boundary characters."},"boundary_scanner":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__BoundaryScanner","description":"Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter."},"boundary_scanner_locale":{"type":"string","description":"Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`."},"force_source":{"type":"boolean","x-deprecated":{"since":"8.8.0"}},"fragmenter":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterFragmenter","description":"Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter."},"fragment_size":{"type":"number","description":"The size of the highlighted fragment in characters."},"highlight_filter":{"type":"boolean"},"highlight_query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default."},"max_fragment_length":{"type":"number"},"max_analyzed_offset":{"type":"number","description":"If set to a non-negative value, highlighting stops at this defined maximum limit.\nThe rest of the text is not processed, thus not highlighted and no error is returned\nThe `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting."},"no_match_size":{"type":"number","description":"The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight."},"number_of_fragments":{"type":"number","description":"The maximum number of fragments to return.\nIf the number of fragments is set to `0`, no fragments are returned.\nInstead, the entire field contents are highlighted and returned.\nThis can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.\nIf `number_of_fragments` is `0`, `fragment_size` is ignored."},"options":{"type":"object","additionalProperties":{}},"order":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterOrder","description":"Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores."},"phrase_limit":{"type":"number","description":"Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter."},"post_tags":{"type":"array","items":{"type":"string"},"description":"Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `<em>` and `</em>` tags."},"pre_tags":{"type":"array","items":{"type":"string"},"description":"Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `<em>` and `</em>` tags."},"require_field_match":{"type":"boolean","description":"By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields."},"tags_schema":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterTagsSchema","description":"Set to `styled` to use the built-in tag schema."},"encoder":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterEncoder"},"fields":{"anyOf":[{"type":"object","additionalProperties":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlightField"}},{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlightField"}}}]}},"required":["fields"]},"_global.search._types__HighlighterType":{"anyOf":[{"enum":["plain","fast_vector","unified"]},{"type":"string"}]},"_global.search._types__BoundaryScanner":{"enum":["chars","sentence","word"]},"_global.search._types__HighlighterFragmenter":{"enum":["simple","span"]},"_global.search._types__HighlighterOrder":{"enum":["score"]},"_global.search._types__HighlighterTagsSchema":{"enum":["styled"]},"_global.search._types__HighlighterEncoder":{"enum":["default","html"]},"_global.search._types__HighlightField":{"type":"object","properties":{"type":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterType"},"boundary_chars":{"type":"string","description":"A string that contains each boundary character."},"boundary_max_scan":{"type":"number","description":"How far to scan for boundary characters."},"boundary_scanner":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__BoundaryScanner","description":"Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter."},"boundary_scanner_locale":{"type":"string","description":"Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`."},"force_source":{"type":"boolean","x-deprecated":{"since":"8.8.0"}},"fragmenter":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterFragmenter","description":"Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter."},"fragment_size":{"type":"number","description":"The size of the highlighted fragment in characters."},"highlight_filter":{"type":"boolean"},"highlight_query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default."},"max_fragment_length":{"type":"number"},"max_analyzed_offset":{"type":"number","description":"If set to a non-negative value, highlighting stops at this defined maximum limit.\nThe rest of the text is not processed, thus not highlighted and no error is returned\nThe `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting."},"no_match_size":{"type":"number","description":"The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight."},"number_of_fragments":{"type":"number","description":"The maximum number of fragments to return.\nIf the number of fragments is set to `0`, no fragments are returned.\nInstead, the entire field contents are highlighted and returned.\nThis can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.\nIf `number_of_fragments` is `0`, `fragment_size` is ignored."},"options":{"type":"object","additionalProperties":{}},"order":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterOrder","description":"Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores."},"phrase_limit":{"type":"number","description":"Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter."},"post_tags":{"type":"array","items":{"type":"string"},"description":"Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `<em>` and `</em>` tags."},"pre_tags":{"type":"array","items":{"type":"string"},"description":"Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `<em>` and `</em>` tags."},"require_field_match":{"type":"boolean","description":"By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields."},"tags_schema":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterTagsSchema","description":"Set to `styled` to use the built-in tag schema."},"fragment_offset":{"type":"number"},"matched_fields":{"$ref":"./_types.json#/$defs/_types__Fields"}}},"_global.search._types__SourceConfig":{"anyOf":[{"type":"boolean"},{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceFilter"}],"description":"Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered."},"_global.search._types__SourceFilter":{"type":"object","properties":{"exclude_vectors":{"type":"boolean","description":"If `true`, vector fields are excluded from the returned source.\n\nThis option takes precedence over `includes`: any vector field will\nremain excluded even if it matches an `includes` rule."},"excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A list of fields to exclude from the returned source."},"includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A list of fields to include in the returned source."}}},"_global.search._types__TrackHits":{"anyOf":[{"type":"boolean"},{"type":"number"}],"description":"Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits."},"_global.search._types__Rescore":{"type":"object","properties":{"window_size":{"type":"number"},"query":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__RescoreQuery"},"learning_to_rank":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__LearningToRank"},"script":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__ScriptRescore"}}},"_global.search._types__RescoreQuery":{"type":"object","properties":{"Query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The query to use for rescoring.\nThis query is only run on the Top-K results returned by the `query` and `post_filter` phases."},"query_weight":{"type":"number","description":"Relative importance of the original query versus the rescore query."},"rescore_query_weight":{"type":"number","description":"Relative importance of the rescore query versus the original query."},"score_mode":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__ScoreMode","description":"Determines how scores are combined."}},"required":["Query"]},"_global.search._types__ScoreMode":{"enum":["avg","max","min","multiply","total"]},"_global.search._types__LearningToRank":{"type":"object","properties":{"model_id":{"type":"string","description":"The unique identifier of the trained model uploaded to Elasticsearch"},"params":{"type":"object","additionalProperties":{},"description":"Named parameters to be passed to the query templates used for feature"}},"required":["model_id"]},"_global.search._types__ScriptRescore":{"type":"object","properties":{"script":{"$ref":"./_types.json#/$defs/_types__Script"}},"required":["script"]},"_global.search._types__Suggester":{"type":"object","additionalProperties":{}},"_global.search._types__PointInTimeReference":{"type":"object","properties":{"id":{"type":"string"},"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration"}},"required":["id"]},"_global.search._types__Suggest":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionSuggest"},{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggest"},{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TermSuggest"}]},"_global.search._types__CompletionSuggest":{"type":"object","properties":{"length":{"type":"number"},"offset":{"type":"number"},"text":{"type":"string"},"options":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionSuggestOption"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionSuggestOption"}}]}},"required":["length","offset","text","options"]},"_global.search._types__CompletionSuggestOption":{"type":"object","properties":{"collate_match":{"type":"boolean"},"contexts":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Context"}}},"fields":{"type":"object","additionalProperties":{}},"_id":{"type":"string"},"_index":{"type":"string"},"_routing":{"type":"string"},"_score":{"type":"number"},"_source":{},"text":{"type":"string"},"score":{"type":"number"}},"required":["text"]},"_global.search._types__Context":{"anyOf":[{"type":"string"},{"$ref":"./_types.json#/$defs/_types__GeoLocation"}],"description":"Text or location that we want similar documents for or a lookup to a document's field for the text."},"_global.search._types__PhraseSuggest":{"type":"object","properties":{"length":{"type":"number"},"offset":{"type":"number"},"text":{"type":"string"},"options":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggestOption"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggestOption"}}]}},"required":["length","offset","text","options"]},"_global.search._types__PhraseSuggestOption":{"type":"object","properties":{"text":{"type":"string"},"score":{"type":"number"},"highlighted":{"type":"string"},"collate_match":{"type":"boolean"}},"required":["text","score"]},"_global.search._types__TermSuggest":{"type":"object","properties":{"length":{"type":"number"},"offset":{"type":"number"},"text":{"type":"string"},"options":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TermSuggestOption"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TermSuggestOption"}}]}},"required":["length","offset","text","options"]},"_global.search._types__TermSuggestOption":{"type":"object","properties":{"text":{"type":"string"},"score":{"type":"number"},"freq":{"type":"number"},"highlighted":{"type":"string"},"collate_match":{"type":"boolean"}},"required":["text","score","freq"]},"_global.search._types__SourceConfigParam":{"anyOf":[{"type":"boolean"},{"$ref":"./_types.json#/$defs/_types__Fields"}],"description":"Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.\nUsed as a query parameter along with the `_source_includes` and `_source_excludes` parameters."}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"_global.search._types__HitsMetadata":{"type":"object","properties":{"total":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TotalHits"},{"type":"number"}],"description":"Total hit count information, present only if `track_total_hits` wasn't `false` in the search request."},"hits":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Hit"}},"max_score":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["hits"]},"_global.search._types__TotalHits":{"type":"object","properties":{"relation":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TotalHitsRelation"},"value":{"type":"number"}},"required":["relation","value"]},"_global.search._types__TotalHitsRelation":{"enum":["eq","gte"]},"_global.search._types__Hit":{"type":"object","properties":{"_index":{"type":"string"},"_id":{"type":"string"},"_score":{"anyOf":[{"type":"number"},{"type":"null"}]},"_explanation":{"$ref":"./_global.explain.json#/$defs/_global.explain__Explanation"},"fields":{"type":"object","additionalProperties":{}},"highlight":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"inner_hits":{"type":"object","additionalProperties":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__InnerHitsResult"}},"matched_queries":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"object","additionalProperties":{"type":"number"}}]},"_nested":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__NestedIdentity"},"_ignored":{"type":"array","items":{"type":"string"}},"ignored_field_values":{"type":"object","additionalProperties":{"type":"array","items":{}}},"_shard":{"type":"string"},"_node":{"type":"string"},"_routing":{"type":"string"},"_source":{},"_rank":{"type":"number"},"_seq_no":{"type":"number"},"_primary_term":{"type":"number"},"_version":{"type":"number"},"sort":{"$ref":"./_types.json#/$defs/_types__SortResults"}},"required":["_index"]},"_global.search._types__InnerHitsResult":{"type":"object","properties":{"hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HitsMetadata"}},"required":["hits"]},"_global.search._types__NestedIdentity":{"type":"object","properties":{"field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"offset":{"type":"number"},"_nested":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__NestedIdentity"}},"required":["field","offset"]},"_global.search._types__Profile":{"type":"object","properties":{"shards":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__ShardProfile"}},"request":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SearchRequestCoordinatorMetadata","description":"When profiling is enabled, the original query source and target indices from the coordinating request."}},"required":["shards"]},"_global.search._types__ShardProfile":{"type":"object","properties":{"aggregations":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfile"}},"cluster":{"type":"string"},"dfs":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsProfile"},"fetch":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FetchProfile"},"id":{"type":"string"},"index":{"type":"string"},"node_id":{"type":"string"},"searches":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SearchProfile"}},"shard_id":{"type":"number"}},"required":["aggregations","cluster","id","index","node_id","searches","shard_id"]},"_global.search._types__AggregationProfile":{"type":"object","properties":{"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationBreakdown"},"description":{"type":"string"},"time_in_nanos":{},"type":{"type":"string"},"debug":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfileDebug"},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfile"}}},"required":["breakdown","description","time_in_nanos","type"]},"_global.search._types__AggregationBreakdown":{"type":"object","properties":{"build_aggregation":{"type":"number"},"build_aggregation_count":{"type":"number"},"build_leaf_collector":{"type":"number"},"build_leaf_collector_count":{"type":"number"},"collect":{"type":"number"},"collect_count":{"type":"number"},"initialize":{"type":"number"},"initialize_count":{"type":"number"},"post_collection":{"type":"number"},"post_collection_count":{"type":"number"},"reduce":{"type":"number"},"reduce_count":{"type":"number"}},"required":["build_aggregation","build_aggregation_count","build_leaf_collector","build_leaf_collector_count","collect","collect_count","initialize","initialize_count","reduce","reduce_count"]},"_global.search._types__AggregationProfileDebug":{"type":"object","properties":{"segments_with_multi_valued_ords":{"type":"number"},"collection_strategy":{"type":"string"},"segments_with_single_valued_ords":{"type":"number"},"total_buckets":{"type":"number"},"built_buckets":{"type":"number"},"result_strategy":{"type":"string"},"has_filter":{"type":"boolean"},"delegate":{"type":"string"},"delegate_debug":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfileDebug"},"chars_fetched":{"type":"number"},"extract_count":{"type":"number"},"extract_ns":{"type":"number"},"values_fetched":{"type":"number"},"collect_analyzed_ns":{"type":"number"},"collect_analyzed_count":{"type":"number"},"surviving_buckets":{"type":"number"},"ordinals_collectors_used":{"type":"number"},"ordinals_collectors_overhead_too_high":{"type":"number"},"string_hashing_collectors_used":{"type":"number"},"numeric_collectors_used":{"type":"number"},"empty_collectors_used":{"type":"number"},"deferred_aggregators":{"type":"array","items":{"type":"string"}},"segments_with_doc_count_field":{"type":"number"},"segments_with_deleted_docs":{"type":"number"},"filters":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__AggregationProfileDelegateDebugFilter"}},"segments_counted":{"type":"number"},"segments_collected":{"type":"number"},"map_reducer":{"type":"string"},"brute_force_used":{"type":"number"},"dynamic_pruning_attempted":{"type":"number"},"dynamic_pruning_used":{"type":"number"},"skipped_due_to_no_data":{"type":"number"}}},"_global.search._types__AggregationProfileDelegateDebugFilter":{"type":"object","properties":{"results_from_metadata":{"type":"number"},"query":{"type":"string"},"specialized_for":{"type":"string"},"segments_counted_in_constant_time":{"type":"number"}}},"_global.search._types__DfsProfile":{"type":"object","properties":{"statistics":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsStatisticsProfile"},"knn":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsKnnProfile"}}}},"_global.search._types__DfsStatisticsProfile":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_nanos":{},"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsStatisticsBreakdown"},"debug":{"type":"object","additionalProperties":{}},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DfsStatisticsProfile"}}},"required":["type","description","time_in_nanos","breakdown"]},"_global.search._types__DfsStatisticsBreakdown":{"type":"object","properties":{"collection_statistics":{"type":"number"},"collection_statistics_count":{"type":"number"},"create_weight":{"type":"number"},"create_weight_count":{"type":"number"},"rewrite":{"type":"number"},"rewrite_count":{"type":"number"},"term_statistics":{"type":"number"},"term_statistics_count":{"type":"number"}},"required":["collection_statistics","collection_statistics_count","create_weight","create_weight_count","rewrite","rewrite_count","term_statistics","term_statistics_count"]},"_global.search._types__DfsKnnProfile":{"type":"object","properties":{"vector_operations_count":{"type":"number"},"query":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnQueryProfileResult"}},"rewrite_time":{"type":"number"},"collector":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnCollectorResult"}}},"required":["query","rewrite_time","collector"]},"_global.search._types__KnnQueryProfileResult":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_nanos":{},"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnQueryProfileBreakdown"},"debug":{"type":"object","additionalProperties":{}},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnQueryProfileResult"}}},"required":["type","description","time_in_nanos","breakdown"]},"_global.search._types__KnnQueryProfileBreakdown":{"type":"object","properties":{"advance":{"type":"number"},"advance_count":{"type":"number"},"build_scorer":{"type":"number"},"build_scorer_count":{"type":"number"},"compute_max_score":{"type":"number"},"compute_max_score_count":{"type":"number"},"count_weight":{"type":"number"},"count_weight_count":{"type":"number"},"create_weight":{"type":"number"},"create_weight_count":{"type":"number"},"match":{"type":"number"},"match_count":{"type":"number"},"next_doc":{"type":"number"},"next_doc_count":{"type":"number"},"score":{"type":"number"},"score_count":{"type":"number"},"set_min_competitive_score":{"type":"number"},"set_min_competitive_score_count":{"type":"number"},"shallow_advance":{"type":"number"},"shallow_advance_count":{"type":"number"}},"required":["advance","advance_count","build_scorer","build_scorer_count","compute_max_score","compute_max_score_count","count_weight","count_weight_count","create_weight","create_weight_count","match","match_count","next_doc","next_doc_count","score","score_count","set_min_competitive_score","set_min_competitive_score_count","shallow_advance","shallow_advance_count"]},"_global.search._types__KnnCollectorResult":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":"string"},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_nanos":{},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__KnnCollectorResult"}}},"required":["name","reason","time_in_nanos"]},"_global.search._types__FetchProfile":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"time_in_nanos":{},"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FetchProfileBreakdown"},"debug":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FetchProfileDebug"},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FetchProfile"}}},"required":["type","description","time_in_nanos","breakdown"]},"_global.search._types__FetchProfileBreakdown":{"type":"object","properties":{"load_source":{"type":"number"},"load_source_count":{"type":"number"},"load_stored_fields":{"type":"number"},"load_stored_fields_count":{"type":"number"},"next_reader":{"type":"number"},"next_reader_count":{"type":"number"},"process_count":{"type":"number"},"process":{"type":"number"}}},"_global.search._types__FetchProfileDebug":{"type":"object","properties":{"stored_fields":{"type":"array","items":{"type":"string"}},"fast_path":{"type":"number"}}},"_global.search._types__SearchProfile":{"type":"object","properties":{"collector":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Collector"}},"query":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__QueryProfile"}},"rewrite_time":{"type":"number"}},"required":["collector","query","rewrite_time"]},"_global.search._types__Collector":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":"string"},"time_in_nanos":{},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Collector"}}},"required":["name","reason","time_in_nanos"]},"_global.search._types__QueryProfile":{"type":"object","properties":{"breakdown":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__QueryBreakdown"},"description":{"type":"string"},"time_in_nanos":{},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__QueryProfile"}}},"required":["breakdown","description","time_in_nanos","type"]},"_global.search._types__QueryBreakdown":{"type":"object","properties":{"advance":{"type":"number"},"advance_count":{"type":"number"},"build_scorer":{"type":"number"},"build_scorer_count":{"type":"number"},"create_weight":{"type":"number"},"create_weight_count":{"type":"number"},"match":{"type":"number"},"match_count":{"type":"number"},"shallow_advance":{"type":"number"},"shallow_advance_count":{"type":"number"},"next_doc":{"type":"number"},"next_doc_count":{"type":"number"},"score":{"type":"number"},"score_count":{"type":"number"},"compute_max_score":{"type":"number"},"compute_max_score_count":{"type":"number"},"count_weight":{"type":"number"},"count_weight_count":{"type":"number"},"set_min_competitive_score":{"type":"number"},"set_min_competitive_score_count":{"type":"number"}},"required":["advance","advance_count","build_scorer","build_scorer_count","create_weight","create_weight_count","match","match_count","shallow_advance","shallow_advance_count","next_doc","next_doc_count","score","score_count","compute_max_score","compute_max_score_count","count_weight","count_weight_count","set_min_competitive_score","set_min_competitive_score_count"]},"_global.search._types__SearchRequestCoordinatorMetadata":{"type":"object","properties":{"source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SearchRequestBody","description":"Original query source from the search request (`SearchSourceBuilder` as JSON)."},"indices":{"type":"array","items":{"type":"string"},"description":"Target index expressions from the request (before index resolution)."}},"description":"Coordinator snapshot of the original search request, serialized under `profile.request` when profiling is enabled.\nIntroduced in Elasticsearch 9.5; omitted when the cluster contains mixed-version nodes that do not serialize this metadata."},"_global.search._types__SearchRequestBody":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Defines the aggregations that are run as part of the search request."},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse","description":"Collapses search results the values of the specified field."},"explain":{"type":"boolean","description":"If `true`, the request returns detailed information about score computation as part of a hit."},"ext":{"type":"object","additionalProperties":{},"description":"Configuration of search extensions defined by Elasticsearch plugins."},"from":{"type":"number","description":"The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter."},"highlight":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Highlight","description":"Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results."},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the  response does not include the total number of hits matching the query."},"indices_boost":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"},"minProperties":1,"maxProperties":1},"description":"Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score."},"docvalue_fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response."},"knn":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__KnnSearch"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__KnnSearch"}}],"description":"The approximate kNN search to run.","x-availability":{"stack":{"since":"8.4.0"},"serverless":{}}},"rank":{"$ref":"./_types.json#/$defs/_types__RankContainer","description":"The Reciprocal Rank Fusion (RRF) to use.","x-availability":{"stack":{"since":"8.8.0"}}},"min_score":{"type":"number","description":"The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results or results collected by aggregations."},"post_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results."},"profile":{"type":"boolean","description":"Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The search definition using the Query DSL."},"rescore":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Rescore"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Rescore"}}],"description":"Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases."},"retriever":{"$ref":"./_types.json#/$defs/_types__RetrieverContainer","description":"A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.","x-availability":{"stack":{"since":"8.14.0","stability":"stable"},"serverless":{"stability":"stable"}}},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"},"description":"Retrieve a script evaluation (based on different fields) for each hit."},"search_after":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Used to retrieve the next page of hits using a set of sort values from the previous page."},"size":{"type":"number","description":"The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property."},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Split a scrolled search into multiple slices that can be consumed independently."},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"A comma-separated list of <field>:<direction> pairs."},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`."},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response."},"suggest":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Suggester","description":"Defines a suggester that provides similar looking terms based on a provided text."},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early."},"timeout":{"type":"string","description":"The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout."},"track_scores":{"type":"boolean","description":"If `true`, calculate and return document scores, even if the scores are not used for sorting."},"version":{"type":"boolean","description":"If `true`, the request returns the document version as part of a hit."},"seq_no_primary_term":{"type":"boolean","description":"If `true`, the request returns sequence number and primary term of the last modification of each hit."},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response."},"pit":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference","description":"Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `<index>` in the request path."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name."},"stats":{"type":"array","items":{"type":"string"},"description":"The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API."}}},"_global.search._types__InnerHits":{"type":"object","properties":{"name":{"type":"string","description":"The name for the particular inner hit definition in the response.\nUseful when a search request contains multiple inner hits."},"size":{"type":"number","description":"The maximum number of hits to return per `inner_hits`."},"from":{"type":"number","description":"Inner hit starting document offset."},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse"},"docvalue_fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"}},"explain":{"type":"boolean"},"highlight":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Highlight"},"ignore_unmapped":{"type":"boolean"},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"}},"seq_no_primary_term":{"type":"boolean"},"field":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."}},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"}},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"How the inner hits should be sorted per `inner_hits`.\nBy default, inner hits are sorted by score."},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields"},"track_scores":{"type":"boolean"},"version":{"type":"boolean"}}},"_global.search._types__FieldCollapse":{"type":"object","properties":{"field":{"type":"string","description":"The field to collapse the result set on"},"inner_hits":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__InnerHits"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__InnerHits"}}],"description":"The number of inner hits and their sort order"},"max_concurrent_group_searches":{"type":"number","description":"The number of concurrent requests allowed to retrieve the inner_hits per group"},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse"}},"required":["field"]},"_global.search._types__Highlight":{"type":"object","properties":{"type":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterType"},"boundary_chars":{"type":"string","description":"A string that contains each boundary character."},"boundary_max_scan":{"type":"number","description":"How far to scan for boundary characters."},"boundary_scanner":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__BoundaryScanner","description":"Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter."},"boundary_scanner_locale":{"type":"string","description":"Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`."},"force_source":{"type":"boolean","x-deprecated":{"since":"8.8.0"}},"fragmenter":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterFragmenter","description":"Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter."},"fragment_size":{"type":"number","description":"The size of the highlighted fragment in characters."},"highlight_filter":{"type":"boolean"},"highlight_query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default."},"max_fragment_length":{"type":"number"},"max_analyzed_offset":{"type":"number","description":"If set to a non-negative value, highlighting stops at this defined maximum limit.\nThe rest of the text is not processed, thus not highlighted and no error is returned\nThe `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting."},"no_match_size":{"type":"number","description":"The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight."},"number_of_fragments":{"type":"number","description":"The maximum number of fragments to return.\nIf the number of fragments is set to `0`, no fragments are returned.\nInstead, the entire field contents are highlighted and returned.\nThis can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.\nIf `number_of_fragments` is `0`, `fragment_size` is ignored."},"options":{"type":"object","additionalProperties":{}},"order":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterOrder","description":"Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores."},"phrase_limit":{"type":"number","description":"Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter."},"post_tags":{"type":"array","items":{"type":"string"},"description":"Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `<em>` and `</em>` tags."},"pre_tags":{"type":"array","items":{"type":"string"},"description":"Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `<em>` and `</em>` tags."},"require_field_match":{"type":"boolean","description":"By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields."},"tags_schema":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterTagsSchema","description":"Set to `styled` to use the built-in tag schema."},"encoder":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterEncoder"},"fields":{"anyOf":[{"type":"object","additionalProperties":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlightField"},"minProperties":1,"maxProperties":1},{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlightField"},"minProperties":1,"maxProperties":1}}]}},"required":["fields"]},"_global.search._types__HighlighterType":{"anyOf":[{"enum":["plain","fvh","unified"]},{"type":"string"}],"x-codegen-names":{"fvh":"fast_vector"}},"_global.search._types__BoundaryScanner":{"enum":["chars","sentence","word"]},"_global.search._types__HighlighterFragmenter":{"enum":["simple","span"]},"_global.search._types__HighlighterOrder":{"enum":["score"]},"_global.search._types__HighlighterTagsSchema":{"enum":["styled"]},"_global.search._types__HighlighterEncoder":{"enum":["default","html"]},"_global.search._types__HighlightField":{"type":"object","properties":{"type":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterType"},"boundary_chars":{"type":"string","description":"A string that contains each boundary character."},"boundary_max_scan":{"type":"number","description":"How far to scan for boundary characters."},"boundary_scanner":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__BoundaryScanner","description":"Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter."},"boundary_scanner_locale":{"type":"string","description":"Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`."},"force_source":{"type":"boolean","x-deprecated":{"since":"8.8.0"}},"fragmenter":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterFragmenter","description":"Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter."},"fragment_size":{"type":"number","description":"The size of the highlighted fragment in characters."},"highlight_filter":{"type":"boolean"},"highlight_query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default."},"max_fragment_length":{"type":"number"},"max_analyzed_offset":{"type":"number","description":"If set to a non-negative value, highlighting stops at this defined maximum limit.\nThe rest of the text is not processed, thus not highlighted and no error is returned\nThe `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting."},"no_match_size":{"type":"number","description":"The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight."},"number_of_fragments":{"type":"number","description":"The maximum number of fragments to return.\nIf the number of fragments is set to `0`, no fragments are returned.\nInstead, the entire field contents are highlighted and returned.\nThis can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.\nIf `number_of_fragments` is `0`, `fragment_size` is ignored."},"options":{"type":"object","additionalProperties":{}},"order":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterOrder","description":"Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores."},"phrase_limit":{"type":"number","description":"Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter."},"post_tags":{"type":"array","items":{"type":"string"},"description":"Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `<em>` and `</em>` tags."},"pre_tags":{"type":"array","items":{"type":"string"},"description":"Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `<em>` and `</em>` tags."},"require_field_match":{"type":"boolean","description":"By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields."},"tags_schema":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HighlighterTagsSchema","description":"Set to `styled` to use the built-in tag schema."},"fragment_offset":{"type":"number"},"matched_fields":{"$ref":"./_types.json#/$defs/_types__Fields"}}},"_global.search._types__SourceConfig":{"anyOf":[{"type":"boolean"},{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceFilter"}],"description":"Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered."},"_global.search._types__SourceFilter":{"type":"object","properties":{"exclude_vectors":{"type":"boolean","description":"If `true`, vector fields are excluded from the returned source.\n\nThis option takes precedence over `includes`: any vector field will\nremain excluded even if it matches an `includes` rule."},"excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A list of fields to exclude from the returned source."},"includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A list of fields to include in the returned source."}}},"_global.search._types__TrackHits":{"anyOf":[{"type":"boolean"},{"type":"number"}],"description":"Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits."},"_global.search._types__Rescore":{"type":"object","properties":{"window_size":{"type":"number"},"query":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__RescoreQuery"},"learning_to_rank":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__LearningToRank"},"script":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__ScriptRescore"}}},"_global.search._types__RescoreQuery":{"type":"object","properties":{"rescore_query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The query to use for rescoring.\nThis query is only run on the Top-K results returned by the `query` and `post_filter` phases.","x-codegen-name":"Query"},"query_weight":{"type":"number","description":"Relative importance of the original query versus the rescore query."},"rescore_query_weight":{"type":"number","description":"Relative importance of the rescore query versus the original query."},"score_mode":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__ScoreMode","description":"Determines how scores are combined."}},"required":["rescore_query"]},"_global.search._types__ScoreMode":{"enum":["avg","max","min","multiply","total"]},"_global.search._types__LearningToRank":{"type":"object","properties":{"model_id":{"type":"string","description":"The unique identifier of the trained model uploaded to Elasticsearch"},"params":{"type":"object","additionalProperties":{},"description":"Named parameters to be passed to the query templates used for feature"}},"required":["model_id"]},"_global.search._types__ScriptRescore":{"type":"object","properties":{"script":{"$ref":"./_types.json#/$defs/_types__Script"}},"required":["script"]},"_global.search._types__Suggester":{"type":"object","x-behavior":"AdditionalProperties","properties":{"text":{"type":"string","description":"Global suggest text, to avoid repetition when the same text is used in several suggesters"}},"additionalProperties":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldSuggester","description":"The named suggesters"}},"_global.search._types__FieldSuggester":{"type":"object","properties":{"completion":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionSuggester","description":"Provides auto-complete/search-as-you-type functionality."},"phrase":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggester","description":"Provides access to word alternatives on a per token basis within a certain string distance."},"term":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TermSuggester","description":"Suggests terms based on edit distance."},"prefix":{"type":"string","description":"Prefix used to search for suggestions."},"regex":{"type":"string","description":"A prefix expressed as a regular expression."},"text":{"type":"string","description":"The text to use as input for the suggester.\nNeeds to be set globally or per suggestion."}}},"_global.search._types__CompletionSuggester":{"type":"object","properties":{"field":{"type":"string","description":"The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion."},"analyzer":{"type":"string","description":"The analyzer to analyze the suggest text with.\nDefaults to the search analyzer of the suggest field."},"size":{"type":"number","description":"The maximum corrections to be returned per suggest text token."},"contexts":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionContext"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionContext"}}]},"description":"A value, geo point object, or a geo hash string to filter or boost the suggestion on."},"fuzzy":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SuggestFuzziness","description":"Enables fuzziness, meaning you can have a typo in your search and still get results back."},"regex":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__RegexOptions","description":"A regex query that expresses a prefix as a regular expression."},"skip_duplicates":{"type":"boolean","description":"Whether duplicate suggestions should be filtered out."}},"required":["field"]},"_global.search._types__CompletionContext":{"type":"object","properties":{"boost":{"type":"number","description":"The factor by which the score of the suggestion should be boosted.\nThe score is computed by multiplying the boost with the suggestion weight."},"context":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Context","description":"The value of the category to filter/boost on."},"neighbours":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__GeoHashPrecision"},"description":"An array of precision values at which neighboring geohashes should be taken into account.\nPrecision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`).\nDefaults to generating neighbors for index time precision level."},"precision":{"$ref":"./_types.json#/$defs/_types__GeoHashPrecision","description":"The precision of the geohash to encode the query geo point.\nCan be specified as a distance value (`5m`, `10km`, etc.), or as a raw geohash precision (`1`..`12`).\nDefaults to index time precision level."},"prefix":{"type":"boolean","description":"Whether the category value should be treated as a prefix or not."}},"required":["context"]},"_global.search._types__Context":{"anyOf":[{"type":"string"},{"$ref":"./_types.json#/$defs/_types__GeoLocation"}],"description":"Text or location that we want similar documents for or a lookup to a document's field for the text."},"_global.search._types__SuggestFuzziness":{"type":"object","properties":{"fuzziness":{"$ref":"./_types.json#/$defs/_types__Fuzziness","description":"The fuzziness factor."},"min_length":{"type":"number","description":"Minimum length of the input before fuzzy suggestions are returned."},"prefix_length":{"type":"number","description":"Minimum length of the input, which is not checked for fuzzy alternatives."},"transpositions":{"type":"boolean","description":"If set to `true`, transpositions are counted as one change instead of two."},"unicode_aware":{"type":"boolean","description":"If `true`, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes.\nThis is slightly slower than raw bytes."}}},"_global.search._types__RegexOptions":{"type":"object","properties":{"flags":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"Optional operators for the regular expression."},"max_determinized_states":{"type":"number","description":"Maximum number of automaton states required for the query."}}},"_global.search._types__PhraseSuggester":{"type":"object","properties":{"field":{"type":"string","description":"The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion."},"analyzer":{"type":"string","description":"The analyzer to analyze the suggest text with.\nDefaults to the search analyzer of the suggest field."},"size":{"type":"number","description":"The maximum corrections to be returned per suggest text token."},"collate":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggestCollate","description":"Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index."},"confidence":{"type":"number","description":"Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.\nOnly candidates that score higher than the threshold will be included in the result."},"direct_generator":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__DirectGenerator"},"description":"A list of candidate generators that produce a list of possible terms per term in the given text."},"force_unigrams":{"type":"boolean"},"gram_size":{"type":"number","description":"Sets max size of the n-grams (shingles) in the field.\nIf the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.\nIf the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set."},"highlight":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggestHighlight","description":"Sets up suggestion highlighting.\nIf not provided, no highlighted field is returned."},"max_errors":{"type":"number","description":"The maximum percentage of the terms considered to be misspellings in order to form a correction.\nThis method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms."},"real_word_error_likelihood":{"type":"number","description":"The likelihood of a term being misspelled even if the term exists in the dictionary."},"separator":{"type":"string","description":"The separator that is used to separate terms in the bigram field.\nIf not set, the whitespace character is used as a separator."},"shard_size":{"type":"number","description":"Sets the maximum number of suggested terms to be retrieved from each individual shard."},"smoothing":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SmoothingModelContainer","description":"The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).\nThe default model is Stupid Backoff."},"token_limit":{"type":"number"}},"required":["field"]},"_global.search._types__PhraseSuggestCollate":{"type":"object","properties":{"params":{"type":"object","additionalProperties":{},"description":"Parameters to use if the query is templated."},"prune":{"type":"boolean","description":"Returns all suggestions with an extra `collate_match` option indicating whether the generated phrase matched any document."},"query":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggestCollateQuery","description":"A collate query that is run once for every suggestion."}},"required":["query"]},"_global.search._types__PhraseSuggestCollateQuery":{"type":"object","properties":{"id":{"type":"string","description":"The search template ID."},"source":{"$ref":"./_types.json#/$defs/_types__ScriptSource","description":"The query source."}}},"_global.search._types__DirectGenerator":{"type":"object","properties":{"field":{"type":"string","description":"The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion."},"max_edits":{"type":"number","description":"The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.\nCan only be `1` or `2`."},"max_inspections":{"type":"number","description":"A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.\nCan improve accuracy at the cost of performance."},"max_term_freq":{"type":"number","description":"The maximum threshold in number of documents in which a suggest text token can exist in order to be included.\nThis can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.\nCan be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.\nIf a value higher than 1 is specified, then fractional can not be specified."},"min_doc_freq":{"type":"number","description":"The minimal threshold in number of documents a suggestion should appear in.\nThis can improve quality by only suggesting high frequency terms.\nCan be specified as an absolute number or as a relative percentage of number of documents.\nIf a value higher than 1 is specified, the number cannot be fractional."},"min_word_length":{"type":"number","description":"The minimum length a suggest text term must have in order to be included."},"post_filter":{"type":"string","description":"A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer."},"pre_filter":{"type":"string","description":"A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.\nThis filter is applied to the original token before candidates are generated."},"prefix_length":{"type":"number","description":"The number of minimal prefix characters that must match in order be a candidate suggestions.\nIncreasing this number improves spellcheck performance."},"size":{"type":"number","description":"The maximum corrections to be returned per suggest text token."},"suggest_mode":{"$ref":"./_types.json#/$defs/_types__SuggestMode","description":"Controls what suggestions are included on the suggestions generated on each shard."}},"required":["field"]},"_global.search._types__PhraseSuggestHighlight":{"type":"object","properties":{"post_tag":{"type":"string","description":"Use in conjunction with `pre_tag` to define the HTML tags to use for the highlighted text."},"pre_tag":{"type":"string","description":"Use in conjunction with `post_tag` to define the HTML tags to use for the highlighted text."}},"required":["post_tag","pre_tag"]},"_global.search._types__SmoothingModelContainer":{"type":"object","properties":{"laplace":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__LaplaceSmoothingModel","description":"A smoothing model that uses an additive smoothing where a constant (typically `1.0` or smaller) is added to all counts to balance weights."},"linear_interpolation":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__LinearInterpolationSmoothingModel","description":"A smoothing model that takes the weighted mean of the unigrams, bigrams, and trigrams based on user supplied weights (lambdas)."},"stupid_backoff":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__StupidBackoffSmoothingModel","description":"A simple backoff model that backs off to lower order n-gram models if the higher order count is `0` and discounts the lower order n-gram model by a constant factor."}}},"_global.search._types__LaplaceSmoothingModel":{"type":"object","properties":{"alpha":{"type":"number","description":"A constant that is added to all counts to balance weights."}},"required":["alpha"]},"_global.search._types__LinearInterpolationSmoothingModel":{"type":"object","properties":{"bigram_lambda":{"type":"number"},"trigram_lambda":{"type":"number"},"unigram_lambda":{"type":"number"}},"required":["bigram_lambda","trigram_lambda","unigram_lambda"]},"_global.search._types__StupidBackoffSmoothingModel":{"type":"object","properties":{"discount":{"type":"number","description":"A constant factor that the lower order n-gram model is discounted by."}},"required":["discount"]},"_global.search._types__TermSuggester":{"type":"object","properties":{"field":{"type":"string","description":"The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion."},"analyzer":{"type":"string","description":"The analyzer to analyze the suggest text with.\nDefaults to the search analyzer of the suggest field."},"size":{"type":"number","description":"The maximum corrections to be returned per suggest text token."},"lowercase_terms":{"type":"boolean"},"max_edits":{"type":"number","description":"The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.\nCan only be `1` or `2`."},"max_inspections":{"type":"number","description":"A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.\nCan improve accuracy at the cost of performance."},"max_term_freq":{"type":"number","description":"The maximum threshold in number of documents in which a suggest text token can exist in order to be included.\nCan be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.\nIf a value higher than 1 is specified, then fractional can not be specified."},"min_doc_freq":{"type":"number","description":"The minimal threshold in number of documents a suggestion should appear in.\nThis can improve quality by only suggesting high frequency terms.\nCan be specified as an absolute number or as a relative percentage of number of documents.\nIf a value higher than 1 is specified, then the number cannot be fractional."},"min_word_length":{"type":"number","description":"The minimum length a suggest text term must have in order to be included."},"prefix_length":{"type":"number","description":"The number of minimal prefix characters that must match in order be a candidate for suggestions.\nIncreasing this number improves spellcheck performance."},"shard_size":{"type":"number","description":"Sets the maximum number of suggestions to be retrieved from each individual shard."},"sort":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SuggestSort","description":"Defines how suggestions should be sorted per suggest text term."},"string_distance":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__StringDistance","description":"The string distance implementation to use for comparing how similar suggested terms are."},"suggest_mode":{"$ref":"./_types.json#/$defs/_types__SuggestMode","description":"Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested."}},"required":["field"]},"_global.search._types__SuggestSort":{"enum":["score","frequency"]},"_global.search._types__StringDistance":{"enum":["internal","damerau_levenshtein","levenshtein","jaro_winkler","ngram"]},"_global.search._types__PointInTimeReference":{"type":"object","properties":{"id":{"type":"string"},"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration"}},"required":["id"]},"_global.search._types__Suggest":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionSuggest"},{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggest"},{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TermSuggest"}]},"_global.search._types__CompletionSuggest":{"type":"object","properties":{"length":{"type":"number"},"offset":{"type":"number"},"text":{"type":"string"},"options":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionSuggestOption"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__CompletionSuggestOption"}}]}},"required":["length","offset","text","options"]},"_global.search._types__CompletionSuggestOption":{"type":"object","properties":{"collate_match":{"type":"boolean"},"contexts":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Context"}}},"fields":{"type":"object","additionalProperties":{}},"_id":{"type":"string"},"_index":{"type":"string"},"_routing":{"type":"string"},"_score":{"type":"number"},"_source":{},"text":{"type":"string"},"score":{"type":"number"}},"required":["text"]},"_global.search._types__PhraseSuggest":{"type":"object","properties":{"length":{"type":"number"},"offset":{"type":"number"},"text":{"type":"string"},"options":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggestOption"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PhraseSuggestOption"}}]}},"required":["length","offset","text","options"]},"_global.search._types__PhraseSuggestOption":{"type":"object","properties":{"text":{"type":"string"},"score":{"type":"number"},"highlighted":{"type":"string"},"collate_match":{"type":"boolean"}},"required":["text","score"]},"_global.search._types__TermSuggest":{"type":"object","properties":{"length":{"type":"number"},"offset":{"type":"number"},"text":{"type":"string"},"options":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TermSuggestOption"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TermSuggestOption"}}]}},"required":["length","offset","text","options"]},"_global.search._types__TermSuggestOption":{"type":"object","properties":{"text":{"type":"string"},"score":{"type":"number"},"freq":{"type":"number"},"highlighted":{"type":"string"},"collate_match":{"type":"boolean"}},"required":["text","score","freq"]},"_global.search._types__SourceConfigParam":{"anyOf":[{"type":"boolean"},{"$ref":"./_types.json#/$defs/_types__Fields"}],"description":"Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.\nUsed as a query parameter along with the `_source_includes` and `_source_excludes` parameters."}}}