@elastic/schemas 0.4.4 → 0.5.0

package/lib/cjs/es/json/indices.put_index_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_index_template", "type": "object", "properties": { "index_patterns": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "x-found-in": "body" }, "composed_of": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", "x-found-in": "body" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", "x-found-in": "body" }, "data_stream": { "$ref": "./indices._types.json#/$defs/indices._types__DataStreamVisibility", "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", "x-found-in": "body" }, "priority": { "type": "number", "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", "x-found-in": "body" }, "allow_auto_create": { "type": "boolean", "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", "x-found-in": "body" }, "ignore_missing_component_templates": { "type": "array", "items": { "type": "string" }, "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing index templates.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for creating or updating the index template", "x-found-in": "query" }, "name": { "type": "string", "description": "Index or template name", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update an index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_index_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing index templates.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for creating or updating the index template", "x-found-in": "query" }, "index_patterns": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "x-found-in": "body" }, "composed_of": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", "x-found-in": "body" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", "x-found-in": "body" }, "data_stream": { "$ref": "./indices._types.json#/$defs/indices._types__DataStreamVisibility", "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", "x-found-in": "body" }, "priority": { "type": "number", "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", "x-found-in": "body" }, "allow_auto_create": { "type": "boolean", "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", "x-found-in": "body" }, "ignore_missing_component_templates": { "type": "array", "items": { "type": "string" }, "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "name": { "type": "string", "description": "Index or template name", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update an index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition." }

package/lib/cjs/es/json/indices.put_mapping.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_mapping", "type": "object", "properties": { "date_detection": { "type": "boolean", "description": "Controls whether dynamic date detection is enabled.", "x-found-in": "body" }, "dynamic": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__DynamicMapping", "description": "Controls whether new fields are added dynamically.", "x-found-in": "body" }, "dynamic_date_formats": { "type": "array", "items": { "type": "string" }, "description": "If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.", "x-found-in": "body" }, "dynamic_templates": { "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__DynamicTemplate" } }, "description": "Specify dynamic templates for the mapping.", "x-found-in": "body" }, "_field_names": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__FieldNamesField", "description": "Control whether field names are enabled for the index.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.", "x-found-in": "body" }, "numeric_detection": { "type": "boolean", "description": "Automatically map strings into numeric data types for all fields.", "x-found-in": "body" }, "properties": { "type": "object", "additionalProperties": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__Property" }, "description": "Mapping for a field. For new fields, this mapping can include:\n\n- Field name\n- Field data type\n- Mapping parameters", "x-found-in": "body" }, "_routing": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RoutingField", "description": "Enable making a routing value required on indexed documents.", "x-found-in": "body" }, "_source": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__SourceField", "description": "Control whether the _source field is enabled on the index.", "x-found-in": "body" }, "runtime": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Mapping of runtime fields for the index.", "x-found-in": "body" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "write_index_only": { "type": "boolean", "description": "If `true`, the mappings are applied only to the current write index for the target.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names the mapping should be added to (supports wildcards).\nUse `_all` or omit to add the mapping on all indices.", "x-found-in": "path" } }, "required": ["index"], "description": "Update field mappings.\n\nAdd new fields to an existing data stream or index.\nYou can use the update mapping API to:\n\n- Add a new field to an existing index\n- Update mappings for multiple indices in a single request\n- Add new properties to an object field\n- Enable multi-fields for an existing field\n- Update supported mapping parameters\n- Change a field's mapping using reindexing\n- Rename a field using a field alias\n\nLearn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples) guide." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_mapping", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "write_index_only": { "type": "boolean", "description": "If `true`, the mappings are applied only to the current write index for the target.", "x-found-in": "query" }, "date_detection": { "type": "boolean", "description": "Controls whether dynamic date detection is enabled.", "x-found-in": "body" }, "dynamic": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__DynamicMapping", "description": "Controls whether new fields are added dynamically.", "x-found-in": "body" }, "dynamic_date_formats": { "type": "array", "items": { "type": "string" }, "description": "If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.", "x-found-in": "body" }, "dynamic_templates": { "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__DynamicTemplate" } }, "description": "Specify dynamic templates for the mapping.", "x-found-in": "body" }, "_field_names": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__FieldNamesField", "description": "Control whether field names are enabled for the index.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.", "x-found-in": "body" }, "numeric_detection": { "type": "boolean", "description": "Automatically map strings into numeric data types for all fields.", "x-found-in": "body" }, "properties": { "type": "object", "additionalProperties": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__Property" }, "description": "Mapping for a field. For new fields, this mapping can include:\n\n- Field name\n- Field data type\n- Mapping parameters", "x-found-in": "body" }, "_routing": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RoutingField", "description": "Enable making a routing value required on indexed documents.", "x-found-in": "body" }, "_source": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__SourceField", "description": "Control whether the _source field is enabled on the index.", "x-found-in": "body" }, "runtime": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Mapping of runtime fields for the index.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names the mapping should be added to (supports wildcards).\nUse `_all` or omit to add the mapping on all indices.", "x-found-in": "path" } }, "required": ["index"], "description": "Update field mappings.\n\nAdd new fields to an existing data stream or index.\nYou can use the update mapping API to:\n\n- Add a new field to an existing index\n- Update mappings for multiple indices in a single request\n- Add new properties to an object field\n- Enable multi-fields for an existing field\n- Update supported mapping parameters\n- Change a field's mapping using reindexing\n- Rename a field using a field alias\n\nLearn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples) guide." }

