Document latency, failure behaviour, and attestation scope - #565
Open
0xsims wants to merge 1 commit into
Open
Conversation
The example constructed RubricClient without background_queue, which is off by default and submits synchronously inside the component's run() — a slow API blocks the pipeline run for up to timeout seconds (default 15). Both examples now set it, and the default is explained. Documents behaviour an audit-tool adopter needs and the page did not state: attestation failures are caught and logged at WARNING, so a pipeline succeeds with no evidence for that run (on_dead_letter surfaces the gap); only the first reply is attested, truncated to 2000 characters; the reply text is transmitted to the API rather than hashed client-side. Also adds a verification example, reads the API key from the environment rather than a literal, notes the package covers frameworks beyond AutoGen, and replaces "court-grade evidence" with the claim that is actually supportable.
|
@0xsims is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
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.
The example constructed RubricClient without background_queue, which is off by default and submits synchronously inside the component's run() — a slow API blocks the pipeline run for up to timeout seconds (default 15). Both examples now set it, and the default is explained.
Documents behaviour an audit-tool adopter needs and the page did not state: attestation failures are caught and logged at WARNING, so a pipeline succeeds with no evidence for that run (on_dead_letter surfaces the gap); only the first reply is attested, truncated to 2000 characters; the reply text is transmitted to the API rather than hashed client-side.
Also adds a verification example, reads the API key from the environment rather than a literal, notes the package covers frameworks beyond AutoGen, and replaces "court-grade evidence" with the claim that is actually supportable.