docs(groq): S6 polish — streaming caveat, surcharge note, API reference (#69)#74
Merged
Merged
Conversation
…ce (#69) Final docs sweep for the Groq built-in-tools feature. All issue #69 acceptance criteria are satisfied across S0–S5; S6 is documentation completeness only (no code change): - Streaming caveat — builtInTools is accepted while streaming and the search runs server-side, but the streaming path emits content deltas only; structured metadata.builtInToolResults / reasoning are non-streaming only. Documented (not gated) since rejecting would block legitimate streamed answers that used search internally. README + CHANGELOG. - CreditLedger surcharge note — Cost Tracking section now states built-in tool surcharges (web search, code interpreter, browser automation) are billed per-use and not token-tracked in v1 (the issue's explicit S6 ask). - API Reference — added BuiltInTool / BuiltInToolType / BuiltInToolResult to Key Types; updated LLMRequest (builtInTools), LLMResponse (metadata) and the GroqProvider class row to reflect the now-shipped surface. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Implements S6 (final) of the Groq built-in-tools sprint (#69), on top of the merged S5 (#73). Docs-only — every acceptance criterion in #69 is already satisfied across S0–S5; this rounds out documentation completeness.
Changes
builtInToolsis accepted on streaming requests and the search runs server-side, but the streaming path emits content deltas only; structuredmetadata.builtInToolResults/metadata.reasoningare surfaced on non-streaminggenerateResponseonly. Documented, not gated — a hard reject would block legitimate streamed answers that used search internally (the search result is folded into the streamed content). README + CHANGELOG.BuiltInTool/BuiltInToolType/BuiltInToolResultto Key Types; updatedLLMRequest(builtInTools),LLMResponse(metadata), and theGroqProviderclass row.Acceptance criteria (#69) — all met
builtInToolsonopenai/gpt-oss-120bworks; cost noted as not token-trackedgroq/compoundbuiltInToolsonllama-3.3-70b-versatile→ConfigurationErrornaming capable modelsMODELS.GROQ_COMPOUNDexported; catalogRESEARCHtagmetadata.builtInToolResults)Build clean (docs-only; no test change). This completes issue #69.
🤖 Generated with Claude Code