package/lib/cjs/es/json/indices.put_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_settings", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target\ndata streams, this argument determines whether wildcard expressions match\nhidden data streams. Supports comma-separated values, such as\n`open,hidden`.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "preserve_existing": { "type": "boolean", "description": "If `true`, existing index settings remain unchanged.", "x-found-in": "query" }, "reopen": { "type": "boolean", "description": "Whether to close and reopen the index to apply non-dynamic settings.\nIf set to `true` the indices to which the settings are being applied\nwill be closed temporarily and then reopened in order to apply the changes.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Update index settings.\n\nChanges dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nFor performance optimization during bulk indexing, you can disable the refresh interval.\nRefer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example.\nThere are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:\n\n```\n{\n  \"number_of_replicas\": 1\n}\n```\n\nOr you can use an `index` setting object:\n```\n{\n  \"index\": {\n    \"number_of_replicas\": 1\n  }\n}\n```\n\nOr you can use dot annotation:\n```\n{\n  \"index.number_of_replicas\": 1\n}\n```\n\nOr you can embed any of the aforementioned options in a `settings` object. For example:\n\n```\n{\n  \"settings\": {\n    \"index\": {\n      \"number_of_replicas\": 1\n    }\n  }\n}\n```\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.\nRefer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_settings", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target\ndata streams, this argument determines whether wildcard expressions match\nhidden data streams. Supports comma-separated values, such as\n`open,hidden`.", "x-found-in": "query" }, "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "preserve_existing": { "type": "boolean", "description": "If `true`, existing index settings remain unchanged.", "x-found-in": "query" }, "reopen": { "type": "boolean", "description": "Whether to close and reopen the index to apply non-dynamic settings.\nIf set to `true` the indices to which the settings are being applied\nwill be closed temporarily and then reopened in order to apply the changes.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Update index settings.\n\nChanges dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nFor performance optimization during bulk indexing, you can disable the refresh interval.\nRefer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example.\nThere are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:\n\n```\n{\n  \"number_of_replicas\": 1\n}\n```\n\nOr you can use an `index` setting object:\n```\n{\n  \"index\": {\n    \"number_of_replicas\": 1\n  }\n}\n```\n\nOr you can use dot annotation:\n```\n{\n  \"index.number_of_replicas\": 1\n}\n```\n\nOr you can embed any of the aforementioned options in a `settings` object. For example:\n\n```\n{\n  \"settings\": {\n    \"index\": {\n      \"number_of_replicas\": 1\n    }\n  }\n}\n```\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.\nRefer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples." }

package/lib/cjs/es/json/indices.put_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_template", "type": "object", "properties": { "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the index.", "x-found-in": "body" }, "index_patterns": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Array of wildcard expressions used to match the names\nof indices during creation.", "x-found-in": "body" }, "mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__TypeMapping", "description": "Mapping for fields in the index.", "x-found-in": "body" }, "order": { "type": "number", "description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.", "x-found-in": "query" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "description": "Configuration options for the index.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.\nTo unset a version, replace the template without specifying one.", "x-found-in": "body" }, "create": { "type": "boolean", "description": "If true, this request cannot replace or update existing index templates.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for creating or updating the index template", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the template", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update a legacy index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.put_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "If true, this request cannot replace or update existing index templates.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "order": { "type": "number", "description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.", "x-found-in": "body" }, "cause": { "type": "string", "description": "User defined reason for creating or updating the index template", "x-found-in": "query" }, "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the index.", "x-found-in": "body" }, "index_patterns": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Array of wildcard expressions used to match the names\nof indices during creation.", "x-found-in": "body" }, "mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__TypeMapping", "description": "Mapping for fields in the index.", "x-found-in": "body" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "description": "Configuration options for the index.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.\nTo unset a version, replace the template without specifying one.", "x-found-in": "body" }, "name": { "type": "string", "description": "The name of the template", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update a legacy index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order." }

