diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 5ece2376e9..e1c7c75b36 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -4335,7 +4335,7 @@ "visibility": "public" } }, - "description": "Perform chat completion inference", + "description": "Perform chat completion inference\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 for `openai` and `elastic` inference services.\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.\nFor 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\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.\nIf you use the `openai` service or the `elastic` service, use the Chat completion inference API.", "docId": "inference-api-chat-completion", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-unified-inference", "name": "inference.chat_completion_unified", @@ -27121,7 +27121,24 @@ } } }, - "description": "Perform chat completion inference", + "description": "Perform chat completion inference\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 for `openai` and `elastic` inference services.\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.\nFor 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\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.\nIf you use the `openai` service or the `elastic` service, use the Chat completion inference API.", + "examples": { + "PostChatCompletionRequestExample1": { + "description": "Run `POST _inference/chat_completion/openai-completion/_stream` to perform a chat completion on the example question with streaming.", + "summary": "A chat completion task", + "value": "{\n \"model\": \"gpt-4o\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is Elastic?\"\n }\n ]\n}" + }, + "PostChatCompletionRequestExample2": { + "description": "Run `POST POST _inference/chat_completion/openai-completion/_stream` to perform a chat completion using an Assistant message with `tool_calls`.", + "summary": "A chat completion task with tool_calls", + "value": "{\n \"messages\": [\n {\n \"role\": \"assistant\",\n \"content\": \"Let's find out what the weather is\",\n \"tool_calls\": [ \n {\n \"id\": \"call_KcAjWtAww20AihPHphUh46Gd\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"arguments\": \"{\\\"location\\\":\\\"Boston, MA\\\"}\"\n }\n }\n ]\n },\n { \n \"role\": \"tool\",\n \"content\": \"The weather is cold\",\n \"tool_call_id\": \"call_KcAjWtAww20AihPHphUh46Gd\"\n }\n ]\n}" + }, + "PostChatCompletionRequestExample3": { + "description": "Run `POST POST _inference/chat_completion/openai-completion/_stream` to perform a chat completion using a User message with `tools` and `tool_choice`.", + "summary": "A chat completion task with tools and tool_calls", + "value": "{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"What's the price of a scarf?\"\n }\n ]\n }\n ],\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_price\",\n \"description\": \"Get the current price of a item\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"id\": \"123\"\n }\n }\n }\n }\n }\n ],\n \"tool_choice\": {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_price\"\n }\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -27162,7 +27179,7 @@ } } ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L24-L53" + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L24-L64" }, { "body": { @@ -27176,6 +27193,12 @@ } } }, + "examples": { + "PostChatCompletionResponseExample1": { + "description": "A successful response when performing a chat completion task using a User message with `tools` and `tool_choice`.", + "value": "event: message\ndata: {\"chat_completion\":{\"id\":\"chatcmpl-Ae0TWsy2VPnSfBbv5UztnSdYUMFP3\",\"choices\":[{\"delta\":{\"content\":\"\",\"role\":\"assistant\"},\"index\":0}],\"model\":\"gpt-4o-2024-08-06\",\"object\":\"chat.completion.chunk\"}}\n\nevent: message\ndata: {\"chat_completion\":{\"id\":\"chatcmpl-Ae0TWsy2VPnSfBbv5UztnSdYUMFP3\",\"choices\":[{\"delta\":{\"content\":Elastic\"},\"index\":0}],\"model\":\"gpt-4o-2024-08-06\",\"object\":\"chat.completion.chunk\"}}\n\nevent: message\ndata: {\"chat_completion\":{\"id\":\"chatcmpl-Ae0TWsy2VPnSfBbv5UztnSdYUMFP3\",\"choices\":[{\"delta\":{\"content\":\" is\"},\"index\":0}],\"model\":\"gpt-4o-2024-08-06\",\"object\":\"chat.completion.chunk\"}}\n\n(...)\n\nevent: message\ndata: {\"chat_completion\":{\"id\":\"chatcmpl-Ae0TWsy2VPnSfBbv5UztnSdYUMFP3\",\"choices\":[],\"model\":\"gpt-4o-2024-08-06\",\"object\":\"chat.completion.chunk\",\"usage\":{\"completion_tokens\":28,\"prompt_tokens\":16,\"total_tokens\":44}}} \n\nevent: message\ndata: [DONE]" + } + }, "kind": "response", "name": { "name": "Response", @@ -100125,7 +100148,7 @@ "name": "CatDatafeedColumns", "namespace": "cat._types" }, - "specLocation": "cat/_types/CatBase.ts#L559-L559", + "specLocation": "cat/_types/CatBase.ts#L1014-L1014", "type": { "items": [ { @@ -100275,7 +100298,7 @@ "name": "CatDfaColumn", "namespace": "cat._types" }, - "specLocation": "cat/_types/CatBase.ts#L472-L557" + "specLocation": "cat/_types/CatBase.ts#L473-L558" }, { "kind": "type_alias", @@ -100283,7 +100306,7 @@ "name": "CatDfaColumns", "namespace": "cat._types" }, - "specLocation": "cat/_types/CatBase.ts#L558-L558", + "specLocation": "cat/_types/CatBase.ts#L1013-L1013", "type": { "items": [ { @@ -100307,6 +100330,743 @@ "kind": "union_of" } }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "b" + ], + "description": "The Elasticsearch build hash. For example: `5c03844`.", + "name": "build" + }, + { + "aliases": [ + "cs", + "completionSize" + ], + "description": "The size of completion. For example: `0b`.", + "name": "completion.size" + }, + { + "description": "The percentage of recent system CPU used.", + "name": "cpu" + }, + { + "aliases": [ + "d", + "disk", + "diskAvail" + ], + "description": "The available disk space. For example: `198.4gb`.", + "name": "disk.avail" + }, + { + "aliases": [ + "dt", + "diskTotal" + ], + "description": "The total disk space. For example: `458.3gb`.", + "name": "disk.total" + }, + { + "aliases": [ + "du", + "diskUsed" + ], + "description": "The used disk space. For example: `259.8gb`.", + "name": "disk.used" + }, + { + "aliases": [ + "dup", + "diskUsedPercent" + ], + "description": "The percentage of disk space used.", + "name": "disk.used_percent" + }, + { + "aliases": [ + "fe", + "fielddataEvictions" + ], + "description": "The number of fielddata cache evictions.", + "name": "fielddata.evictions" + }, + { + "aliases": [ + "fm", + "fielddataMemory" + ], + "description": "The fielddata cache memory used. For example: `0b`.", + "name": "fielddata.memory_size" + }, + { + "aliases": [ + "fdc", + "fileDescriptorCurrent" + ], + "description": "The number of file descriptors used.", + "name": "file_desc.current" + }, + { + "aliases": [ + "fdm", + "fileDescriptorMax" + ], + "description": "The maximum number of file descriptors.", + "name": "file_desc.max" + }, + { + "aliases": [ + "fdp", + "fileDescriptorPercent" + ], + "description": "The percentage of file descriptors used.", + "name": "file_desc.percent" + }, + { + "aliases": [ + "ft", + "flushTotal" + ], + "description": "The number of flushes.", + "name": "flush.total" + }, + { + "aliases": [ + "ftt", + "flushTotalTime" + ], + "description": "The amount of time spent in flush.", + "name": "flush.total_time" + }, + { + "aliases": [ + "gc", + "getCurrent" + ], + "description": "The number of current get operations.", + "name": "get.current" + }, + { + "aliases": [ + "geti", + "getExistsTime" + ], + "description": "The time spent in successful get operations. For example: `14ms`.", + "name": "get.exists_time" + }, + { + "aliases": [ + "geto", + "getExistsTotal" + ], + "description": "The number of successful get operations.", + "name": "get.exists_total" + }, + { + "aliases": [ + "gmti", + "getMissingTime" + ], + "description": "The time spent in failed get operations. For example: `0s`.", + "name": "get.missing_time" + }, + { + "aliases": [ + "gmto", + "getMissingTotal" + ], + "description": "The number of failed get operations.", + "name": "get.missing_total" + }, + { + "aliases": [ + "gti", + "getTime" + ], + "description": "The amount of time spent in get operations. For example: `14ms`.", + "name": "get.time" + }, + { + "aliases": [ + "gto", + "getTotal" + ], + "description": "The number of get operations.", + "name": "get.total" + }, + { + "aliases": [ + "hc", + "heapCurrent" + ], + "description": "The used heap size. For example: `311.2mb`.", + "name": "heap.current" + }, + { + "aliases": [ + "hm", + "heapMax" + ], + "description": "The total heap size. For example: `4gb`.", + "name": "heap.max" + }, + { + "aliases": [ + "hp", + "heapPercent" + ], + "description": "The used percentage of total allocated Elasticsearch JVM heap.\nThis value reflects only the Elasticsearch process running within the operating system and is the most direct indicator of its JVM, heap, or memory resource performance.", + "name": "heap.percent" + }, + { + "aliases": [ + "http" + ], + "description": "The bound HTTP address.", + "name": "http_address" + }, + { + "aliases": [ + "nodeId" + ], + "description": "The identifier for the node.", + "name": "id" + }, + { + "aliases": [ + "idc", + "indexingDeleteCurrent" + ], + "description": "The number of current deletion operations.", + "name": "indexing.delete_current" + }, + { + "aliases": [ + "idti", + "indexingDeleteTime" + ], + "description": "The time spent in deletion operations. For example: `2ms`.", + "name": "indexing.delete_time" + }, + { + "aliases": [ + "idto", + "indexingDeleteTotal" + ], + "description": "The number of deletion operations.", + "name": "indexing.delete_total" + }, + { + "aliases": [ + "iic", + "indexingIndexCurrent" + ], + "description": "The number of current indexing operations.", + "name": "indexing.index_current" + }, + { + "aliases": [ + "iif", + "indexingIndexFailed" + ], + "description": "The number of failed indexing operations.", + "name": "indexing.index_failed" + }, + { + "aliases": [ + "iifvc", + "indexingIndexFailedDueToVersionConflict" + ], + "description": "The number of indexing operations that failed due to version conflict.", + "name": "indexing.index_failed_due_to_version_conflict" + }, + { + "aliases": [ + "iiti", + "indexingIndexTime" + ], + "description": "The time spent in indexing operations. For example: `134ms`.", + "name": "indexing.index_time" + }, + { + "aliases": [ + "iito", + "indexingIndexTotal" + ], + "description": "The number of indexing operations.", + "name": "indexing.index_total" + }, + { + "aliases": [ + "i" + ], + "description": "The IP address.", + "name": "ip" + }, + { + "aliases": [ + "j" + ], + "description": "The Java version. For example: `1.8.0`.", + "name": "jdk" + }, + { + "aliases": [ + "l" + ], + "description": "The most recent load average. For example: `0.22`.", + "name": "load_1m" + }, + { + "aliases": [ + "l" + ], + "description": "The load average for the last five minutes. For example: `0.78`.", + "name": "load_5m" + }, + { + "aliases": [ + "l" + ], + "description": "The load average for the last fifteen minutes. For example: `1.24`.", + "name": "load_15m" + }, + { + "aliases": [ + "mtc", + "mappingsTotalCount" + ], + "description": "The number of mappings, including runtime and object fields.", + "name": "mappings.total_count" + }, + { + "aliases": [ + "mteo", + "mappingsTotalEstimatedOverheadInBytes" + ], + "description": "The estimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field.", + "name": "mappings.total_estimated_overhead_in_bytes" + }, + { + "aliases": [ + "m" + ], + "description": "Indicates whether the node is the elected master node.\nReturned values include `*` (elected master) and `-` (not elected master).", + "name": "master" + }, + { + "aliases": [ + "mc", + "mergesCurrent" + ], + "description": "The number of current merge operations.", + "name": "merges.current" + }, + { + "aliases": [ + "mcd", + "mergesCurrentDocs" + ], + "description": "The number of current merging documents.", + "name": "merges.current_docs" + }, + { + "aliases": [ + "mcs", + "mergesCurrentSize" + ], + "description": "The size of current merges. For example: `0b`.", + "name": "merges.current_size" + }, + { + "aliases": [ + "mt", + "mergesTotal" + ], + "description": "The number of completed merge operations.", + "name": "merges.total" + }, + { + "aliases": [ + "mtd", + "mergesTotalDocs" + ], + "description": "The number of merged documents.", + "name": "merges.total_docs" + }, + { + "aliases": [ + "mts", + "mergesTotalSize" + ], + "description": "The total size of merges. For example: `0b`.", + "name": "merges.total_size" + }, + { + "aliases": [ + "mtt", + "mergesTotalTime" + ], + "description": "The time spent merging documents. For example: `0s`.", + "name": "merges.total_time" + }, + { + "aliases": [ + "n" + ], + "description": "The node name.", + "name": "name" + }, + { + "aliases": [ + "r", + "role", + "nodeRole" + ], + "description": "The roles of the node.\nReturned values include `c` (cold node), `d` (data node), `f` (frozen node), `h` (hot node), `i` (ingest node), `l` (machine learning node), `m` (master-eligible node), `r` (remote cluster client node), `s` (content node), `t` (transform node), `v` (voting-only node), `w` (warm node), and `-` (coordinating node only).\nFor example, `dim` indicates a master-eligible data and ingest node.", + "name": "node.role" + }, + { + "aliases": [ + "p" + ], + "description": "The process identifier.", + "name": "pid" + }, + { + "aliases": [ + "po" + ], + "description": "The bound transport port number.", + "name": "port" + }, + { + "aliases": [ + "qcm", + "queryCacheMemory" + ], + "description": "The used query cache memory. For example: `0b`.", + "name": "query_cache.memory_size" + }, + { + "aliases": [ + "qce", + "queryCacheEvictions" + ], + "description": "The number of query cache evictions.", + "name": "query_cache.evictions" + }, + { + "aliases": [ + "qchc", + "queryCacheHitCount" + ], + "description": "The query cache hit count.", + "name": "query_cache.hit_count" + }, + { + "aliases": [ + "qcmc", + "queryCacheMissCount" + ], + "description": "The query cache miss count.", + "name": "query_cache.miss_count" + }, + { + "aliases": [ + "rc", + "ramCurrent" + ], + "description": "The used total memory. For example: `513.4mb`.", + "name": "ram.current" + }, + { + "aliases": [ + "rm", + "ramMax" + ], + "description": "The total memory. For example: `2.9gb`.", + "name": "ram.max" + }, + { + "aliases": [ + "rp", + "ramPercent" + ], + "description": "The used percentage of the total operating system memory.\nThis reflects all processes running on the operating system instead of only Elasticsearch and is not guaranteed to correlate to its performance.", + "name": "ram.percent" + }, + { + "aliases": [ + "rto", + "refreshTotal" + ], + "description": "The number of refresh operations.", + "name": "refresh.total" + }, + { + "aliases": [ + "rti", + "refreshTime" + ], + "description": "The time spent in refresh operations. For example: `91ms`.", + "name": "refresh.time" + }, + { + "aliases": [ + "rcm", + "requestCacheMemory" + ], + "description": "The used request cache memory. For example: `0b`.", + "name": "request_cache.memory_size" + }, + { + "aliases": [ + "rce", + "requestCacheEvictions" + ], + "description": "The number of request cache evictions.", + "name": "request_cache.evictions" + }, + { + "aliases": [ + "rchc", + "requestCacheHitCount" + ], + "description": "The request cache hit count.", + "name": "request_cache.hit_count" + }, + { + "aliases": [ + "rcmc", + "requestCacheMissCount" + ], + "description": "The request cache miss count.", + "name": "request_cache.miss_count" + }, + { + "aliases": [ + "scrcc", + "scriptCompilations" + ], + "description": "The number of total script compilations.", + "name": "script.compilations" + }, + { + "aliases": [ + "scrce", + "scriptCacheEvictions" + ], + "description": "The number of total compiled scripts evicted from cache.", + "name": "script.cache_evictions" + }, + { + "aliases": [ + "sfc", + "searchFetchCurrent" + ], + "description": "The number of current fetch phase operations.", + "name": "search.fetch_current" + }, + { + "aliases": [ + "sfti", + "searchFetchTime" + ], + "description": "The time spent in fetch phase. For example: `37ms`.", + "name": "search.fetch_time" + }, + { + "aliases": [ + "sfto", + "searchFetchTotal" + ], + "description": "The number of fetch operations.", + "name": "search.fetch_total" + }, + { + "aliases": [ + "so", + "searchOpenContexts" + ], + "description": "The number of open search contexts.", + "name": "search.open_contexts" + }, + { + "aliases": [ + "sqc", + "searchQueryCurrent" + ], + "description": "The number of current query phase operations.", + "name": "search.query_current" + }, + { + "aliases": [ + "sqti", + "searchQueryTime" + ], + "description": "The time spent in query phase. For example: `43ms`.", + "name": "search.query_time" + }, + { + "aliases": [ + "sqto", + "searchQueryTotal" + ], + "description": "The number of query operations.", + "name": "search.query_total" + }, + { + "aliases": [ + "scc", + "searchScrollCurrent" + ], + "description": "The number of open scroll contexts.", + "name": "search.scroll_current" + }, + { + "aliases": [ + "scti", + "searchScrollTime" + ], + "description": "The amount of time scroll contexts were held open. For example: `2m`.", + "name": "search.scroll_time" + }, + { + "aliases": [ + "scto", + "searchScrollTotal" + ], + "description": "The number of completed scroll contexts.", + "name": "search.scroll_total" + }, + { + "aliases": [ + "sc", + "segmentsCount" + ], + "description": "The number of segments.", + "name": "segments.count" + }, + { + "aliases": [ + "sfbm", + "fixedBitsetMemory" + ], + "description": "The memory used by fixed bit sets for nested object field types and type filters for types referred in join fields.\nFor example: `1.0kb`.", + "name": "segments.fixed_bitset_memory" + }, + { + "aliases": [ + "siwm", + "segmentsIndexWriterMemory" + ], + "description": "The memory used by the index writer. For example: `18mb`.", + "name": "segments.index_writer_memory" + }, + { + "aliases": [ + "sm", + "segmentsMemory" + ], + "description": "The memory used by segments. For example: `1.4kb`.", + "name": "segments.memory" + }, + { + "aliases": [ + "svmm", + "segmentsVersionMapMemory" + ], + "description": "The memory used by the version map. For example: `1.0kb`.", + "name": "segments.version_map_memory" + }, + { + "aliases": [ + "sstc", + "shards", + "shardStatsTotalCount" + ], + "description": "The number of shards assigned.", + "name": "shard_stats.total_count" + }, + { + "aliases": [ + "suc", + "suggestCurrent" + ], + "description": "The number of current suggest operations.", + "name": "suggest.current" + }, + { + "aliases": [ + "suti", + "suggestTime" + ], + "description": "The time spent in suggest operations.", + "name": "suggest.time" + }, + { + "aliases": [ + "suto", + "suggestTotal" + ], + "description": "The number of suggest operations.", + "name": "suggest.total" + }, + { + "aliases": [ + "u" + ], + "description": "The amount of node uptime. For example: `17.3m`.", + "name": "uptime" + }, + { + "aliases": [ + "v" + ], + "description": "The Elasticsearch version. For example: `9.0.0`.", + "name": "version" + } + ], + "name": { + "name": "CatNodeColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L560-L1011" + }, + { + "kind": "type_alias", + "name": { + "name": "CatNodeColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L1015-L1015", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CatNodeColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatNodeColumn", + "namespace": "cat._types" + } + } + } + ], + "kind": "union_of" + } + }, { "kind": "enum", "members": [ @@ -100420,7 +101180,7 @@ "name": "CatTrainedModelsColumn", "namespace": "cat._types" }, - "specLocation": "cat/_types/CatBase.ts#L561-L635" + "specLocation": "cat/_types/CatBase.ts#L1017-L1091" }, { "kind": "type_alias", @@ -100428,7 +101188,7 @@ "name": "CatTrainedModelsColumns", "namespace": "cat._types" }, - "specLocation": "cat/_types/CatBase.ts#L636-L638", + "specLocation": "cat/_types/CatBase.ts#L1092-L1094", "type": { "items": [ { @@ -100694,7 +101454,7 @@ "name": "CatTransformColumn", "namespace": "cat._types" }, - "specLocation": "cat/_types/CatBase.ts#L640-L844" + "specLocation": "cat/_types/CatBase.ts#L1096-L1300" }, { "kind": "type_alias", @@ -100702,7 +101462,7 @@ "name": "CatTransformColumns", "namespace": "cat._types" }, - "specLocation": "cat/_types/CatBase.ts#L845-L845", + "specLocation": "cat/_types/CatBase.ts#L1301-L1301", "type": { "items": [ { @@ -104164,7 +104924,7 @@ "name": "AlibabaCloudServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L289-L291" + "specLocation": "inference/_types/CommonTypes.ts#L291-L293" }, { "kind": "enum", @@ -104186,7 +104946,7 @@ "name": "AlibabaCloudTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L282-L287" + "specLocation": "inference/_types/CommonTypes.ts#L284-L289" }, { "kind": "enum", @@ -104199,7 +104959,7 @@ "name": "AmazonBedrockServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L368-L370" + "specLocation": "inference/_types/CommonTypes.ts#L370-L372" }, { "kind": "enum", @@ -104215,7 +104975,7 @@ "name": "AmazonBedrockTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L363-L366" + "specLocation": "inference/_types/CommonTypes.ts#L365-L368" }, { "kind": "enum", @@ -104228,7 +104988,7 @@ "name": "AnthropicServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L421-L423" + "specLocation": "inference/_types/CommonTypes.ts#L423-L425" }, { "kind": "enum", @@ -104241,7 +105001,7 @@ "name": "AnthropicTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L417-L419" + "specLocation": "inference/_types/CommonTypes.ts#L419-L421" }, { "kind": "enum", @@ -104254,7 +105014,7 @@ "name": "AzureAiStudioServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L504-L506" + "specLocation": "inference/_types/CommonTypes.ts#L506-L508" }, { "kind": "enum", @@ -104270,7 +105030,7 @@ "name": "AzureAiStudioTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L499-L502" + "specLocation": "inference/_types/CommonTypes.ts#L501-L504" }, { "kind": "enum", @@ -104283,7 +105043,7 @@ "name": "AzureOpenAIServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L568-L570" + "specLocation": "inference/_types/CommonTypes.ts#L570-L572" }, { "kind": "enum", @@ -104299,7 +105059,7 @@ "name": "AzureOpenAITaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L563-L566" + "specLocation": "inference/_types/CommonTypes.ts#L565-L568" }, { "kind": "enum", @@ -104318,7 +105078,7 @@ "name": "CohereEmbeddingType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L625-L629" + "specLocation": "inference/_types/CommonTypes.ts#L627-L631" }, { "kind": "enum", @@ -104340,7 +105100,7 @@ "name": "CohereInputType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L631-L636" + "specLocation": "inference/_types/CommonTypes.ts#L633-L638" }, { "kind": "enum", @@ -104353,7 +105113,7 @@ "name": "CohereServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L621-L623" + "specLocation": "inference/_types/CommonTypes.ts#L623-L625" }, { "kind": "enum", @@ -104372,7 +105132,7 @@ "name": "CohereSimilarityType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L638-L642" + "specLocation": "inference/_types/CommonTypes.ts#L640-L644" }, { "kind": "enum", @@ -104391,7 +105151,7 @@ "name": "CohereTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L615-L619" + "specLocation": "inference/_types/CommonTypes.ts#L617-L621" }, { "kind": "enum", @@ -104410,7 +105170,7 @@ "name": "CohereTruncateType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L644-L648" + "specLocation": "inference/_types/CommonTypes.ts#L646-L650" }, { "codegenNames": [ @@ -104422,7 +105182,7 @@ "name": "CompletionToolType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L79-L82", + "specLocation": "inference/_types/CommonTypes.ts#L81-L84", "type": { "items": [ { @@ -104476,7 +105236,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L168-L180" + "specLocation": "inference/_types/CommonTypes.ts#L170-L182" }, { "description": "The tool choice function.", @@ -104499,7 +105259,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L157-L166" + "specLocation": "inference/_types/CommonTypes.ts#L159-L168" }, { "description": "Text Embedding results containing bytes are represented as Dense\nVectors of bytes.", @@ -104550,7 +105310,7 @@ "name": "ElasticsearchServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L754-L756" + "specLocation": "inference/_types/CommonTypes.ts#L756-L758" }, { "kind": "enum", @@ -104569,7 +105329,7 @@ "name": "ElasticsearchTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L748-L752" + "specLocation": "inference/_types/CommonTypes.ts#L750-L754" }, { "kind": "enum", @@ -104582,7 +105342,7 @@ "name": "ElserServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L790-L792" + "specLocation": "inference/_types/CommonTypes.ts#L792-L794" }, { "kind": "enum", @@ -104595,7 +105355,7 @@ "name": "ElserTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L786-L788" + "specLocation": "inference/_types/CommonTypes.ts#L788-L790" }, { "kind": "enum", @@ -104608,7 +105368,7 @@ "name": "GoogleAiServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L817-L819" + "specLocation": "inference/_types/CommonTypes.ts#L819-L821" }, { "kind": "enum", @@ -104624,7 +105384,7 @@ "name": "GoogleAiStudioTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L812-L815" + "specLocation": "inference/_types/CommonTypes.ts#L814-L817" }, { "kind": "enum", @@ -104637,7 +105397,7 @@ "name": "GoogleVertexAIServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L865-L867" + "specLocation": "inference/_types/CommonTypes.ts#L867-L869" }, { "kind": "enum", @@ -104653,7 +105413,7 @@ "name": "GoogleVertexAITaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L860-L863" + "specLocation": "inference/_types/CommonTypes.ts#L862-L865" }, { "kind": "enum", @@ -104666,7 +105426,7 @@ "name": "HuggingFaceServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L896-L898" + "specLocation": "inference/_types/CommonTypes.ts#L898-L900" }, { "kind": "enum", @@ -104679,7 +105439,7 @@ "name": "HuggingFaceTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L892-L894" + "specLocation": "inference/_types/CommonTypes.ts#L894-L896" }, { "kind": "enum", @@ -104692,7 +105452,7 @@ "name": "JinaAIServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L959-L961" + "specLocation": "inference/_types/CommonTypes.ts#L961-L963" }, { "kind": "enum", @@ -104711,7 +105471,7 @@ "name": "JinaAISimilarityType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L963-L967" + "specLocation": "inference/_types/CommonTypes.ts#L965-L969" }, { "kind": "enum", @@ -104727,7 +105487,7 @@ "name": "JinaAITaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L954-L957" + "specLocation": "inference/_types/CommonTypes.ts#L956-L959" }, { "kind": "enum", @@ -104749,7 +105509,7 @@ "name": "JinaAITextEmbeddingTask", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L969-L974" + "specLocation": "inference/_types/CommonTypes.ts#L971-L976" }, { "codegenNames": [ @@ -104761,7 +105521,7 @@ "name": "MessageContent", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L130-L133", + "specLocation": "inference/_types/CommonTypes.ts#L132-L135", "type": { "items": [ { @@ -104818,7 +105578,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L84-L96" + "specLocation": "inference/_types/CommonTypes.ts#L86-L98" }, { "kind": "enum", @@ -104831,7 +105591,7 @@ "name": "MistralServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L1009-L1011" + "specLocation": "inference/_types/CommonTypes.ts#L1011-L1013" }, { "kind": "enum", @@ -104844,7 +105604,7 @@ "name": "MistralTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L1005-L1007" + "specLocation": "inference/_types/CommonTypes.ts#L1007-L1009" }, { "kind": "enum", @@ -104857,7 +105617,7 @@ "name": "OpenAIServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L1071-L1073" + "specLocation": "inference/_types/CommonTypes.ts#L1073-L1075" }, { "kind": "enum", @@ -104876,7 +105636,7 @@ "name": "OpenAITaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L1065-L1069" + "specLocation": "inference/_types/CommonTypes.ts#L1067-L1071" }, { "kind": "type_alias", @@ -104963,7 +105723,7 @@ "name": "VoyageAIServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L1139-L1141" + "specLocation": "inference/_types/CommonTypes.ts#L1141-L1143" }, { "kind": "enum", @@ -104979,7 +105739,7 @@ "name": "VoyageAITaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L1134-L1137" + "specLocation": "inference/_types/CommonTypes.ts#L1136-L1139" }, { "kind": "enum", @@ -104992,7 +105752,7 @@ "name": "WatsonxServiceType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L1186-L1188" + "specLocation": "inference/_types/CommonTypes.ts#L1188-L1190" }, { "kind": "enum", @@ -105005,7 +105765,7 @@ "name": "WatsonxTaskType", "namespace": "inference._types" }, - "specLocation": "inference/_types/CommonTypes.ts#L1182-L1184" + "specLocation": "inference/_types/CommonTypes.ts#L1184-L1186" }, { "kind": "enum", @@ -125242,7 +126002,7 @@ }, "properties": [ { - "description": "A list of objects representing the conversation.", + "description": "A list of objects representing the conversation.\nRequests should generally only add new messages from the user (role `user`).\nThe other message roles (`assistant`, `system`, or `tool`) should generally only be copied from the response to a previous completion request, such that the messages array is built up throughout a conversation.", "name": "messages", "required": true, "type": { @@ -125347,7 +126107,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L25-L58" + "specLocation": "inference/_types/CommonTypes.ts#L25-L60" }, { "description": "An object representing part of the conversation.", @@ -125409,7 +126169,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L135-L155" + "specLocation": "inference/_types/CommonTypes.ts#L137-L157" }, { "description": "A tool call generated by the model.", @@ -125456,7 +126216,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L112-L128" + "specLocation": "inference/_types/CommonTypes.ts#L114-L130" }, { "description": "The function that the model called.", @@ -125491,7 +126251,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L98-L110" + "specLocation": "inference/_types/CommonTypes.ts#L100-L112" }, { "description": "A list of tools that the model can call.", @@ -125526,7 +126286,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L205-L217" + "specLocation": "inference/_types/CommonTypes.ts#L207-L219" }, { "description": "The completion tool function definition.", @@ -125581,7 +126341,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L182-L203" + "specLocation": "inference/_types/CommonTypes.ts#L184-L205" }, { "description": "Defines the completion result.", @@ -126101,7 +126861,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L219-L264" + "specLocation": "inference/_types/CommonTypes.ts#L221-L266" }, { "kind": "interface", @@ -126157,7 +126917,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L266-L280" + "specLocation": "inference/_types/CommonTypes.ts#L268-L282" }, { "kind": "interface", @@ -126245,7 +127005,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L293-L335" + "specLocation": "inference/_types/CommonTypes.ts#L295-L337" }, { "kind": "interface", @@ -126304,7 +127064,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L337-L361" + "specLocation": "inference/_types/CommonTypes.ts#L339-L363" }, { "kind": "interface", @@ -126351,7 +127111,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L372-L388" + "specLocation": "inference/_types/CommonTypes.ts#L374-L390" }, { "kind": "interface", @@ -126411,7 +127171,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L390-L415" + "specLocation": "inference/_types/CommonTypes.ts#L392-L417" }, { "kind": "interface", @@ -126485,7 +127245,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L425-L467" + "specLocation": "inference/_types/CommonTypes.ts#L427-L469" }, { "kind": "interface", @@ -126556,7 +127316,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L469-L497" + "specLocation": "inference/_types/CommonTypes.ts#L471-L499" }, { "kind": "interface", @@ -126648,7 +127408,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L508-L553" + "specLocation": "inference/_types/CommonTypes.ts#L510-L555" }, { "kind": "interface", @@ -126670,7 +127430,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L555-L561" + "specLocation": "inference/_types/CommonTypes.ts#L557-L563" }, { "kind": "interface", @@ -126743,7 +127503,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L572-L613" + "specLocation": "inference/_types/CommonTypes.ts#L574-L615" }, { "kind": "interface", @@ -126801,7 +127561,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L650-L682" + "specLocation": "inference/_types/CommonTypes.ts#L652-L684" }, { "kind": "interface", @@ -126873,7 +127633,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L704-L738" + "specLocation": "inference/_types/CommonTypes.ts#L706-L740" }, { "kind": "interface", @@ -126920,7 +127680,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L60-L77" + "specLocation": "inference/_types/CommonTypes.ts#L62-L79" }, { "kind": "interface", @@ -126943,7 +127703,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L740-L746" + "specLocation": "inference/_types/CommonTypes.ts#L742-L748" }, { "kind": "interface", @@ -126989,7 +127749,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L758-L784" + "specLocation": "inference/_types/CommonTypes.ts#L760-L786" }, { "kind": "interface", @@ -127037,7 +127797,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L794-L810" + "specLocation": "inference/_types/CommonTypes.ts#L796-L812" }, { "kind": "interface", @@ -127111,7 +127871,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L821-L847" + "specLocation": "inference/_types/CommonTypes.ts#L823-L849" }, { "kind": "interface", @@ -127145,7 +127905,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L849-L858" + "specLocation": "inference/_types/CommonTypes.ts#L851-L860" }, { "kind": "interface", @@ -127193,7 +127953,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L869-L890" + "specLocation": "inference/_types/CommonTypes.ts#L871-L892" }, { "kind": "interface", @@ -127255,7 +128015,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L900-L929" + "specLocation": "inference/_types/CommonTypes.ts#L902-L931" }, { "kind": "interface", @@ -127301,7 +128061,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L931-L952" + "specLocation": "inference/_types/CommonTypes.ts#L933-L954" }, { "kind": "interface", @@ -127363,7 +128123,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L976-L1003" + "specLocation": "inference/_types/CommonTypes.ts#L978-L1005" }, { "kind": "interface", @@ -127450,7 +128210,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L1013-L1055" + "specLocation": "inference/_types/CommonTypes.ts#L1015-L1057" }, { "kind": "interface", @@ -127472,7 +128232,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L1057-L1063" + "specLocation": "inference/_types/CommonTypes.ts#L1059-L1065" }, { "kind": "interface", @@ -127536,7 +128296,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L1075-L1106" + "specLocation": "inference/_types/CommonTypes.ts#L1077-L1108" }, { "kind": "interface", @@ -127596,7 +128356,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L1108-L1132" + "specLocation": "inference/_types/CommonTypes.ts#L1110-L1134" }, { "kind": "interface", @@ -127684,7 +128444,7 @@ } } ], - "specLocation": "inference/_types/CommonTypes.ts#L1143-L1180" + "specLocation": "inference/_types/CommonTypes.ts#L1145-L1182" }, { "description": "Defines the response for a rerank request.",