Minor changes to the Inference API docs #5452
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidkyle
commented
Oct 9, 2025
| import { RequestChatCompletion } from '@inference/_types/CommonTypes' | ||
| /** | ||
| * Perform chat completion inference | ||
| * Perform chat completion inference on the service |
There was a problem hiding this comment.
Every other API description ends "on the service"
| summary: Completion task | ||
| description: Run `POST _inference/completion/openai_chat_completions` to perform a completion on the example question. | ||
| method_request: 'POST _inference/completion/openai_chat_completions' | ||
| description: Run `POST _inference/completion/openai_completions` to perform a completion on the example question. |
There was a problem hiding this comment.
The example is for completion not chat_completions
|
|
||
| /** | ||
| * Perform completion inference on the service | ||
| * Get responses for completion tasks. |
There was a problem hiding this comment.
This API had no desciption
| "model_id": "rerank-english-v3.0", | ||
| "api_key": "{{COHERE_API_KEY}}" | ||
| }, | ||
| "chunking_settings": { |
There was a problem hiding this comment.
Rerankers don't have chunking_settings
| */ | ||
| input: string | Array<string> | ||
| input: Array<string> | ||
| /** |
There was a problem hiding this comment.
Adding undocumented parameters
|
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
kosabogi
approved these changes
Oct 16, 2025
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-5452-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ccc753392ccbdcd3e4e1bb6ae210abd3cc1fa86c
# Push it to GitHub
git push --set-upstream origin backport-5452-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0Then, create a pull request where the |
github-actions bot
pushed a commit
that referenced
this pull request
Oct 16, 2025
Document rerank parameters and fix broken rerank example (cherry picked from commit ccc7533)
github-actions bot
pushed a commit
that referenced
this pull request
Oct 16, 2025
Document rerank parameters and fix broken rerank example (cherry picked from commit ccc7533)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.