package/lib/cjs/es/json/indices.resolve_index.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.resolve_index", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "mode": { "oneOf": [{ "$ref": "./indices._types.json#/$defs/indices._types__IndexMode" }, { "type": "array", "items": { "$ref": "./indices._types.json#/$defs/indices._types__IndexMode" } }], "description": "Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the `<cluster>`:`<name>` syntax.", "x-found-in": "path" } }, "required": ["name"], "description": "Resolve indices.\n\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.resolve_index", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "mode": { "anyOf": [{ "$ref": "./indices._types.json#/$defs/indices._types__IndexMode" }, { "type": "array", "items": { "$ref": "./indices._types.json#/$defs/indices._types__IndexMode" } }], "description": "Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the `<cluster>`:`<name>` syntax.", "x-found-in": "path" } }, "required": ["name"], "description": "Resolve indices.\n\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported." }

package/lib/cjs/es/json/indices.rollover.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.rollover", "type": "object", "properties": { "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the target index.\nData streams do not support this parameter.", "x-found-in": "body" }, "conditions": { "$ref": "./indices.rollover.json#/$defs/indices.rollover__RolloverConditions", "description": "Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.", "x-found-in": "body" }, "mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__TypeMapping", "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping paramaters.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the index.\nData streams do not support this parameter.", "x-found-in": "body" }, "dry_run": { "type": "boolean", "description": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "lazy": { "type": "boolean", "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.\nOnly allowed on data streams.", "x-found-in": "query" }, "alias": { "type": "string", "description": "Name of the data stream or index alias to roll over.", "x-found-in": "path" }, "new_index": { "type": "string", "description": "Name of the index to create.\nSupports date math.\nData streams do not support this parameter.", "x-found-in": "path" } }, "required": ["alias"], "description": "Roll over to a new index.\n\nTIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.rollover", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "lazy": { "type": "boolean", "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.\nOnly allowed on data streams.", "x-found-in": "query" }, "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the target index.\nData streams do not support this parameter.", "x-found-in": "body" }, "conditions": { "$ref": "./indices.rollover.json#/$defs/indices.rollover__RolloverConditions", "description": "Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.", "x-found-in": "body" }, "mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__TypeMapping", "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping paramaters.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the index.\nData streams do not support this parameter.", "x-found-in": "body" }, "alias": { "type": "string", "description": "Name of the data stream or index alias to roll over.", "x-found-in": "path" }, "new_index": { "type": "string", "description": "Name of the index to create.\nSupports date math.\nData streams do not support this parameter.", "x-found-in": "path" } }, "required": ["alias"], "description": "Roll over to a new index.\n\nTIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`." }

package/lib/cjs/es/json/indices.shard_stores.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.shard_stores", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target data streams,\nthis argument determines whether wildcard expressions match hidden data streams.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "status": { "oneOf": [{ "$ref": "./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus" }, { "type": "array", "items": { "$ref": "./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus" } }], "description": "List of shard health statuses used to limit the request.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "List of data streams, indices, and aliases used to limit the request.", "x-found-in": "path" } }, "description": "Get index shard stores.\n\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.shard_stores", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target data streams,\nthis argument determines whether wildcard expressions match hidden data streams.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "status": { "anyOf": [{ "$ref": "./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus" }, { "type": "array", "items": { "$ref": "./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus" } }], "description": "List of shard health statuses used to limit the request.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "List of data streams, indices, and aliases used to limit the request.", "x-found-in": "path" } }, "description": "Get index shard stores.\n\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards." }

package/lib/cjs/es/json/indices.shrink.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.shrink", "type": "object", "properties": { "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "The key is the alias name.\nIndex alias names support date math.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the target index.", "x-found-in": "body" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "index": { "type": "string", "description": "Name of the source index to shrink.", "x-found-in": "path" }, "target": { "type": "string", "description": "Name of the target index to create.", "x-found-in": "path" } }, "required": ["index", "target"], "description": "Shrink an index.\n\nShrink an index into a new index with fewer primary shards.\n\nBefore you can shrink an index:\n\n* The index must be read-only.\n* A copy of every shard in the index must reside on the same node.\n* The index must have a green health status.\n\nTo make shard allocation easier, we recommend you also remove the index's replica shards.\nYou can later re-add replica shards as part of the shrink operation.\n\nThe requested number of primary shards in the target index must be a factor of the number of shards in the source index.\nFor example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.\nIf the number of shards in the index is a prime number it can only be shrunk into a single primary shard\n Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.\n\nIMPORTANT: If the source index already has one primary shard, configuring the shrink operation with 'index.number_of_shards: 1' will cause the request to fail. An index with one primary shard cannot be shrunk further.\n\nThe current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.\n\nA shrink operation:\n\n* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.\n* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.\n\nIMPORTANT: Indices can only be shrunk if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have more primary shards than the target index.\n* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.\n* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.\n* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.shrink", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "The key is the alias name.\nIndex alias names support date math.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the target index.", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the source index to shrink.", "x-found-in": "path" }, "target": { "type": "string", "description": "Name of the target index to create.", "x-found-in": "path" } }, "required": ["index", "target"], "description": "Shrink an index.\n\nShrink an index into a new index with fewer primary shards.\n\nBefore you can shrink an index:\n\n* The index must be read-only.\n* A copy of every shard in the index must reside on the same node.\n* The index must have a green health status.\n\nTo make shard allocation easier, we recommend you also remove the index's replica shards.\nYou can later re-add replica shards as part of the shrink operation.\n\nThe requested number of primary shards in the target index must be a factor of the number of shards in the source index.\nFor example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.\nIf the number of shards in the index is a prime number it can only be shrunk into a single primary shard\n Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.\n\nIMPORTANT: If the source index already has one primary shard, configuring the shrink operation with 'index.number_of_shards: 1' will cause the request to fail. An index with one primary shard cannot be shrunk further.\n\nThe current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.\n\nA shrink operation:\n\n* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.\n* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.\n\nIMPORTANT: Indices can only be shrunk if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have more primary shards than the target index.\n* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.\n* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.\n* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index." }

