API Docs: Update AI tutorial to include markdown block #2486
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2486 +/- ##
=======================================
Coverage 92.59% 92.59%
=======================================
Files 36 36
Lines 7472 7472
Branches 653 653
=======================================
Hits 6919 6919
Misses 545 545
Partials 8 8 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @@ -370,6 +370,27 @@ After getting the thread replies, we map them to the appropriate object structur | |||
|
|
|||
| The entirety of the user message processing in this example is wrapped in a try-catch block to provide the user an error message when something goes wrong, which is a best practice. If successful, the final action we take is to call the `say` method with the LLM response. | |||
|
|
|||
| #### Using the markdown block in `say` {#markdown-block} | |||
|
|
|||
| To safeguard against any markdown translation errors, we can return our text response inside of a [`Markdown block`](https://docs.slack.dev/reference/block-kit/blocks/markdown-block) in the `say` block, instead of relying on providing precise enough instructions to the LLM. Here's how that would look: | |||
There was a problem hiding this comment.
Suggested change
| To safeguard against any markdown translation errors, we can return our text response inside of a [`Markdown block`](https://docs.slack.dev/reference/block-kit/blocks/markdown-block) in the `say` block, instead of relying on providing precise enough instructions to the LLM. Here's how that would look: | |
| To safeguard against any markdown translation errors, we can return our text response inside of a [markdown block](https://docs.slack.dev/reference/block-kit/blocks/markdown-block) in the `say` block, instead of relying on providing precise enough instructions to the LLM. Here's how that would look: |
i don't think we put them in code blocks?
There was a problem hiding this comment.
i'd also use a different word than "block" for "say block"
technically-tracy
approved these changes
Apr 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Now that we have the markdown block available to help with markdown translations, we should have it in the tutorial as an option.
Requirements (place an
xin each[ ])