docs: [js] Add file input support for chat completion in orchestration service#410
docs: [js] Add file input support for chat completion in orchestration service#410davidkna-sap merged 10 commits intomainfrom
Conversation
davidkna-sap
force-pushed
the
davidkna-sap_fileinpdoc
branch
from
211bed8 to
5478181
Compare
* origin/main: chore(deps-dev): bump @typescript-eslint/eslint-plugin (#416) chore(deps-dev): bump @typescript-eslint/parser from 8.57.0 to 8.57.1 (#415) chore: Updated deprecated model list (#414) [JS] Add API docs reference (#394) chore(deps-dev): bump @typescript-eslint/eslint-plugin (#412) chore: [JS] Fix resilience documentation across multiple modules (#405)
davidkna-sap
added
waiting for release
|
|
||
| ::: | ||
|
|
||
| For file input, the [content block](pathname:///api/v2/types/orchestration_src.FileContent.html) should have `type: 'file'` and include a [`file`](pathname:///api/v2/types/orchestration_src.FileContent.html) object with a `file_data` property containing a URL. |
There was a problem hiding this comment.
If both anchors should point to the same location, I believe that a rephrasing would be great with only one link remaining.
There was a problem hiding this comment.
Updated the first link.
| :::note | ||
|
|
||
| Orchestration file input support may not match the file input capabilities of each individual model, as the orchestration service may only support a subset of file types for certain models. | ||
| Please always check if the specific file type you want to use is supported by the orchestration service for your chosen model. | ||
|
|
||
| ::: |
There was a problem hiding this comment.
[suggestion] Maybe we can add a link to the available orchestration services?
There was a problem hiding this comment.
I haven't really seen documentation on the extent of support, but I have added the block to be a bit more clear.
| :::note | ||
|
|
||
| The `file` content type can only be used in messages with `role: 'user'`. | ||
| Attempting to use `file` in non-user messages will result in an error. | ||
|
|
||
| ::: | ||
|
|
||
| :::note | ||
|
|
||
| Orchestration file input support may not match the file input capabilities of each individual model, as the orchestration service may only support a subset of file types for certain models. | ||
| Please always check if the specific file type you want to use is supported by the orchestration service for your chosen model. | ||
|
|
||
| ::: |
There was a problem hiding this comment.
[personal opinion] I would avoid having two notes placed one after the other.
There was a problem hiding this comment.
I would like to avoid merging them, and the first matches the image input documentation. Do you have any ideas where the second note could fit?
There was a problem hiding this comment.
Maybe after this part or above the code snippet?
Data URLs must follow this format:
data:MIME_TYPE;base64,BASE64_ENCODED_FILE_CONTENT
Otherwise, I believe that it is fine this way as well.
Co-authored-by: BrigittaK307 <brigitta.kovacs@sap.com>
BrigittaK307
left a comment
BrigittaK307
left a comment
There was a problem hiding this comment.
Besides that small suggestion it LGTM.
3 participants
What Has Changed?
Explain what you are changing and why, if it isn't obvious from the diff.