Add godoc to Foundry MemoryProvider.Invoking and Invoked#753
Add godoc to Foundry MemoryProvider.Invoking and Invoked#753PratikDhanave wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Adds GoDoc comments for the two exported MemoryProvider hook methods that implement the runtime entry points for Foundry-backed context injection and persistence.
Changes:
- Documented
MemoryProvider.Invoking(pre-run memory search and context injection behavior). - Documented
MemoryProvider.Invoked(post-run request/response persistence as memory updates).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This comment has been minimized.
This comment has been minimized.
Document the two exported methods that satisfy the agent.ContextProvider interface. Invoking searches the Foundry memory store before a run and injects relevant memories; Invoked persists request and response messages after a run. Every other exported symbol in the file was already documented.
7ffebf3 to
45d2a63
Compare
Cross-Repo Parity ReviewThis PR adds GoDoc comments to the existing Scope determination: Documentation-only change — no exported Go API surface was added, removed, or modified. Parity verdict: ✅ No parity concerns. The Warning Firewall blocked 1 domainThe following domain was blocked by the firewall during workflow execution:
network:
allowed:
- defaults
- "awmgmcpg"See Network Configuration for more information.
|
What
Adds godoc comments to the two exported
MemoryProvidermethods inprovider/foundryprovider/memory.go:Invoking— called before an agent run; searches the Foundry memory store for memories relevant to the incoming messages and returns them as additional context to inject into the run.Invoked— called after an agent run to persist the request and response messages as memory updates in the Foundry memory store.Why
Every other exported symbol in the file (
MemoryProviderConfigand its fields,MemoryProvider,NewMemoryProvider) is already documented. These two methods are the runtime entry points that satisfy theagent.ContextProviderinterface, so their behavior should be discoverable viago doc. Documenting the interface entry points also keeps the Go provider aligned with the .NET/Python context-provider surfaces, whose equivalent invoking/invoked hooks carry XML/docstring documentation.How tested
Documentation-only change (no code change). Verified with:
go build ./...go vet ./provider/foundryprovider/...go test ./provider/foundryprovider/...(pass)go doc ./provider/foundryprovider MemoryProvider.Invokingand.Invokednow render the new text.