Skip to content

[8.19] [backport] Removes note from chat completion API #4462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,10 @@ import { Id } from '@_types/common'
import { Duration } from '@_types/Time'
/**
* Perform chat completion inference
*
* The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.
* It only works with the `chat_completion` task type for `openai`, `elastic` and `googlevertexai` inference services.

* IMPORTANT: 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.
*
*
* The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.
* It only works with the `chat_completion` task type for `openai` and `elastic` inference services.
*
* NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming.
* The Chat completion inference API and the Stream inference API differ in their response structure and capabilities.
* The Chat completion inference API provides more comprehensive customization options through more fields and function calling support.
Expand Down