You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
### Motivation and Context
We have some broken links in the readme's and they are still referring
to memory store which is being replaced.
### Description
- Updated readme files to not advertise memory store anymore.
- Updated readme files to point to learn site docs.
### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [ ] The code builds clean without any errors or warnings
- [ ] 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
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
Copy file name to clipboardExpand all lines: dotnet/src/Connectors/Connectors.Memory.Chroma/README.md
-2
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,6 @@ docker-compose up -d --build
21
21
22
22
3. Use Semantic Kernel with Chroma, using server local endpoint `http://localhost:8000`:
23
23
24
-
> See [Example 14](../../../samples/Concepts/Memory/SemanticTextMemory_Building.cs) and [Example 15](../../../samples/Concepts/Memory/TextMemoryPlugin_MultipleMemoryStore.cs) for more memory usage examples with the kernel.
Copy file name to clipboardExpand all lines: dotnet/src/Connectors/Connectors.Memory.Kusto/README.md
+4-5
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,12 @@
1
1
# Microsoft.SemanticKernel.Connectors.Kusto
2
2
3
-
This connector uses [Azure Data Explorer (Kusto)](https://learn.microsoft.com/en-us/azure/data-explorer/) to implement Semantic Memory.
3
+
This connector uses [Azure Data Explorer (Kusto)](https://learn.microsoft.com/azure/data-explorer/) to implement Semantic Memory.
4
4
5
5
## Quick Start
6
6
7
-
1. Create a cluster and database in Azure Data Explorer (Kusto) - see https://learn.microsoft.com/en-us/azure/data-explorer/create-cluster-and-database?tabs=free
7
+
1. Create a cluster and database in Azure Data Explorer (Kusto) - see https://learn.microsoft.com/azure/data-explorer/create-cluster-and-database?tabs=free
8
8
9
9
2. To use Kusto as a semantic memory store, use the following code:
10
-
> See [Example 14](../../../samples/Concepts/Memory/SemanticTextMemory_Building.cs) and [Example 15](../../../samples/Concepts/Memory/TextMemoryPlugin_MultipleMemoryStore.cs) for more memory usage examples with the kernel.
11
10
12
11
```csharp
13
12
usingKusto.Data;
@@ -37,9 +36,9 @@ The function is called `series_cosine_similarity_fl` and is located in the `Func
37
36
38
37
Kusto is an append-only store. This means that when a fact is updated, the old fact is not deleted.
39
38
This isn't a problem for the semantic memory connector, as it always utilizes the most recent fact.
40
-
This is made possible by using the [arg_max](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/arg-max-aggfunction) aggregation function in conjunction with the [ingestion_time](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/ingestiontimefunction) function.
39
+
This is made possible by using the [arg_max](https://learn.microsoft.com/azure/data-explorer/kusto/query/arg-max-aggfunction) aggregation function in conjunction with the [ingestion_time](https://learn.microsoft.com/azure/data-explorer/kusto/query/ingestiontimefunction) function.
41
40
However, users manually querying the underlying table should be aware of this behavior.
42
41
43
42
### Authentication
44
43
45
-
Please note that the authentication used in the example above is not recommended for production use. You can find more details here: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/connection-strings/kusto
44
+
Please note that the authentication used in the example above is not recommended for production use. You can find more details here: https://learn.microsoft.com/azure/data-explorer/kusto/api/connection-strings/kusto
Copy file name to clipboardExpand all lines: dotnet/src/Connectors/Connectors.Memory.Milvus/README.md
-1
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,6 @@ docker-compose up -d
19
19
```
20
20
21
21
3. Use Semantic Kernel with Milvus, connecting to `localhost` with the default (gRPC) port of 1536:
22
-
> See [Example 14](../../../samples/Concepts/Memory/SemanticTextMemory_Building.cs) and [Example 15](../../../samples/Concepts/Memory/TextMemoryPlugin_MultipleMemoryStore.cs) for more memory usage examples with the kernel.
2. Create a [collection](https://www.mongodb.com/docs/atlas/atlas-ui/collections/)
9
+
2. Create a Mongo DB Vector Store using instructions on the [Microsoft Learn site](https://learn.microsoft.com/semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/mongodb-connector).
10
10
11
-
3. Create [Vector Search Index](https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-overview/) for the collection. The index has to be defined on a field called `embedding`. For example:
12
-
13
-
```
14
-
{
15
-
"type": "vectorSearch",
16
-
"fields": [
17
-
{
18
-
"numDimensions": <number-of-dimensions>,
19
-
"path": "embedding",
20
-
"similarity": "euclidean | cosine | dotProduct",
21
-
"type": "vector"
22
-
}
23
-
]
24
-
}
25
-
```
26
-
27
-
4. Create the MongoDB memory store
28
-
> See [Example 14](../../../samples/Concepts/Memory/SemanticTextMemory_Building.cs) and [Example 15](../../../samples/Concepts/Memory/TextMemoryPlugin_MultipleMemoryStore.cs) for more memory usage examples with the kernel.
3. Use the [getting started instructions](https://learn.microsoft.com/semantic-kernel/concepts/vector-store-connectors/?pivots=programming-language-csharp#getting-started-with-vector-store-connectors) on the Microsoft Leearn site to learn more about using the vector store.
40
12
41
13
> Guide to find the connection string: https://www.mongodb.com/docs/manual/reference/connection-string/
42
-
43
-
## Important Notes
44
-
45
-
### Vector search indexes
46
-
47
-
In this version, vector search index management is outside of `MongoDBMemoryStore` scope.
48
-
Creation and maintenance of the indexes have to be done by the user. Please note that deleting a collection
49
-
(`memoryStore.DeleteCollectionAsync`) will delete the index as well.
See [this sample](../../../samples/Concepts/Memory/VectorStore_VectorSearch_MultiStore_Postgres.cs) for an example of using the vector store.
39
39
40
-
### Using PostgresMemoryStore
40
+
For more information on using Postgres as a vector store, see the [PostgresVectorStore](https://learn.microsoft.com/semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector) documentation.
41
41
42
-
> See [Example 14](../../../samples/Concepts/Memory/SemanticTextMemory_Building.cs) and [Example 15](../../../samples/Concepts/Memory/TextMemoryPlugin_MultipleMemoryStore.cs) for more memory usage examples with the kernel.
> By default, pgvector performs exact nearest neighbor search, which provides perfect recall.
61
-
62
-
> You can add an index to use approximate nearest neighbor search, which trades some recall for performance. Unlike typical indexes, you will see different results for queries after adding an approximate index.
63
-
64
-
> Three keys to achieving good recall are:
65
-
>
66
-
> - Create the index after the table has some data
67
-
> - Choose an appropriate number of lists - a good place to start is rows / 1000 for up to 1M rows and sqrt(rows) for over 1M rows
68
-
> - When querying, specify an appropriate number of probes (higher is better for recall, lower is better for speed) - a good place to start is sqrt(lists)
69
-
70
-
Please read [the documentation](https://github.com/pgvector/pgvector#indexing) for more information.
71
-
72
-
Based on the data rows of your collection table, consider the following statement to create an index.
73
-
74
-
```sql
75
-
DO $$
76
-
DECLARE
77
-
collection TEXT;
78
-
c_count INTEGER;
79
-
BEGIN
80
-
SELECT'REPLACE YOUR COLLECTION TABLE NAME' INTO collection;
81
-
82
-
-- Get count of records in collection
83
-
EXECUTE format('SELECT count(*) FROM public.%I;', collection) INTO c_count;
84
-
85
-
-- Create Index (https://github.com/pgvector/pgvector#indexing)
86
-
IF c_count >10000000 THEN
87
-
EXECUTE format('CREATE INDEX %I ON public.%I USING ivfflat (embedding vector_cosine_ops) WITH (lists = %s);',
EXECUTE format('CREATE INDEX %I ON public.%I USING ivfflat (embedding vector_cosine_ops) WITH (lists = %s);',
91
-
collection ||'_ix', collection, c_count /1000);
92
-
END IF;
93
-
END $$;
94
-
```
42
+
Use the [getting started instructions](https://learn.microsoft.com/semantic-kernel/concepts/vector-store-connectors/?pivots=programming-language-csharp#getting-started-with-vector-store-connectors) on the Microsoft Leearn site to learn more about using the vector store.
Copy file name to clipboardExpand all lines: dotnet/src/Connectors/Connectors.Memory.Redis/README.md
+2-15
Original file line number
Diff line number
Diff line change
@@ -22,19 +22,6 @@ Ways to get RediSearch:
22
22
docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
23
23
```
24
24
25
-
2. To use Redis as a semantic memory store:
26
-
> See [Example 14](../../../samples/Concepts/Memory/SemanticTextMemory_Building.cs) and [Example 15](../../../samples/Concepts/Memory/TextMemoryPlugin_MultipleMemoryStore.cs) for more memory usage examples with the kernel.
25
+
2. Create a Redis Vector Store using instructions on the [Microsoft Learn site](https://learn.microsoft.com/semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/redis-connector).
27
26
28
-
```csharp
29
-
// ConnectionMultiplexer should be a singleton instance in your application, please consider to dispose of it when your application shuts down.
30
-
// See https://stackexchange.github.io/StackExchange.Redis/Basics#basic-usage
3. Use the [getting started instructions](https://learn.microsoft.com/semantic-kernel/concepts/vector-store-connectors/?pivots=programming-language-csharp#getting-started-with-vector-store-connectors) on the Microsoft Leearn site to learn more about using the vector store.
0 commit comments