package/lib/cjs/es/json/indices.simulate_index_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.simulate_index_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, returns all relevant default configurations for the index template.", "x-found-in": "query" }, "name": { "type": "string", "description": "Name of the index to simulate", "x-found-in": "path" } }, "required": ["name"], "description": "Simulate an index.\n\nGet the index configuration that would be applied to the specified index from an existing index template." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.simulate_index_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, returns all relevant default configurations for the index template.", "x-found-in": "query" }, "index_template": { "$ref": "./indices._types.json#/$defs/indices._types__IndexTemplate", "x-found-in": "body" }, "name": { "type": "string", "description": "Name of the index to simulate", "x-found-in": "path" } }, "required": ["name"], "description": "Simulate an index.\n\nGet the index configuration that would be applied to the specified index from an existing index template." }

package/lib/cjs/es/json/indices.simulate_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.simulate_template", "type": "object", "properties": { "allow_auto_create": { "type": "boolean", "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", "x-found-in": "body" }, "index_patterns": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "x-found-in": "body" }, "composed_of": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", "x-found-in": "body" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", "x-found-in": "body" }, "data_stream": { "$ref": "./indices._types.json#/$defs/indices._types__DataStreamVisibility", "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", "x-found-in": "body" }, "priority": { "type": "number", "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "ignore_missing_component_templates": { "type": "array", "items": { "type": "string" }, "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "create": { "type": "boolean", "description": "If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, returns all relevant default configurations for the index template.", "x-found-in": "query" }, "name": { "type": "string", "description": "Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit\nthis parameter and specify the template configuration in the request body.", "x-found-in": "path" } }, "description": "Simulate an index template.\n\nGet the index configuration that would be applied by a particular index template." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.simulate_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "If true, returns all relevant default configurations for the index template.", "x-found-in": "query" }, "allow_auto_create": { "type": "boolean", "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", "x-found-in": "body" }, "index_patterns": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "x-found-in": "body" }, "composed_of": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", "x-found-in": "body" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", "x-found-in": "body" }, "data_stream": { "$ref": "./indices._types.json#/$defs/indices._types__DataStreamVisibility", "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", "x-found-in": "body" }, "priority": { "type": "number", "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "ignore_missing_component_templates": { "type": "array", "items": { "type": "string" }, "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit\nthis parameter and specify the template configuration in the request body.", "x-found-in": "path" } }, "description": "Simulate an index template.\n\nGet the index configuration that would be applied by a particular index template." }

package/lib/cjs/es/json/indices.split.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.split", "type": "object", "properties": { "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the resulting index.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the target index.", "x-found-in": "body" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "index": { "type": "string", "description": "Name of the source index to split.", "x-found-in": "path" }, "target": { "type": "string", "description": "Name of the target index to create.", "x-found-in": "path" } }, "required": ["index", "target"], "description": "Split an index.\n\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nYou can do make an index read-only with the following request using the add index block API:\n\n```\nPUT /my_source_index/_block/write\n```\n\nThe current write index on a data stream cannot be split.\nIn order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The number of primary shards in the target index must be a divisor of the source index's `index.number_of_routing_shards`.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.split", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", "x-found-in": "query" }, "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the resulting index.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the target index.", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the source index to split.", "x-found-in": "path" }, "target": { "type": "string", "description": "Name of the target index to create.", "x-found-in": "path" } }, "required": ["index", "target"], "description": "Split an index.\n\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nYou can do make an index read-only with the following request using the add index block API:\n\n```\nPUT /my_source_index/_block/write\n```\n\nThe current write index on a data stream cannot be split.\nIn order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The number of primary shards in the target index must be a divisor of the source index's `index.number_of_routing_shards`.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index." }

