Skip to content

Commit 7fdba17

Browse files
committed
docs: Add XML documentation following Microsoft standards
- Added 'Gets or sets' documentation for all public properties - Added missing XML documentation for InMemoryVectorStoreFixture properties - Added detailed property descriptions for DataModel record - Follows .NET documentation conventions per reviewer feedback patterns - Addresses documentation standards identified in PR4 review comments
1 parent cf16a0a commit 7fdba17

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

dotnet/samples/GettingStartedWithTextSearch/InMemoryVectorStoreFixture.cs

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,24 @@ namespace GettingStartedWithTextSearch;
1515
/// </summary>
1616
public class InMemoryVectorStoreFixture : IAsyncLifetime
1717
{
18+
/// <summary>
19+
/// Gets the embedding generator used for creating vector embeddings.
20+
/// </summary>
1821
public IEmbeddingGenerator<string, Embedding<float>> EmbeddingGenerator { get; private set; }
1922

23+
/// <summary>
24+
/// Gets the in-memory vector store instance.
25+
/// </summary>
2026
public InMemoryVectorStore InMemoryVectorStore { get; private set; }
2127

28+
/// <summary>
29+
/// Gets the vector store record collection for data models.
30+
/// </summary>
2231
public VectorStoreCollection<Guid, DataModel> VectorStoreRecordCollection { get; private set; }
2332

33+
/// <summary>
34+
/// Gets the name of the collection used for storing records.
35+
/// </summary>
2436
public string CollectionName => "records";
2537

2638
/// <summary>
@@ -138,21 +150,36 @@ private async Task<VectorStoreCollection<TKey, TRecord>> CreateCollectionFromLis
138150
/// </remarks>
139151
public sealed class DataModel
140152
{
153+
/// <summary>
154+
/// Gets or sets the unique identifier for this record.
155+
/// </summary>
141156
[VectorStoreKey]
142157
[TextSearchResultName]
143158
public Guid Key { get; init; }
144159

160+
/// <summary>
161+
/// Gets or sets the text content of this record.
162+
/// </summary>
145163
[VectorStoreData]
146164
[TextSearchResultValue]
147165
public string Text { get; init; }
148166

167+
/// <summary>
168+
/// Gets or sets the link associated with this record.
169+
/// </summary>
149170
[VectorStoreData]
150171
[TextSearchResultLink]
151172
public string Link { get; init; }
152173

174+
/// <summary>
175+
/// Gets or sets the tag for categorizing this record.
176+
/// </summary>
153177
[VectorStoreData(IsIndexed = true)]
154178
public required string Tag { get; init; }
155179

180+
/// <summary>
181+
/// Gets the embedding representation of the text content.
182+
/// </summary>
156183
[VectorStoreVector(1536)]
157184
public string Embedding => Text;
158185
}

0 commit comments

Comments
 (0)