docs: fix discrepancies between docs and source code#110
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
docs: fix discrepancies between docs and source code#110mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
- Fix incorrect error name property in errors.mdx (said 'CoreAIError' for all classes)
- Fix wrong OTel attribute name (gen_ai.system -> gen_ai.provider.name) and add missing span attributes
- Add missing metadata parameter to all API reference pages and type definitions
- Document Langfuse usage detail key names
- Add Anthropic adaptive thinking effort mapping table
- Document both valid cache TTL values ('5m' and '1h') for Anthropic
Generated-By: mintlify-agent
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
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
Compared documentation against the actual source code implementation and fixed several discrepancies:
nameproperty inapi/core/errors.mdx— theValidationErrorproperties section incorrectly stated the name is always'CoreAIError'gen_ai.systemcorrected togen_ai.provider.name, and added missing span attributes (gen_ai.operation.name,gen_ai.output.type,gen_ai.request.schema_name, cache token attrs,core_ai.metadata.*,core_ai.function_id) plus span name patternsmetadataparameter toBaseGenerateOptions,EmbedOptions, andImageGenerateOptionstype definitions and all six API reference pages (generate,stream,generateObject,streamObject,embed,generateImage) plusconcepts/configuration.mdxusageDetailskey names — replaced vague description with exact keys:input,output,cache_read_input,cache_creation_input,reasoning_outputReasoningEffortvalues map to Anthropic effort levels'5m'and'1h') for Anthropic prompt caching