[Workflows] Document category descriptions for the ai.classify step - #7644
Draft
nastasha-solomon wants to merge 2 commits into
Draft
[Workflows] Document category descriptions for the ai.classify step#7644nastasha-solomon wants to merge 2 commits into
nastasha-solomon wants to merge 2 commits into
Conversation
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
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
1 participant
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
Documents the
ai.classifystep's new support for category descriptions (9.5 and Serverless):categoriesandfallbackCategorynow accept either a plain category-name string or an object withnameanddescription. When a description is supplied, it's included in the classification prompt sent to the model, improving category selection for closely related or ambiguous categories. This is a backward-compatible, additive change to the documented YAML schema — plain strings still work.Fixes #7355.
Previews
categoriesandfallbackCategoryaccept a plain string or a{ name, description }object, plus a new "Example: Category descriptions" section.Generative AI disclosure