Add embedding inference task specification#5934
Conversation
This commit adds documentation and updates the API spec to include the new embedding inference task, which has been implemented for the JinaAI service. Additional changes in this commit: - Rename TextEmbedding*Result classes to DenseEmbedding*Result since they're used for both text-only and multimodal embeddings
DonalEvans
added
specification
documentation
skip-backport
|
Following you can find the validation changes against the target branch for the API.
You can validate this API yourself by using the |
output/schema/validation-errors.json
Outdated
| "Dangling type 'inference._types:AmazonSageMakerElementType'", | ||
| "Dangling type 'inference._types:AmazonSageMakerOpenAiTaskSettings'", | ||
| "Dangling type 'inference._types:AmazonSageMakerSimilarity'", | ||
| "Dangling type 'inference._types:JinaAIElementType'", |
There was a problem hiding this comment.
Can you please remove this now unused type?
There was a problem hiding this comment.
Ah, thanks for catching that. I was originally planning to fix some other issues with the documentation (such as not documenting the element type field for JinaAI) but decided to split those changes out into a separate PR to make backporting easier.
jonathan-buttner
left a comment
jonathan-buttner
left a comment
There was a problem hiding this comment.
Looks good, just not sure about the package*.json files.
| "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", | ||
| "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", | ||
| "license": "MIT", | ||
| "peer": true, |
There was a problem hiding this comment.
We do need these changes?
There was a problem hiding this comment.
I don't think they're strictly needed in the PR, but they get generated when preparing the docs using the steps here, so it doesn't feel wrong to include them I guess? The next person to run the commands in that quickstart document will generate the same changes anyway, I assume.
3 participants
Related Elasticsearch PR: elastic/elasticsearch#140696
This commit adds documentation and updates the API spec to include the new embedding inference task, which has been implemented for the JinaAI service.
Additional changes in this commit: