Document AI client request configuration - #740
Conversation
|
These APIs weren't documented because they have not been finalized and verified |
|
@brianlagunas I checked the SDK source and both options are implemented now and behave exactly as this PR describes.
@PVillarmarzo, I have two review comments that I would want to be addressed before we merge this PR:
|
|
Just chiming in, maybe we can publish this as a preview topic, as we did with That way we have docs about them without committing to the current API, which I believe is what Brian was referring to when mentioning the API isn't finalized. |
Address review feedback on the request configuration docs. - Move the content out of the SDK overview into a dedicated ai/sdk-request-configuration topic marked with sidebar_custom_props.status: preview, matching how the Metadata Storage Provider topic is published, plus an in-page preview note so the API shape is not presented as final. - Document the static bearerToken option and setBearerToken(), and advise choosing one token strategy rather than describing how the two resolve against each other, which is not part of the stated API contract. - Scope onResponse and onError explicitly, limited to what the public config types state. - Keep the request-timing and SSE wording, and link the topic from the SDK overview and the client install page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Thanks all. @zdrawku both points are addressed: the Preview topic now covers @srodriguezinfragistics I followed the Preview approach you suggested and moved the request configuration content into its own topic, using the same convention as @brianlagunas this should address the original concern about documenting APIs that aren't finalized yet; the functionality is now clearly presented as Preview rather than as part of the stable API surface. I also kept the wording intentionally conservative and limited it to behavior supported by the public API contract, rather than documenting implementation-specific interactions. |
srodriguezinfragistics
left a comment
There was a problem hiding this comment.
Publishing this as preview looks good to me.
Summary
Documents the request configuration options available in
RevealSdkClient.initialize()for the AI Client SDK.Changes
getBearerToken.onRequestguidance for custom or dynamic request headers.Why
These APIs are already supported by
@revealbi/api, but were not documented in the public AI Client documentation.