@elastic/schemas 0.4.3 → 0.4.5

package/src/es/json/inference.stream_completion.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.stream_completion","type":"object","properties":{"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"},"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\nNOTE: Inference endpoints for the completion task type currently only support a single string as input.","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 streaming completion inference on the service.\n\nGet real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.\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). You must use a client that supports streaming."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.stream_completion","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"},"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\nNOTE: Inference endpoints for the completion task type currently only support a single string as input.","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 unique identifier for the inference endpoint.","x-found-in":"path"}},"required":["inference_id","input"],"description":"Perform streaming completion inference on the service.\n\nGet real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.\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). You must use a client that supports streaming."}

package/src/es/json/inference.text_embedding.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.text_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"},"input":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Inference input.\nEither a string or an array of strings.","x-found-in":"body"},"input_type":{"type":"string","description":"The input data type for the text embedding model. 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. 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 text embedding inference on the service."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.text_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"},"input":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Inference input.\nEither a string or an array of strings.","x-found-in":"body"},"input_type":{"type":"string","description":"The input data type for the text embedding model. 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. 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 text embedding inference on the service."}

package/src/es/json/inference.update.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.update","type":"object","properties":{"inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskType","description":"The type of inference task that the model performs.","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 updated.\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":"Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `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.\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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.update","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be updated.\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"},"inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskType","description":"The type of inference task that the model performs.","x-found-in":"path"}},"required":["inference_id"],"description":"Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `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.\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."}