Skip to content

.Net: Example of Semantic Caching with Filters #6151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 8, 2024

Conversation

dmytrostruk
Copy link
Member

Motivation and Context

This example shows how to achieve Semantic Caching with Filters.
IPromptRenderFilter is used to get rendered prompt and check in cache if similar prompt was already answered. If there is a record in cache, then previously cached answer will be returned to the user instead of making a call to LLM. If there is no record in cache, a call to LLM will be performed, and result will be cached together with rendered prompt.
IFunctionInvocationFilter is used to update cache with rendered prompt and related LLM result.

Example includes in-memory, Redis and Azure Cosmos DB for MongoDB as caching stores.
Common output which demonstrates that second execution is faster, because the result is returned from cache:

First run: What's the tallest building in New York?
Elapsed Time: 00:00:03.828
Second run: What is the highest building in New York City?
Elapsed Time: 00:00:00.541
Result 1: The tallest building in New York is One World Trade Center, also known as Freedom Tower. It stands at 1,776 feet (541.3 meters) tall, including its spire.
Result 2: The tallest building in New York is One World Trade Center, also known as Freedom Tower. It stands at 1,776 feet (541.3 meters) tall, including its spire.

PR also contains a couple of fixes in Azure Cosmos DB for MongoDB connector and a couple of additions in public API:

  1. Added FunctionResult? Result property to PromptRenderContext. By default it's null, because at prompt rendering stage there is no available result yet. But it's possible to set result with some value - in this case, prompt won't be sent to LLM. Instead, the result from filter will be returned.
  2. Added string? RenderedPrompt to FunctionResult type as Experimental. By default it's null, and will be populated only when KernelFunctionFromPrompt is executed. This property will provide a couple of benefits:
    • It's an additional way how to observe rendered prompt which was sent to LLM during function invocation (today, it's possible to see it only through filter or trace logging).
    • Rendered prompt will be also available in function invocation/automatic function invocation filters, which is required for caching scenarios to store rendered prompt and LLM result together.

Contribution Checklist

@dmytrostruk dmytrostruk self-assigned this May 8, 2024
@dmytrostruk dmytrostruk requested a review from a team as a code owner May 8, 2024 00:22
@markwallace-microsoft markwallace-microsoft added .NET Issue or Pull requests regarding .NET code kernel Issues or pull requests impacting the core kernel kernel.core memory labels May 8, 2024
@dmytrostruk dmytrostruk added this pull request to the merge queue May 8, 2024
Merged via the queue into microsoft:main with commit 0b43152 May 8, 2024
16 checks passed
@dmytrostruk dmytrostruk deleted the semantic-caching branch May 8, 2024 14:47
LudoCorporateShark pushed a commit to LudoCorporateShark/semantic-kernel that referenced this pull request Aug 25, 2024
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

This example shows how to achieve Semantic Caching with Filters.
`IPromptRenderFilter` is used to get rendered prompt and check in cache
if similar prompt was already answered. If there is a record in cache,
then previously cached answer will be returned to the user instead of
making a call to LLM. If there is no record in cache, a call to LLM will
be performed, and result will be cached together with rendered prompt.
`IFunctionInvocationFilter` is used to update cache with rendered prompt
and related LLM result.

Example includes in-memory, Redis and Azure Cosmos DB for MongoDB as
caching stores.
Common output which demonstrates that second execution is faster,
because the result is returned from cache:
```
First run: What's the tallest building in New York?
Elapsed Time: 00:00:03.828
Second run: What is the highest building in New York City?
Elapsed Time: 00:00:00.541
Result 1: The tallest building in New York is One World Trade Center, also known as Freedom Tower. It stands at 1,776 feet (541.3 meters) tall, including its spire.
Result 2: The tallest building in New York is One World Trade Center, also known as Freedom Tower. It stands at 1,776 feet (541.3 meters) tall, including its spire.
```

PR also contains a couple of fixes in Azure Cosmos DB for MongoDB
connector and a couple of additions in public API:
1. Added `FunctionResult? Result` property to `PromptRenderContext`. By
default it's `null`, because at prompt rendering stage there is no
available result yet. But it's possible to set result with some value -
in this case, prompt won't be sent to LLM. Instead, the result from
filter will be returned.
2. Added `string? RenderedPrompt` to `FunctionResult` type as
`Experimental`. By default it's `null`, and will be populated only when
`KernelFunctionFromPrompt` is executed. This property will provide a
couple of benefits:
- It's an additional way how to observe rendered prompt which was sent
to LLM during function invocation (today, it's possible to see it only
through filter or trace logging).
- Rendered prompt will be also available in function
invocation/automatic function invocation filters, which is required for
caching scenarios to store rendered prompt and LLM result together.

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation kernel.core kernel Issues or pull requests impacting the core kernel memory .NET Issue or Pull requests regarding .NET code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants