docs: rewrite safety/errors/playbooks/skills/observability/server/rag/checkpointers#31
Merged
Merged
Conversation
…/checkpointers concept pages Same template as the prior concept-page batches: pitch / when to pick / getting started / capabilities (each runnable) / gotchas / source / see also. - safety.md: align with the real GuardrailsHook(config=GuardrailConfig(...)) + TopicPolicy / ContentPolicy + SteeringHook surface (the previous copy described an API that doesn't exist). - errors.md: enumerate the full LocusError hierarchy with stable kind strings and idiomatic patterns (one-handler, kind-keyed metrics, differentiated retry, chained causes). - playbooks.md: align with the real PlaybookStep schema (id / description / expected_tools / hints / required / max_tool_calls / validation), strict_sequence vs allow_extra_tools, PlaybookEnforcerHook. - skills.md: real Skill class + AgentSkills.io progressive-disclosure story (catalog -> instructions -> resources), allowed_tools scoping, Skill vs Playbook vs Tool disambiguation table. - observability.md: StructuredLoggingHook + TelemetryHook with the actual metric names (locus.invocations / iterations / tool_calls / tool_errors + invocation/tool_call duration histograms), PII guidance for record_arguments / record_results. - server.md: real AgentServer auth model (bearer api_key, loopback fallback, per-principal thread scoping), endpoint table, deployment paths. - rag.md: real create_rag_tool factory (the previous copy used a retriever.as_tool() that doesn't exist), embedder/store matrices, hybrid retrieval guidance. - checkpointers.md: clarify the two checkpointer shapes (native BaseCheckpointer vs storage backends needing the *_checkpointer() factory), capability flags, OCI-day-1 recommendation. Pages sized 81->165, 60->127, 72->178, 70->163, 72->166, 67->178, 83->229, 96->181. Signed-off-by: Federico Kamelhar <federico.kamelhar@oracle.com>
…fix) Signed-off-by: Federico Kamelhar <federico.kamelhar@oracle.com>
Signed-off-by: Federico Kamelhar <federico.kamelhar@oracle.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.
Summary
Third concept-page batch. Same template as PRs #29 and #30: pitch /
when to pick / getting started / capabilities (each runnable) /
gotchas / source / see also.
Notable: several pages were aligned with the real API after I
read the source. The previous copy described surfaces that don't
exist:
Test plan