package/lib/cjs/es/json/indices.stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.stats", "type": "object", "properties": { "completion_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as `open,hidden`.", "x-found-in": "query" }, "fielddata_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in fielddata statistics.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.", "x-found-in": "query" }, "forbid_closed_indices": { "type": "boolean", "description": "If true, statistics are not collected from closed indices.", "x-found-in": "query" }, "groups": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of search groups to include in the search statistics.", "x-found-in": "query" }, "include_segment_file_sizes": { "type": "boolean", "description": "If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", "x-found-in": "query" }, "include_unloaded_segments": { "type": "boolean", "description": "If true, the response includes information from segments that are not loaded into memory.", "x-found-in": "query" }, "level": { "$ref": "./_types.json#/$defs/_types__Level", "description": "Indicates whether statistics are aggregated at the cluster, indices, or shards level.", "x-found-in": "query" }, "metric": { "$ref": "./_types.json#/$defs/_types__CommonStatsFlags", "description": "Comma-separated list of metrics used to limit the request.", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } }, "description": "Get index statistics.\n\nFor data streams, the API retrieves statistics for the stream's backing indices.\n\nBy default, the returned statistics are index-level with `primaries` and `total` aggregations.\n`primaries` are the values for only the primary shards.\n`total` are the accumulated values for both primary and replica shards.\n\nTo get shard-level statistics, set the `level` parameter to `shards`.\n\nNOTE: When moving to another node, the shard-level statistics for a shard are cleared.\nAlthough the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.stats", "type": "object", "properties": { "completion_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as `open,hidden`.", "x-found-in": "query" }, "fielddata_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in fielddata statistics.", "x-found-in": "query" }, "fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.", "x-found-in": "query" }, "forbid_closed_indices": { "type": "boolean", "description": "If true, statistics are not collected from closed indices.", "x-found-in": "query" }, "groups": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of search groups to include in the search statistics.", "x-found-in": "query" }, "include_segment_file_sizes": { "type": "boolean", "description": "If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", "x-found-in": "query" }, "include_unloaded_segments": { "type": "boolean", "description": "If true, the response includes information from segments that are not loaded into memory.", "x-found-in": "query" }, "level": { "$ref": "./_types.json#/$defs/_types__Level", "description": "Indicates whether statistics are aggregated at the cluster, indices, or shards level.", "x-found-in": "query" }, "metric": { "$ref": "./_types.json#/$defs/_types__CommonStatsFlags", "description": "Comma-separated list of metrics used to limit the request.", "x-found-in": "path" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } }, "description": "Get index statistics.\n\nFor data streams, the API retrieves statistics for the stream's backing indices.\n\nBy default, the returned statistics are index-level with `primaries` and `total` aggregations.\n`primaries` are the values for only the primary shards.\n`total` are the accumulated values for both primary and replica shards.\n\nTo get shard-level statistics, set the `level` parameter to `shards`.\n\nNOTE: When moving to another node, the shard-level statistics for a shard are cleared.\nAlthough the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed." }

package/lib/cjs/es/json/indices.update_aliases.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.update_aliases", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "./indices.update_aliases.json#/$defs/indices.update_aliases__Action" }, "description": "Actions to perform.", "x-found-in": "body" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "description": "Create or update an alias.\n\nAdds a data stream or index to an alias." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.update_aliases", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "actions": { "type": "array", "items": { "$ref": "./indices.update_aliases.json#/$defs/indices.update_aliases__Action" }, "description": "Actions to perform.", "x-found-in": "body" } }, "description": "Create or update an alias.\n\nAdds a data stream or index to an alias." }

