Merge branch 'main' into leemthompo/api-ref-links

Author: leemthompo

compiler-rs/clients_schema_to_openapi/src/paths.rs

@@ -502,18 +502,20 @@ fn split_summary_desc(desc: &str) -> SplitDesc{
 
 fn add_privileges(privileges: &Option<Privileges>) -> Option<String>{
     if let Some(privs) = privileges {
-        let mut result = "\n\n ## Required authorization\n".to_string();
+        let mut result = "\n\n## Required authorization\n\n".to_string();
         if !privs.index.is_empty() {
             result += "* Index privileges: ";
             result += &privs.index.iter()
                 .map(|a| format!("`{a}`"))
                 .join(",");
+            result += "\n";
         }
         if !privs.cluster.is_empty() {
             result += "* Cluster privileges: ";
             result += &privs.cluster.iter()
                 .map(|a| format!("`{a}`"))
                 .join(",");
+            result += "\n";
         }
         return Some(result)
     }

compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm

@@ -88,6 +88,7 @@ clear-repositories-metering-archive-api,https://www.elastic.co/docs/api/doc/elas
 clear-scroll-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll
 clear-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache
 cluster-allocation-explain,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain
+cluster-allocation-explain-examples,https://www.elastic.co/docs/troubleshoot/elasticsearch/cluster-allocation-api-examples
 cluster-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings
 cluster-health,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health
 cluster-info,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info

output/openapi/elasticsearch-openapi.json

@@ -28,10 +28,12 @@ import { Duration } from '@_types/Time'
  * For unassigned shards, it provides an explanation for why the shard is unassigned.
  * For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.
  * This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.
+ * Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API.
  * @rest_spec_name cluster.allocation_explain
  * @availability stack since=5.0.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @doc_id cluster-allocation-explain
+ * @ext_doc_id cluster-allocation-explain-examples
  * @doc_tag cluster
  */
 export interface Request extends RequestBase {

output/openapi/elasticsearch-serverless-openapi.json

@@ -47,10 +47,47 @@ export class RequestChatCompletion {
   temperature?: float
   /**
    * Controls which tool is called by the model.
+   * String representation: One of `auto`, `none`, or `requrired`. `auto` allows the model to choose between calling tools and generating a message. `none` causes the model to not call any tools. `required` forces the model to call one or more tools.
+   * Example (object representation):
+   * ```
+   * {
+   *   "tool_choice": {
+   *       "type": "function",
+   *       "function": {
+   *           "name": "get_current_weather"
+   *       }
+   *   }
+   * }
+   * ```
    */
   tool_choice?: CompletionToolType
   /**
    * A list of tools that the model can call.
+   * Example:
+   * ```
+   * {
+   *   "tools": [
+   *       {
+   *           "type": "function",
+   *           "function": {
+   *               "name": "get_price_of_item",
+   *               "description": "Get the current price of an item",
+   *               "parameters": {
+   *                   "type": "object",
+   *                   "properties": {
+   *                       "item": {
+   *                           "id": "12345"
+   *                       },
+   *                       "unit": {
+   *                           "type": "currency"
+   *                       }
+   *                   }
+   *               }
+   *           }
+   *       }
+   *   ]
+   * }
+   * ```
    */
   tools?: Array<CompletionTool>
   /**
@@ -140,18 +177,52 @@ export type MessageContent = string | Array<ContentObject>
 export interface Message {
   /**
    * The content of the message.
+   *
+   * String example:
+   * ```
+   * {
+   *    "content": "Some string"
+   * }
+   * ```
+   *
+   * Object example:
+   * ```
+   * {
+   *   "content": [
+   *       {
+   *        "text": "Some text",
+   *        "type": "text"
+   *       }
+   *    ]
+   * }
+   * ```
    */
   content?: MessageContent
   /**
-   * The role of the message author.
+   * The role of the message author. Valid values are `user`, `assistant`, `system`, and `tool`.
    */
   role: string
   /**
-   * The tool call that this message is responding to.
+   * Only for `tool` role messages. The tool call that this message is responding to.
    */
   tool_call_id?: Id
   /**
-   * The tool calls generated by the model.
+   * Only for `assistant` role messages. The tool calls generated by the model. If it's specified, the `content` field is optional.
+   * Example:
+   * ```
+   * {
+   *   "tool_calls": [
+   *       {
+   *           "id": "call_KcAjWtAww20AihPHphUh46Gd",
+   *           "type": "function",
+   *           "function": {
+   *               "name": "get_current_weather",
+   *               "arguments": "{\"location\":\"Boston, MA\"}"
+   *           }
+   *       }
+   *   ]
+   * }
+   * ```
    */
   tool_calls?: Array<ToolCall>
 }

output/schema/schema.json

@@ -40,8 +40,8 @@ import { TaskType } from '@inference/_types/TaskType'
  * * ELSER (`sparse_embedding`)
  * * Google AI Studio (`completion`, `text_embedding`)
  * * Google Vertex AI (`rerank`, `text_embedding`)
- * * Hugging Face (`text_embedding`)
- * * Mistral (`text_embedding`)
+ * * Hugging Face (`chat_completion`, `completion`, `text_embedding`)
+ * * Mistral (`chat_completion`, `completion`, `text_embedding`)
  * * OpenAI (`chat_completion`, `completion`, `text_embedding`)
  * * VoyageAI (`text_embedding`, `rerank`)
  * * Watsonx inference integration (`text_embedding`)

specification/_doc_ids/table.csv

@@ -30,7 +30,7 @@ import { InferenceChunkingSettings } from '@inference/_types/Services'
 /**
  * Create an Amazon Bedrock inference endpoint.
  *
- * Creates an inference endpoint to perform an inference task with the `amazonbedrock` service.
+ * Create an inference endpoint to perform an inference task with the `amazonbedrock` service.
  *
  * >info
  * > 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.