Skip to content

Adds examples to chat completion inference API #4346

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 2 commits into from
May 6, 2025

Conversation

szabosteve
Copy link
Contributor

Overview

Closes #4343
Related to #4294

This PR adds working examples to the chat_completion inference API docs. It also provides some bits of info missing from the chat_completion API docs.

Copy link
Contributor

github-actions bot commented May 6, 2025

Following you can find the validation results for the APIs you have changed.

API Status Request Response
inference.chat_completion_unified Missing test Missing test
inference.completion Missing test Missing test
inference.delete Missing test Missing test
inference.get 🟢 1/1 1/1
inference.inference Missing test Missing test
inference.put_alibabacloud Missing test Missing test
inference.put_amazonbedrock Missing test Missing test
inference.put_anthropic Missing test Missing test
inference.put_azureaistudio Missing test Missing test
inference.put_azureopenai Missing test Missing test
inference.put_cohere Missing test Missing test
inference.put_elasticsearch Missing test Missing test
inference.put_elser Missing test Missing test
inference.put_googleaistudio Missing test Missing test
inference.put_googlevertexai Missing test Missing test
inference.put_hugging_face Missing test Missing test
inference.put_jinaai Missing test Missing test
inference.put_mistral Missing test Missing test
inference.put_openai Missing test Missing test
inference.put_voyageai Missing test Missing test
inference.put_watsonx Missing test Missing test
inference.put Missing test Missing test
inference.rerank Missing test Missing test
inference.sparse_embedding Missing test Missing test
inference.stream_completion Missing test Missing test
inference.text_embedding Missing test Missing test
inference.update Missing test Missing test

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

github-actions bot commented May 6, 2025

Following you can find the validation results for the APIs you have changed.

API Status Request Response
inference.chat_completion_unified Missing test Missing test
inference.completion Missing test Missing test
inference.delete Missing test Missing test
inference.get 🟢 1/1 1/1
inference.inference Missing test Missing test
inference.put_alibabacloud Missing test Missing test
inference.put_amazonbedrock Missing test Missing test
inference.put_anthropic Missing test Missing test
inference.put_azureaistudio Missing test Missing test
inference.put_azureopenai Missing test Missing test
inference.put_cohere Missing test Missing test
inference.put_elasticsearch Missing test Missing test
inference.put_elser Missing test Missing test
inference.put_googleaistudio Missing test Missing test
inference.put_googlevertexai Missing test Missing test
inference.put_hugging_face Missing test Missing test
inference.put_jinaai Missing test Missing test
inference.put_mistral Missing test Missing test
inference.put_openai Missing test Missing test
inference.put_voyageai Missing test Missing test
inference.put_watsonx Missing test Missing test
inference.put Missing test Missing test
inference.rerank Missing test Missing test
inference.sparse_embedding Missing test Missing test
inference.stream_completion Missing test Missing test
inference.text_embedding Missing test Missing test
inference.update Missing test Missing test

You can validate these APIs yourself by using the make validate target.

@szabosteve szabosteve merged commit b407c71 into main May 6, 2025
8 checks passed
@szabosteve szabosteve deleted the szabosteve/chat-completion-amends branch May 6, 2025 14:38
github-actions bot pushed a commit that referenced this pull request May 6, 2025
* Adds examples to chat completion inference API.

* Fixes format.

(cherry picked from commit b407c71)
github-actions bot pushed a commit that referenced this pull request May 6, 2025
* Adds examples to chat completion inference API.

* Fixes format.

(cherry picked from commit b407c71)
github-actions bot pushed a commit that referenced this pull request May 6, 2025
* Adds examples to chat completion inference API.

* Fixes format.

(cherry picked from commit b407c71)
szabosteve added a commit that referenced this pull request May 6, 2025
* Adds examples to chat completion inference API.

* Fixes format.

(cherry picked from commit b407c71)

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
szabosteve added a commit that referenced this pull request May 6, 2025
* Adds examples to chat completion inference API.

* Fixes format.

(cherry picked from commit b407c71)

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
szabosteve added a commit that referenced this pull request May 6, 2025
* Adds examples to chat completion inference API.

* Fixes format.

(cherry picked from commit b407c71)

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Provide example for chat_completion API
2 participants