package/lib/cjs/es/json/indices.validate_query.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.validate_query", "type": "object", "properties": { "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Query in the Lucene query string syntax.", "x-found-in": "body" }, "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "all_shards": { "type": "boolean", "description": "If `true`, the validation is executed on all shards instead of one random shard per index.", "x-found-in": "query" }, "analyzer": { "type": "string", "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "If `true`, wildcard and prefix queries are analyzed.", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "description": "The default operator for query string query: `and` or `or`.", "x-found-in": "query" }, "df": { "type": "string", "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If `true`, the response returns detailed information if an error has occurred.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "lenient": { "type": "boolean", "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "x-found-in": "query" }, "rewrite": { "type": "boolean", "description": "If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.", "x-found-in": "query" }, "q": { "type": "string", "description": "Query in the Lucene query string syntax.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Validate a query.\n\nValidates a query without running it." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.validate_query", "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "all_shards": { "type": "boolean", "description": "If `true`, the validation is executed on all shards instead of one random shard per index.", "x-found-in": "query" }, "analyzer": { "type": "string", "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "If `true`, wildcard and prefix queries are analyzed.", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "description": "The default operator for query string query: `and` or `or`.", "x-found-in": "query" }, "df": { "type": "string", "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If `true`, the response returns detailed information if an error has occurred.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "lenient": { "type": "boolean", "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "x-found-in": "query" }, "rewrite": { "type": "boolean", "description": "If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.", "x-found-in": "query" }, "q": { "type": "string", "description": "Query in the Lucene query string syntax.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Query in the Lucene query string syntax.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Validate a query.\n\nValidates a query without running it." }

package/lib/cjs/es/json/inference.chat_completion_unified.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.chat_completion_unified", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id"], "description": "Perform chat completion inference on the service.\n\nThe chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.\nIt only works with the `chat_completion` task type.\n\nNOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming.\nThe Chat completion inference API and the Stream inference API differ in their response structure and capabilities.\nThe Chat completion inference API provides more comprehensive customization options through more fields and function calling support.\nTo determine whether a given inference service supports this task type, please see the page for that service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.chat_completion_unified", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "chat_completion_request": { "$ref": "./inference._types.json#/$defs/inference._types__RequestChatCompletion", "x-found-in": "body" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id"], "description": "Perform chat completion inference on the service.\n\nThe chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.\nIt only works with the `chat_completion` task type.\n\nNOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming.\nThe Chat completion inference API and the Stream inference API differ in their response structure and capabilities.\nThe Chat completion inference API provides more comprehensive customization options through more fields and function calling support.\nTo determine whether a given inference service supports this task type, please see the page for that service." }

package/lib/cjs/es/json/inference.completion.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.completion", "type": "object", "properties": { "input": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Inference input.\nEither a string or an array of strings.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id", "input"], "description": "Perform completion inference on the service.\n\nGet responses for completion tasks.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege)." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.completion", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "input": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Inference input.\nEither a string or an array of strings.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.", "x-found-in": "body" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id", "input"], "description": "Perform completion inference on the service.\n\nGet responses for completion tasks.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege)." }

package/lib/cjs/es/json/inference.embedding.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.embedding", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id"], "description": "Perform dense embedding inference on the service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.embedding", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "embedding": { "$ref": "./inference._types.json#/$defs/inference._types__RequestEmbedding", "x-found-in": "body" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id"], "description": "Perform dense embedding inference on the service." }

package/lib/cjs/es/json/inference.inference.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.inference", "type": "object", "properties": { "query": { "type": "string", "description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.", "x-found-in": "body" }, "input": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", "x-found-in": "body" }, "input_type": { "type": "string", "description": "Specifies the input data type for the embedding model. The `input_type` parameter only applies to Inference Endpoints with the `embedding` or `text_embedding` task type. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\nNot all services support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskType", "description": "The type of inference task that the model performs.", "x-found-in": "path" }, "inference_id": { "type": "string", "description": "The unique identifier for the inference endpoint.", "x-found-in": "path" } }, "required": ["inference_id", "input"], "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\nFor details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.inference", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "query": { "type": "string", "description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.", "x-found-in": "body" }, "input": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", "x-found-in": "body" }, "input_type": { "type": "string", "description": "Specifies the input data type for the embedding model. The `input_type` parameter only applies to Inference Endpoints with the `embedding` or `text_embedding` task type. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\nNot all services support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskType", "description": "The type of inference task that the model performs.", "x-found-in": "path" }, "inference_id": { "type": "string", "description": "The unique identifier for the inference endpoint.", "x-found-in": "path" } }, "required": ["inference_id", "input"], "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\nFor details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs." }

