[CSHARP-4838] Microsoft Semantic Kernel: Add Wrapping Library Metadata to Vector Embeddings Integrations Created: 07/Nov/23  Updated: 08/Jan/24

Status: Backlog
Project: C# Driver
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: Shubham Ranjan Assignee: Boris Dogadov
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on CSHARP-4891 Append LibraryInfo to DriverDocument Closed
Related
Quarter: FY25Q1
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature?
2. Would you like the user to see examples of the syntax and/or executable code and its output?
3. Which versions of the driver/connector does this apply to?


 Description   

Currently, we lack visibility into the MongoDB's C# Microsoft Semantic Kernel integration usage. This ticket aims to enhance the integration by adding wrapping library metadata. We'll achieve this by passing additional metadata to MongoClient instances during their creation. For example in Python:

 

from pymongo import MongoClient
from pymongo.driver_info import DriverInfo
MongoClient(connection_string, driver=DriverInfo(name="Microsoft Semantic Kernal", version="x.y.z"))

 

{"t":{"$date":"2023-11-01T10:54:37.429-04:00"},"s":"I","c":"NETWORK","id":51800,"ctx":"conn8","msg":"client metadata","attr":{"remote":"10.0.0.56:53989","client":"conn8","doc":{"driver":{"name":"PyMongo|Microsoft Semantic Kernel","version":"4.3.2|x.y.z"},"os":{"type":"Darwin","name":"Darwin","architecture":"x86_64","version":"13.6.1"},"platform":"CPython 3.10.3.final.0"}}}

Note: Please make sure this doesn't overwrite any other metadata that we capture for reporting purposes. 



 Comments   
Comment by James Kovacs [ 07/Nov/23 ]

ClientDocumentHelper does not include a mechanism to pass in additional driver information such as "Microsoft Semantic Kernel" and version. At the moment we hard code detection logic for the legacy API and EFCore. We should consider implementing an augmentation mechanism similar to pymongo.

Generated at Wed Feb 07 21:49:31 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.