mirrors
/
elasticsearch
mirror of https://mirror.osredm.com/root/elasticsearch.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Adds note about differences between chat completion and stream API (#120636)

This commit is contained in:
István Zoltán Szabó 2025-01-23 14:41:12 +01:00 committed by GitHub
parent 0e5fe75250
commit 443f0f3ded
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/inference/chat-completion-inference.asciidoc
View File

@ -34,9 +34,13 @@ However, if you do not plan to use the {infer} APIs to use these models or if yo
The chat completion {infer} 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` {infer} services.
[NOTE]
====
The `chat_completion` task type is only available within the _unified API and only supports streaming.
* The `chat_completion` task type is only available within the _unified API and only supports streaming.
* The Chat completion {infer} API and the Stream {infer} API differ in their response structure and capabilities.
The Chat completion {infer} API provides more comprehensive customization options through more fields and function calling support.
If you use the `openai` service or the `elastic` service, use the Chat completion {infer} API.
====
[discrete]

4
docs/reference/inference/stream-inference.asciidoc
View File

@ -40,6 +40,10 @@ However, if you do not plan to use the {infer} APIs to use these models or if yo
The stream {infer} API enables real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.
It only works with the `completion` and `chat_completion` task types.
The Chat completion {infer} API and the Stream {infer} API differ in their response structure and capabilities.
The Chat completion {infer} API provides more comprehensive customization options through more fields and function calling support.
If you use the `openai` service or the `elastic` service, use the Chat completion {infer} API.
[NOTE]
====
include::inference-shared.asciidoc[tag=chat-completion-docs]