package/lib/cjs/es/json/inference.put.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.\nThe default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskType", "description": "The task type. Refer to the integration list in the API description for the available task types.", "x-found-in": "path" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id"], "description": "Create an inference endpoint.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThe following integrations are available through the inference API. You can find the available task types next to the integration name:\n* AI21 (`chat_completion`, `completion`)\n* AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)\n* Amazon Bedrock (`chat_completion`, `completion`, `text_embedding`)\n* Amazon SageMaker (`chat_completion`, `completion`, `rerank`, `sparse_embedding`, `text_embedding`)\n* Anthropic (`chat_completion`, `completion`)\n* Azure AI Studio (`completion`, `rerank`, `text_embedding`)\n* Azure OpenAI (`chat_completion`, `completion`, `text_embedding`)\n* Cohere (`completion`, `rerank`, `text_embedding`)\n* DeepSeek (`chat_completion`, `completion`)\n* Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)\n* ELSER (`sparse_embedding`)\n* Fireworks AI (`chat_completion`, `completion`, `text_embedding`)\n* Google AI Studio (`completion`, `text_embedding`)\n* Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* Groq (`chat_completion`)\n* Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* JinaAI (`embedding`, `rerank`, `text_embedding`)\n* Llama (`chat_completion`, `completion`, `text_embedding`)\n* Mistral (`chat_completion`, `completion`, `text_embedding`)\n* Nvidia (`chat_completion`, `completion`, `text_embedding`, `rerank`)\n* OpenAI (`chat_completion`, `completion`, `text_embedding`)\n* OpenShift AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* VoyageAI (`rerank`, `text_embedding`)\n* Watsonx (`chat_completion`, `completion`, `rerank`, `text_embedding`)" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.\nThe default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.", "x-found-in": "query" }, "inference_config": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceEndpoint", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskType", "description": "The task type. Refer to the integration list in the API description for the available task types.", "x-found-in": "path" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id"], "description": "Create an inference endpoint.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThe following integrations are available through the inference API. You can find the available task types next to the integration name:\n* AI21 (`chat_completion`, `completion`)\n* AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)\n* Amazon Bedrock (`chat_completion`, `completion`, `text_embedding`)\n* Amazon SageMaker (`chat_completion`, `completion`, `rerank`, `sparse_embedding`, `text_embedding`)\n* Anthropic (`chat_completion`, `completion`)\n* Azure AI Studio (`completion`, `rerank`, `text_embedding`)\n* Azure OpenAI (`chat_completion`, `completion`, `text_embedding`)\n* Cohere (`completion`, `rerank`, `text_embedding`)\n* DeepSeek (`chat_completion`, `completion`)\n* Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)\n* ELSER (`sparse_embedding`)\n* Fireworks AI (`chat_completion`, `completion`, `text_embedding`)\n* Google AI Studio (`completion`, `text_embedding`)\n* Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* Groq (`chat_completion`)\n* Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* JinaAI (`embedding`, `rerank`, `text_embedding`)\n* Llama (`chat_completion`, `completion`, `text_embedding`)\n* Mistral (`chat_completion`, `completion`, `text_embedding`)\n* Nvidia (`chat_completion`, `completion`, `text_embedding`, `rerank`)\n* OpenAI (`chat_completion`, `completion`, `text_embedding`)\n* OpenShift AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* VoyageAI (`rerank`, `text_embedding`)\n* Watsonx (`chat_completion`, `completion`, `rerank`, `text_embedding`)" }

package/lib/cjs/es/json/inference.put_ai21.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_ai21", "type": "object", "properties": { "service": { "$ref": "./inference._types.json#/$defs/inference._types__Ai21ServiceType", "description": "The type of service supported for the specified task type. In this case, `ai21`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__Ai21ServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `ai21` service.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__Ai21TaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "ai21_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "ai21_inference_id", "service", "service_settings"], "description": "Create a AI21 inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `ai21` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_ai21", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__Ai21ServiceType", "description": "The type of service supported for the specified task type. In this case, `ai21`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__Ai21ServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `ai21` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__Ai21TaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "ai21_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "ai21_inference_id", "service", "service_settings"], "description": "Create a AI21 inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `ai21` service." }

package/lib/cjs/es/json/inference.put_alibabacloud.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_alibabacloud", "type": "object", "properties": { "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `sparse_embedding` or `text_embedding` task types.\nNot applicable to the `rerank` or `completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AlibabaCloudServiceType", "description": "The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AlibabaCloudServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AlibabaCloudTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AlibabaCloudTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "alibabacloud_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "alibabacloud_inference_id", "service", "service_settings"], "description": "Create an AlibabaCloud AI Search inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_alibabacloud", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `sparse_embedding` or `text_embedding` task types.\nNot applicable to the `rerank` or `completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AlibabaCloudServiceType", "description": "The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AlibabaCloudServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AlibabaCloudTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AlibabaCloudTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "alibabacloud_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "alibabacloud_inference_id", "service", "service_settings"], "description": "Create an AlibabaCloud AI Search inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service." }

package/lib/cjs/es/json/inference.put_amazonbedrock.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_amazonbedrock", "type": "object", "properties": { "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `chat_completion` and `completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonBedrockServiceType", "description": "The type of service supported for the specified task type. In this case, `amazonbedrock`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonBedrockServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `amazonbedrock` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonBedrockTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonBedrockTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "amazonbedrock_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "amazonbedrock_inference_id", "service", "service_settings"], "description": "Create an Amazon Bedrock inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `amazonbedrock` service.\n\n>info\n> You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_amazonbedrock", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `chat_completion` and `completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonBedrockServiceType", "description": "The type of service supported for the specified task type. In this case, `amazonbedrock`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonBedrockServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `amazonbedrock` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonBedrockTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonBedrockTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "amazonbedrock_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "amazonbedrock_inference_id", "service", "service_settings"], "description": "Create an Amazon Bedrock inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `amazonbedrock` service.\n\n>info\n> You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys." }

