@elastic/schemas 0.4.3 → 0.4.5

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.shrink", "type": "object", "properties": { "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" }, "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" } }, "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/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": { "name": { "type": "string", "description": "Name of the index to simulate", "x-found-in": "path" }, "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" } }, "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/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": { "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" }, "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" } }, "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/es/json/indices.split.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.split", "type": "object", "properties": { "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" }, "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" } }, "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/es/json/indices.stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.stats", "type": "object", "properties": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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/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": { "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" }, "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" } }, "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/es/json/inference.completion.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.completion", "type": "object", "properties": { "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" }, "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": { "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" } }, "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/es/json/inference.delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.delete", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskType", "description": "The task type", "x-found-in": "path" }, "inference_id": { "type": "string", "description": "The inference identifier.", "x-found-in": "path" }, "dry_run": { "type": "boolean", "description": "When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.", "x-found-in": "query" }, "force": { "type": "boolean", "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.", "x-found-in": "query" } }, "required": ["inference_id"], "description": "Delete an inference endpoint.\n\nThis API requires the manage_inference cluster privilege (the built-in `inference_admin` role grants this privilege)." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.delete", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.", "x-found-in": "query" }, "force": { "type": "boolean", "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.", "x-found-in": "query" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskType", "description": "The task type", "x-found-in": "path" }, "inference_id": { "type": "string", "description": "The inference identifier.", "x-found-in": "path" } }, "required": ["inference_id"], "description": "Delete an inference endpoint.\n\nThis API requires the manage_inference cluster privilege (the built-in `inference_admin` role grants this privilege)." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.embedding", "type": "object", "properties": { "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" }, "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" } }, "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/es/json/inference.inference.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.inference", "type": "object", "properties": { "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" }, "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": { "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" } }, "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/es/json/inference.put.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put", "type": "object", "properties": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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/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": { "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" }, "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" } }, "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." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_contextualai", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskTypeContextualAI", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "contextualai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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__ContextualAIServiceType", "description": "The type of service supported for the specified task type. In this case, `contextualai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `contextualai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "contextualai_inference_id", "service", "service_settings"], "description": "Create an Contextual AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `contexualai` service.\n\nTo review the available `rerank` models, refer to <https://docs.contextual.ai/api-reference/rerank/rerank#body-model>." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_contextualai", "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__ContextualAIServiceType", "description": "The type of service supported for the specified task type. In this case, `contextualai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `contextualai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAITaskSettings", "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__TaskTypeContextualAI", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "contextualai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "contextualai_inference_id", "service", "service_settings"], "description": "Create an Contextual AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `contexualai` service.\n\nTo review the available `rerank` models, refer to <https://docs.contextual.ai/api-reference/rerank/rerank#body-model>." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_custom", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__CustomTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "custom_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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__CustomServiceType", "description": "The type of service supported for the specified task type. In this case, `custom`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__CustomServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `custom` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__CustomTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "custom_inference_id", "service", "service_settings"], "description": "Create a custom inference endpoint.\n\nThe custom service gives more control over how to interact with external inference services that aren't explicitly supported through dedicated integrations.\nThe custom service gives you the ability to define the headers, url, query parameters, request body, and secrets.\nThe custom service supports the template replacement functionality, which enables you to define a template that can be replaced with the value associated with that key.\nTemplates are portions of a string that start with `${` and end with `}`.\nThe parameters `secret_parameters` and `task_settings` are checked for keys for template replacement. Template replacement is supported in the `request`, `headers`, `url`, and `query_parameters`.\nIf the definition (key) is not found for a template, an error message is returned.\nIn case of an endpoint definition like the following:\n```\nPUT _inference/text_embedding/test-text-embedding\n{\n  \"service\": \"custom\",\n  \"service_settings\": {\n     \"secret_parameters\": {\n          \"api_key\": \"<some api key>\"\n     },\n     \"url\": \"...endpoints.huggingface.cloud/v1/embeddings\",\n     \"headers\": {\n         \"Authorization\": \"Bearer ${api_key}\",\n         \"Content-Type\": \"application/json\"\n     },\n     \"request\": \"{\\\"input\\\": ${input}}\",\n     \"response\": {\n         \"json_parser\": {\n             \"text_embeddings\":\"$.data[*].embedding[*]\"\n         }\n     }\n  }\n}\n```\nTo replace `${api_key}` the `secret_parameters` and `task_settings` are checked for a key named `api_key`.\n\n> info\n> Templates should not be surrounded by quotes.\n\nPre-defined templates:\n* `${input}` refers to the array of input strings that comes from the `input` field of the subsequent inference requests.\n* `${input_type}` refers to the input type translation values.\n* `${query}` refers to the query field used specifically for reranking tasks.\n* `${top_n}` refers to the `top_n` field available when performing rerank requests.\n* `${return_documents}` refers to the `return_documents` field available when performing rerank requests." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_custom", "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__CustomServiceType", "description": "The type of service supported for the specified task type. In this case, `custom`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__CustomServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `custom` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__CustomTaskSettings", "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__CustomTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "custom_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "custom_inference_id", "service", "service_settings"], "description": "Create a custom inference endpoint.\n\nThe custom service gives more control over how to interact with external inference services that aren't explicitly supported through dedicated integrations.\nThe custom service gives you the ability to define the headers, url, query parameters, request body, and secrets.\nThe custom service supports the template replacement functionality, which enables you to define a template that can be replaced with the value associated with that key.\nTemplates are portions of a string that start with `${` and end with `}`.\nThe parameters `secret_parameters` and `task_settings` are checked for keys for template replacement. Template replacement is supported in the `request`, `headers`, `url`, and `query_parameters`.\nIf the definition (key) is not found for a template, an error message is returned.\nIn case of an endpoint definition like the following:\n```\nPUT _inference/text_embedding/test-text-embedding\n{\n  \"service\": \"custom\",\n  \"service_settings\": {\n     \"secret_parameters\": {\n          \"api_key\": \"<some api key>\"\n     },\n     \"url\": \"...endpoints.huggingface.cloud/v1/embeddings\",\n     \"headers\": {\n         \"Authorization\": \"Bearer ${api_key}\",\n         \"Content-Type\": \"application/json\"\n     },\n     \"request\": \"{\\\"input\\\": ${input}}\",\n     \"response\": {\n         \"json_parser\": {\n             \"text_embeddings\":\"$.data[*].embedding[*]\"\n         }\n     }\n  }\n}\n```\nTo replace `${api_key}` the `secret_parameters` and `task_settings` are checked for a key named `api_key`.\n\n> info\n> Templates should not be surrounded by quotes.\n\nPre-defined templates:\n* `${input}` refers to the array of input strings that comes from the `input` field of the subsequent inference requests.\n* `${input_type}` refers to the input type translation values.\n* `${query}` refers to the query field used specifically for reranking tasks.\n* `${top_n}` refers to the `top_n` field available when performing rerank requests.\n* `${return_documents}` refers to the `return_documents` field available when performing rerank requests." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_deepseek", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskTypeDeepSeek", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "deepseek_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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__DeepSeekServiceType", "description": "The type of service supported for the specified task type. In this case, `deepseek`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__DeepSeekServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `deepseek` service.", "x-found-in": "body" } }, "required": ["task_type", "deepseek_inference_id", "service", "service_settings"], "description": "Create a DeepSeek inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `deepseek` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_deepseek", "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__DeepSeekServiceType", "description": "The type of service supported for the specified task type. In this case, `deepseek`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__DeepSeekServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `deepseek` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskTypeDeepSeek", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "deepseek_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "deepseek_inference_id", "service", "service_settings"], "description": "Create a DeepSeek inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `deepseek` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_elasticsearch", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "elasticsearch_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.\nThe must not match the `model_id`.", "x-found-in": "path" }, "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` and `text_embedding` task types.\nNot applicable to the `rerank` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchServiceType", "description": "The type of service supported for the specified task type. In this case, `elasticsearch`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `elasticsearch` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "elasticsearch_inference_id", "service", "service_settings"], "description": "Create an Elasticsearch inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elasticsearch` service.\n\n> info\n> Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.\n\nIf you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_elasticsearch", "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` and `text_embedding` task types.\nNot applicable to the `rerank` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchServiceType", "description": "The type of service supported for the specified task type. In this case, `elasticsearch`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `elasticsearch` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchTaskSettings", "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__ElasticsearchTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "elasticsearch_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.\nThe must not match the `model_id`.", "x-found-in": "path" } }, "required": ["task_type", "elasticsearch_inference_id", "service", "service_settings"], "description": "Create an Elasticsearch inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elasticsearch` service.\n\n> info\n> Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.\n\nIf you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_elser", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__ElserTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "elser_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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.\nNote that for ELSER endpoints, the max_chunk_size may not exceed `300`.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__ElserServiceType", "description": "The type of service supported for the specified task type. In this case, `elser`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElserServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `elser` service.", "x-found-in": "body" } }, "required": ["task_type", "elser_inference_id", "service", "service_settings"], "description": "Create an ELSER inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elser` service.\nYou can also deploy ELSER by using the Elasticsearch inference integration.\n\n> info\n> Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings.\n\nThe API request will automatically download and deploy the ELSER model if it isn't already downloaded.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_elser", "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.\nNote that for ELSER endpoints, the max_chunk_size may not exceed `300`.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__ElserServiceType", "description": "The type of service supported for the specified task type. In this case, `elser`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElserServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `elser` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__ElserTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "elser_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "elser_inference_id", "service", "service_settings"], "description": "Create an ELSER inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elser` service.\nYou can also deploy ELSER by using the Elasticsearch inference integration.\n\n> info\n> Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings.\n\nThe API request will automatically download and deploy the ELSER model if it isn't already downloaded.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_fireworksai", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "fireworksai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAIServiceType", "description": "The type of service supported for the specified task type. In this case, `fireworksai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `fireworksai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAITaskSettings", "description": "Settings to configure the inference task.\nApplies only to the `completion` or `chat_completion` task types.\nNot applicable to the `text_embedding` task type.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "fireworksai_inference_id", "service", "service_settings"], "description": "Create a Fireworks AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `fireworksai` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_fireworksai", "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` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAIServiceType", "description": "The type of service supported for the specified task type. In this case, `fireworksai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `fireworksai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAITaskSettings", "description": "Settings to configure the inference task.\nApplies only to the `completion` or `chat_completion` task types.\nNot applicable to the `text_embedding` task type.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "fireworksai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "fireworksai_inference_id", "service", "service_settings"], "description": "Create a Fireworks AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `fireworksai` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googleaistudio", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiStudioTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "googleaistudio_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiServiceType", "description": "The type of service supported for the specified task type. In this case, `googleaistudio`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiStudioServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service.", "x-found-in": "body" } }, "required": ["task_type", "googleaistudio_inference_id", "service", "service_settings"], "description": "Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googleaistudio", "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` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiServiceType", "description": "The type of service supported for the specified task type. In this case, `googleaistudio`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiStudioServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiStudioTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "googleaistudio_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "googleaistudio_inference_id", "service", "service_settings"], "description": "Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googlevertexai", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "googlevertexai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceType", "description": "The type of service supported for the specified task type. In this case, `googlevertexai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `googlevertexai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "googlevertexai_inference_id", "service", "service_settings"], "description": "Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googlevertexai", "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`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceType", "description": "The type of service supported for the specified task type. In this case, `googlevertexai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `googlevertexai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAITaskSettings", "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__GoogleVertexAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "googlevertexai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "googlevertexai_inference_id", "service", "service_settings"], "description": "Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_groq", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GroqTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "groq_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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__GroqServiceType", "description": "The type of service supported for the specified task type. In this case, `groq`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GroqServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `groq` service.", "x-found-in": "body" } }, "required": ["task_type", "groq_inference_id", "service", "service_settings"], "description": "Create a Groq inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `groq` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_groq", "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__GroqServiceType", "description": "The type of service supported for the specified task type. In this case, `groq`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GroqServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `groq` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GroqTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "groq_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "groq_inference_id", "service", "service_settings"], "description": "Create a Groq inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `groq` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_hugging_face", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "huggingface_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceServiceType", "description": "The type of service supported for the specified task type. In this case, `hugging_face`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "huggingface_inference_id", "service", "service_settings"], "description": "Create a Hugging Face inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `hugging_face` service.\nSupported tasks include: `text_embedding`, `completion`, and `chat_completion`.\n\nTo configure the endpoint, first visit the Hugging Face Inference Endpoints page and create a new endpoint.\nSelect a model that supports the task you intend to use.\n\nFor Elastic's `text_embedding` task:\nThe selected model must support the `Sentence Embeddings` task. On the new endpoint creation page, select the `Sentence Embeddings` task under the `Advanced Configuration` section.\nAfter the endpoint has initialized, copy the generated endpoint URL.\nRecommended models for `text_embedding` task:\n\n* `all-MiniLM-L6-v2`\n* `all-MiniLM-L12-v2`\n* `all-mpnet-base-v2`\n* `e5-base-v2`\n* `e5-small-v2`\n* `multilingual-e5-base`\n* `multilingual-e5-small`\n\nFor Elastic's `chat_completion` and `completion` tasks:\nThe selected model must support the `Text Generation` task and expose OpenAI API. HuggingFace supports both serverless and dedicated endpoints for `Text Generation`. When creating dedicated endpoint select the `Text Generation` task.\nAfter the endpoint is initialized (for dedicated) or ready (for serverless), ensure it supports the OpenAI API and includes `/v1/chat/completions` part in URL. Then, copy the full endpoint URL for use.\nRecommended models for `chat_completion` and `completion` tasks:\n\n* `Mistral-7B-Instruct-v0.2`\n* `QwQ-32B`\n* `Phi-3-mini-128k-instruct`\n\nFor Elastic's `rerank` task:\nThe selected model must support the `sentence-ranking` task and expose OpenAI API.\nHuggingFace supports only dedicated (not serverless) endpoints for `Rerank` so far.\nAfter the endpoint is initialized, copy the full endpoint URL for use.\nTested models for `rerank` task:\n\n* `bge-reranker-base`\n* `jina-reranker-v1-turbo-en-GGUF`" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_hugging_face", "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`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceServiceType", "description": "The type of service supported for the specified task type. In this case, `hugging_face`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceTaskSettings", "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__HuggingFaceTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "huggingface_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "huggingface_inference_id", "service", "service_settings"], "description": "Create a Hugging Face inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `hugging_face` service.\nSupported tasks include: `text_embedding`, `completion`, and `chat_completion`.\n\nTo configure the endpoint, first visit the Hugging Face Inference Endpoints page and create a new endpoint.\nSelect a model that supports the task you intend to use.\n\nFor Elastic's `text_embedding` task:\nThe selected model must support the `Sentence Embeddings` task. On the new endpoint creation page, select the `Sentence Embeddings` task under the `Advanced Configuration` section.\nAfter the endpoint has initialized, copy the generated endpoint URL.\nRecommended models for `text_embedding` task:\n\n* `all-MiniLM-L6-v2`\n* `all-MiniLM-L12-v2`\n* `all-mpnet-base-v2`\n* `e5-base-v2`\n* `e5-small-v2`\n* `multilingual-e5-base`\n* `multilingual-e5-small`\n\nFor Elastic's `chat_completion` and `completion` tasks:\nThe selected model must support the `Text Generation` task and expose OpenAI API. HuggingFace supports both serverless and dedicated endpoints for `Text Generation`. When creating dedicated endpoint select the `Text Generation` task.\nAfter the endpoint is initialized (for dedicated) or ready (for serverless), ensure it supports the OpenAI API and includes `/v1/chat/completions` part in URL. Then, copy the full endpoint URL for use.\nRecommended models for `chat_completion` and `completion` tasks:\n\n* `Mistral-7B-Instruct-v0.2`\n* `QwQ-32B`\n* `Phi-3-mini-128k-instruct`\n\nFor Elastic's `rerank` task:\nThe selected model must support the `sentence-ranking` task and expose OpenAI API.\nHuggingFace supports only dedicated (not serverless) endpoints for `Rerank` so far.\nAfter the endpoint is initialized, copy the full endpoint URL for use.\nTested models for `rerank` task:\n\n* `bge-reranker-base`\n* `jina-reranker-v1-turbo-en-GGUF`" }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_jinaai", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "jinaai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "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 `embedding` and text_embedding` task types.\nNot applicable to the `rerank` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAIServiceType", "description": "The type of service supported for the specified task type. In this case, `jinaai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `jinaai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "jinaai_inference_id", "service", "service_settings"], "description": "Create an JinaAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `jinaai` service.\n\nTo review the available `rerank` models, refer to <https://jina.ai/reranker>.\nTo review the available `embedding` and `text_embedding` models, refer to <https://jina.ai/embeddings/>." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_jinaai", "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 `embedding` and text_embedding` task types.\nNot applicable to the `rerank` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAIServiceType", "description": "The type of service supported for the specified task type. In this case, `jinaai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `jinaai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAITaskSettings", "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__JinaAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "jinaai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "jinaai_inference_id", "service", "service_settings"], "description": "Create an JinaAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `jinaai` service.\n\nTo review the available `rerank` models, refer to <https://jina.ai/reranker>.\nTo review the available `embedding` and `text_embedding` models, refer to <https://jina.ai/embeddings/>." }