Files
semantic-kernel/python/semantic_kernel/memory/null_memory.py
T
Eduard van Valkenburg fbb26b5cf6 Python: further improvements to checks and docs in dev_setup (#6445)
### 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.
-->
Added a section on documentation to the DEV_SETUP
Added a check for the copyright row to pre-commit
Closes #5629

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### 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 😄
2024-05-31 13:06:41 +00:00

53 lines
1.6 KiB
Python

# Copyright (c) Microsoft. All rights reserved.
from semantic_kernel.memory.memory_query_result import MemoryQueryResult
from semantic_kernel.memory.semantic_text_memory_base import SemanticTextMemoryBase
from semantic_kernel.utils.experimental_decorator import experimental_class
@experimental_class
class NullMemory(SemanticTextMemoryBase):
async def save_information(
self,
collection: str,
text: str,
id: str,
description: str | None = None,
additional_metadata: str | None = None,
) -> None:
"""Nullifies behavior of SemanticTextMemoryBase save_information."""
return
async def save_reference(
self,
collection: str,
text: str,
external_id: str,
external_source_name: str,
description: str | None = None,
additional_metadata: str | None = None,
) -> None:
"""Nullifies behavior of SemanticTextMemoryBase save_reference."""
return
async def get(self, collection: str, query: str) -> MemoryQueryResult | None:
"""Nullifies behavior of SemanticTextMemoryBase get."""
return None
async def search(
self,
collection: str,
query: str,
limit: int = 1,
min_relevance_score: float = 0.7,
) -> list[MemoryQueryResult]:
"""Nullifies behavior of SemanticTextMemoryBase search."""
return []
async def get_collections(self) -> list[str]:
"""Nullifies behavior of SemanticTextMemoryBase get_collections."""
return []
NullMemory.instance = NullMemory() # type: ignore