docs: Add Batch API tutorial#464
Open
InjunPark-sap wants to merge 22 commits into
Open
Conversation
InjunPark-sap
changed the title
Member
Author
docs: Update batch-api tutorialChanges
|
davidkna-sap
requested changes
May 13, 2026
Co-authored-by: David Knaack <david.knaack@sap.com>
Co-authored-by: David Knaack <david.knaack@sap.com>
Member
davidkna-sap
left a comment
davidkna-sap
left a comment
There was a problem hiding this comment.
I have also un-resolved some of my earlier comments.
Co-authored-by: David Knaack <david.knaack@sap.com>
davidkna-sap
requested changes
May 27, 2026
InjunPark-sap
commented
May 28, 2026
Co-authored-by: David Knaack <david.knaack@sap.com>
| npm install @sap-ai-sdk/batch-api @sap-ai-sdk/ai-api @sap-ai-sdk/foundation-models | ||
| ``` | ||
|
|
||
| ## Step 1 — Configure an Object Store Secret |
Member
There was a problem hiding this comment.
[pp] These dashes look too wide in headings:
Suggested change
| ## Step 1 — Configure an Object Store Secret | |
| ## Configure an Object Store Secret |
|
|
||
| Once registered, reference it in your batch job using the `ai://SECRET_NAME/` URI format. | ||
|
|
||
| ## Step 2 — Prepare the Input File |
Member
There was a problem hiding this comment.
Suggested change
| ## Step 2 — Prepare the Input File | |
| ## Prepare the Input File |
| ).execute(); | ||
| ``` | ||
|
|
||
| ## Step 3 — Create a Batch Job |
Member
There was a problem hiding this comment.
Suggested change
| ## Step 3 — Create a Batch Job | |
| ## Create a Batch Job |
| | `CANCELLING` | Cancellation is in progress | | ||
| | `CANCELLED` | Job was cancelled | | ||
|
|
||
| ## Step 5 — Retrieve Results |
Member
There was a problem hiding this comment.
Suggested change
| ## Step 5 — Retrieve Results | |
| ## Retrieve Results |
Member
There was a problem hiding this comment.
[pp] Let's perhaps discuss in what section we want to put this, I feel like it would belong in AI Core services.
Comment on lines
+17
to
+19
| :::experimental | ||
| The `@sap-ai-sdk/batch-api` package is experimental and may change at any time without prior notice. | ||
| ::: |
Member
There was a problem hiding this comment.
:::experimental does not exist.
Suggested change
| :::experimental | |
| The `@sap-ai-sdk/batch-api` package is experimental and may change at any time without prior notice. | |
| ::: | |
| :::caution | |
| The `@sap-ai-sdk/batch-api` package is experimental and may change at any time without prior notice. | |
| ::: |
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
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.
What's changed
Add the LLM Batch API tutorial (
batch_api.mdx) to the JS docs sidebar.The tutorial document (
docs-js/tutorials/batch_api.mdx) already existed but was not registered insidebarsDocsJs.js, so it was not visible in local development or production builds.Changes
tutorials/using-llm-batch-apito the Tutorials category insidebarsDocsJs.js