Skip to content

Add godoc to Foundry MemoryProvider.Invoking and Invoked#753

Open
PratikDhanave wants to merge 1 commit into
microsoft:mainfrom
PratikDhanaveFork:docs-foundry-memory-invoking-invoked
Open

Add godoc to Foundry MemoryProvider.Invoking and Invoked#753
PratikDhanave wants to merge 1 commit into
microsoft:mainfrom
PratikDhanaveFork:docs-foundry-memory-invoking-invoked

Conversation

@PratikDhanave

Copy link
Copy Markdown
Contributor

What

Adds godoc comments to the two exported MemoryProvider methods in provider/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 (MemoryProviderConfig and its fields, MemoryProvider, NewMemoryProvider) is already documented. These two methods are the runtime entry points that satisfy the agent.ContextProvider interface, so their behavior should be discoverable via go 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.Invoking and .Invoked now render the new text.

Copilot AI review requested due to automatic review settings July 24, 2026 04:23
@PratikDhanave
PratikDhanave requested a review from a team as a code owner July 24, 2026 04:23

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-actions

This comment has been minimized.

@github-actions github-actions Bot added the parity-approved Go API consistency review found no parity issues label Jul 24, 2026
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.
@PratikDhanave
PratikDhanave force-pushed the docs-foundry-memory-invoking-invoked branch from 7ffebf3 to 45d2a63 Compare July 24, 2026 09:29
@github-actions

Copy link
Copy Markdown
Contributor

Cross-Repo Parity Review

This PR adds GoDoc comments to the existing Invoking and Invoked methods on MemoryProvider in provider/foundryprovider/memory.go. No exported types, method signatures, option shapes, or runtime behavior were changed.

Scope determination: Documentation-only change — no exported Go API surface was added, removed, or modified.

Parity verdict: ✅ No parity concerns. The Invoking/Invoked lifecycle hooks remain semantically aligned with the equivalent pre/post-invocation memory hooks in the upstream .NET and Python implementations. The added comments accurately describe the existing behavior (retrieve relevant memories before a run; persist messages after a run).

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • awmgmcpg

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "awmgmcpg"

See Network Configuration for more information.

Generated by Go API Consistency Review Agent · 21.9 AIC · ⌖ 3.93 AIC · ⊞ 5.9K ·

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

parity-approved Go API consistency review found no parity issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants