Skip to content

Adds custom InferenceEndpointInfo class for JinaAI #4391

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 21, 2025

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented May 21, 2025

Overview

The Response Attributes section of the reference documentation currently displays the task_types defined in the TaskType enum used by the InferenceEndpointInfo class. However, InferenceEndpointInfo is not specific to any particular inference API integration — it lists all available task types, not just those relevant to the specific integration being documented (see screenshot below).

Create_an_JinaAI_inference_endpoint___Elasticsearch_API_documentation__v9_

Link to docs

The screenshot shows the Response Attributes section of the JinaAI integration documentation. JinaAI supports only two task types: rerank and text_embedding, which are correctly listed under path parameters.

This PR introduces a new TaskTypeJinaAi enum that includes only the relevant task types and references it in the newly added InferenceEndpointInfoJinaAI class. As a result, the documentation will now accurately display only the supported task types for this integration — even in the Response Attributes section.

Copy link
Contributor

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

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 requested a review from l-trotta May 21, 2025 08:47
Copy link
Contributor

@l-trotta l-trotta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@szabosteve szabosteve merged commit 6e92645 into main May 21, 2025
8 checks passed
@szabosteve szabosteve deleted the szabosteve/endpoint-info-amend branch May 21, 2025 10:56
Copy link
Contributor

The backport to 8.19 failed:

The process '/usr/bin/git' failed with exit code 1

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-8.19 8.19
# Navigate to the new working tree
cd .worktrees/backport-8.19
# Create a new branch
git switch --create backport-4391-to-8.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6e9264533e8ea359ea68f6af8efdfa4da916d323
# Push it to GitHub
git push --set-upstream origin backport-4391-to-8.19
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.19

Then, create a pull request where the base branch is 8.19 and the compare/head branch is backport-4391-to-8.19.

Copy link
Contributor

The backport to 8.18 failed:

The process '/usr/bin/git' failed with exit code 1

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-8.18 8.18
# Navigate to the new working tree
cd .worktrees/backport-8.18
# Create a new branch
git switch --create backport-4391-to-8.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6e9264533e8ea359ea68f6af8efdfa4da916d323
# Push it to GitHub
git push --set-upstream origin backport-4391-to-8.18
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.18

Then, create a pull request where the base branch is 8.18 and the compare/head branch is backport-4391-to-8.18.

github-actions bot pushed a commit that referenced this pull request May 21, 2025
* Adds custom InferenceEndpointInfo class for JinaAI.

* Format fix.

(cherry picked from commit 6e92645)
szabosteve added a commit that referenced this pull request May 21, 2025
* Adds custom InferenceEndpointInfo class for JinaAI.

* Format fix.

(cherry picked from commit 6e92645)

Co-authored-by: István Zoltán Szabó <[email protected]>
szabosteve added a commit that referenced this pull request May 21, 2025
* Adds custom InferenceEndpointInfo class for JinaAI.

* Format fix.
szabosteve added a commit that referenced this pull request May 21, 2025
* Adds custom InferenceEndpointInfo class for JinaAI.

* Format fix.
szabosteve added a commit that referenced this pull request May 21, 2025
* Adds custom InferenceEndpointInfo class for JinaAI.

* Format fix.
szabosteve added a commit that referenced this pull request May 21, 2025
* Adds custom InferenceEndpointInfo class for JinaAI.

* Format fix.
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.

2 participants