package/lib/cjs/es/json/inference.put_amazonsagemaker.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_amazonsagemaker", "type": "object", "properties": { "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `sparse_embedding` or `text_embedding` task types.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonSageMakerServiceType", "description": "The type of service supported for the specified task type. In this case, `amazon_sagemaker`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonSageMakerServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonSageMakerTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type and `service_settings.api` you specified.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskTypeAmazonSageMaker", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "amazonsagemaker_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "amazonsagemaker_inference_id", "service", "service_settings"], "description": "Create an Amazon SageMaker inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `amazon_sagemaker` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_amazonsagemaker", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `sparse_embedding` or `text_embedding` task types.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonSageMakerServiceType", "description": "The type of service supported for the specified task type. In this case, `amazon_sagemaker`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonSageMakerServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AmazonSageMakerTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type and `service_settings.api` you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskTypeAmazonSageMaker", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "amazonsagemaker_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "amazonsagemaker_inference_id", "service", "service_settings"], "description": "Create an Amazon SageMaker inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `amazon_sagemaker` service." }

package/lib/cjs/es/json/inference.put_anthropic.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_anthropic", "type": "object", "properties": { "service": { "$ref": "./inference._types.json#/$defs/inference._types__AnthropicServiceType", "description": "The type of service supported for the specified task type. In this case, `anthropic`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AnthropicServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `anthropic` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AnthropicTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AnthropicTaskType", "description": "The task type.\nThe valid task types for the model to perform are `completion` and `chat_completion`.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", "x-found-in": "path" }, "anthropic_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "anthropic_inference_id", "service", "service_settings"], "description": "Create an Anthropic inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `anthropic` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_anthropic", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AnthropicServiceType", "description": "The type of service supported for the specified task type. In this case, `anthropic`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AnthropicServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `anthropic` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AnthropicTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AnthropicTaskType", "description": "The task type.\nThe valid task types for the model to perform are `completion` and `chat_completion`.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", "x-found-in": "path" }, "anthropic_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "anthropic_inference_id", "service", "service_settings"], "description": "Create an Anthropic inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `anthropic` service." }

package/lib/cjs/es/json/inference.put_azureaistudio.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_azureaistudio", "type": "object", "properties": { "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` or `completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AzureAiStudioServiceType", "description": "The type of service supported for the specified task type. In this case, `azureaistudio`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AzureAiStudioServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `azureaistudio` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AzureAiStudioTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AzureAiStudioTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "azureaistudio_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "azureaistudio_inference_id", "service", "service_settings"], "description": "Create an Azure AI studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureaistudio` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_azureaistudio", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` or `completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AzureAiStudioServiceType", "description": "The type of service supported for the specified task type. In this case, `azureaistudio`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AzureAiStudioServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `azureaistudio` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AzureAiStudioTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AzureAiStudioTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "azureaistudio_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "azureaistudio_inference_id", "service", "service_settings"], "description": "Create an Azure AI studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureaistudio` service." }

package/lib/cjs/es/json/inference.put_azureopenai.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_azureopenai", "type": "object", "properties": { "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` and `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AzureOpenAIServiceType", "description": "The type of service supported for the specified task type. In this case, `azureopenai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AzureOpenAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `azureopenai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AzureOpenAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AzureOpenAITaskType", "description": "The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", "x-found-in": "path" }, "azureopenai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "azureopenai_inference_id", "service", "service_settings"], "description": "Create an Azure OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureopenai` service.\n\nThe list of chat completion models that you can choose from in your Azure OpenAI deployment include:\n\n* [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models)\n* [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35)\n\nThe list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings)." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_azureopenai", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` and `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__AzureOpenAIServiceType", "description": "The type of service supported for the specified task type. In this case, `azureopenai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AzureOpenAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `azureopenai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__AzureOpenAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__AzureOpenAITaskType", "description": "The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", "x-found-in": "path" }, "azureopenai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "azureopenai_inference_id", "service", "service_settings"], "description": "Create an Azure OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureopenai` service.\n\nThe list of chat completion models that you can choose from in your Azure OpenAI deployment include:\n\n* [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models)\n* [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35)\n\nThe list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings)." }

package/lib/cjs/es/json/inference.put_cohere.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_cohere", "type": "object", "properties": { "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` or `completion` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__CohereServiceType", "description": "The type of service supported for the specified task type. In this case, `cohere`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__CohereServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `cohere` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__CohereTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__CohereTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "cohere_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "cohere_inference_id", "service", "service_settings"], "description": "Create a Cohere inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `cohere` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_cohere", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` or `completion` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__CohereServiceType", "description": "The type of service supported for the specified task type. In this case, `cohere`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__CohereServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `cohere` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__CohereTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__CohereTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "cohere_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "cohere_inference_id", "service", "service_settings"], "description": "Create a Cohere inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `cohere` service." }