From 2efdaba9b0c5d16fa1df16c49f1ab1d7068940ed Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Fri, 31 Jan 2025 20:29:35 +0000 Subject: [PATCH] CI Update Build.Reason:Manual by Genevieve Warren Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=496189&view=results source_repo.branch:package-updates source_repo.url:https://apidrop.visualstudio.com/_git/binaries --- .../OptionsServiceCollectionExtensions.xml | 14 +- .../ServiceProviderOptions.xml | 2 +- .../PhysicalFileProvider.xml | 4 +- xml/Microsoft.Extensions.Hosting/IHost.xml | 4 +- .../OptionsBuilder`1.xml | 24 +- .../AnyTagEqualToFilterClause.xml | 20 +- .../DeleteRecordOptions.xml | 18 +- .../DistanceFunction.xml | 74 +++- .../EqualToFilterClause.xml | 20 +- .../FilterClause.xml | 9 +- .../GetRecordOptions.xml | 18 +- .../IVectorStore.xml | 38 +- .../IVectorStoreRecordCollection`2.xml | 139 ++++--- .../IVectorStoreRecordMapper`2.xml | 26 +- .../IVectorizableTextSearch`1.xml | 18 +- .../IVectorizedSearch`1.xml | 20 +- .../IndexKind.xml | 47 ++- .../StorageToDataModelMapperOptions.xml | 8 +- .../UpsertRecordOptions.xml | 19 +- .../VectorSearchFilter.xml | 54 ++- .../VectorSearchOptions.xml | 36 +- .../VectorSearchResult`1.xml | 22 +- .../VectorSearchResults`1.xml | 31 +- .../VectorStoreException.xml | 34 +- .../VectorStoreGenericDataModel`1.xml | 30 +- .../VectorStoreOperationException.xml | 22 +- .../VectorStoreRecordDataAttribute.xml | 31 +- .../VectorStoreRecordDataProperty.xml | 38 +- .../VectorStoreRecordDefinition.xml | 12 +- .../VectorStoreRecordKeyAttribute.xml | 13 +- .../VectorStoreRecordKeyProperty.xml | 22 +- .../VectorStoreRecordMappingException.xml | 22 +- .../VectorStoreRecordProperty.xml | 24 +- .../VectorStoreRecordVectorAttribute.xml | 68 ++- .../VectorStoreRecordVectorProperty.xml | 49 ++- xml/System.Formats.Asn1/AsnDecoder.xml | 8 +- xml/System.Formats.Asn1/AsnReader.xml | 12 +- xml/System.Numerics.Tensors/Tensor.xml | 4 +- .../TensorPrimitives.xml | 24 +- xml/System.Reflection/TypeExtensions.xml | 386 ++++++++---------- .../IsExternalInit.xml | 6 +- 41 files changed, 931 insertions(+), 539 deletions(-) diff --git a/xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml b/xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml index ec81c75c1cb..9a141add20d 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml @@ -190,7 +190,7 @@ The so that configure calls can be chained in it. - The extension is called by this method. + The extension is called by this method. @@ -254,7 +254,7 @@ The so that configure calls can be chained in it. - The extension is called by this method. + The extension is called by this method. @@ -290,7 +290,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The so that additional calls can be chained. To be added. @@ -337,7 +337,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The so that additional calls can be chained. To be added. @@ -524,7 +524,7 @@ The action used to configure the options. Registers an action used to initialize a particular type of options. - Note: These are run after all . + Note: These are run after all . The so that additional calls can be chained. To be added. @@ -571,7 +571,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The so that additional calls can be chained. To be added. @@ -609,7 +609,7 @@ The action used to configure the options. Registers an action used to post configure all instances of a particular type of options. - Note: These are run after all . + Note: These are run after all . The so that additional calls can be chained. To be added. diff --git a/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml b/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml index cbf1d87a455..1564021b7d8 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml @@ -63,7 +63,7 @@ - Gets or sets a value that indicates whether validation is performed to ensure all services can be created when is called. + Gets or sets a value that indicates whether validation is performed to ensure all services can be created when is called. if validation is performed to ensure all services can be created during a call; otherwise, . The default is the value of . diff --git a/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml b/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml index d5087fc6992..767b6683147 100644 --- a/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml +++ b/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml @@ -330,13 +330,13 @@ Creates a for the specified . - Globbing patterns are interpreted by . + Globbing patterns are interpreted by . An that is notified when a file matching is added, modified, or deleted. Returns a if has invalid filter characters or if is an absolute path or outside the root directory specified in the - constructor . + constructor . To be added. diff --git a/xml/Microsoft.Extensions.Hosting/IHost.xml b/xml/Microsoft.Extensions.Hosting/IHost.xml index 16cfb3eae9d..46f06128230 100644 --- a/xml/Microsoft.Extensions.Hosting/IHost.xml +++ b/xml/Microsoft.Extensions.Hosting/IHost.xml @@ -46,7 +46,7 @@ - Gets the services configured for the program (for example, using ). + Gets the services configured for the program (for example, using ). To be added. To be added. @@ -73,7 +73,7 @@ Used to abort program start. Starts the objects configured for the program. - The application will run until interrupted or until is called. + The application will run until interrupted or until is called. A that will be completed when the starts. To be added. diff --git a/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml b/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml index 8374e4c133d..7da5c4537b5 100644 --- a/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml +++ b/xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml @@ -96,7 +96,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -132,7 +132,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -174,7 +174,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -222,7 +222,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -276,7 +276,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -336,7 +336,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run before all . + Note: These are run before all . The current . To be added. @@ -387,7 +387,7 @@ The action used to configure the options. Registers an action used to configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -423,7 +423,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -465,7 +465,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -513,7 +513,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -567,7 +567,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. @@ -627,7 +627,7 @@ The action used to configure the options. Registers an action used to post configure a particular type of options. - Note: These are run after all . + Note: These are run after all . The current . To be added. diff --git a/xml/Microsoft.Extensions.VectorData/AnyTagEqualToFilterClause.xml b/xml/Microsoft.Extensions.VectorData/AnyTagEqualToFilterClause.xml index 724b7480121..a358426fad2 100644 --- a/xml/Microsoft.Extensions.VectorData/AnyTagEqualToFilterClause.xml +++ b/xml/Microsoft.Extensions.VectorData/AnyTagEqualToFilterClause.xml @@ -20,7 +20,9 @@ - To be added. + + which filters by checking if a field consisting of a list of values contains a specific value. + To be added. @@ -41,9 +43,11 @@ - To be added. - To be added. - To be added. + The name of the field with the list of values. + The value that the list should contain. + + Initializes a new instance of the class. + To be added. @@ -63,7 +67,9 @@ System.String - To be added. + + The name of the field with the list of values. + To be added. To be added. @@ -84,7 +90,9 @@ System.String - To be added. + + The value that the list should contain. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/DeleteRecordOptions.xml b/xml/Microsoft.Extensions.VectorData/DeleteRecordOptions.xml index bb3841ae2bc..3df2d496a2c 100644 --- a/xml/Microsoft.Extensions.VectorData/DeleteRecordOptions.xml +++ b/xml/Microsoft.Extensions.VectorData/DeleteRecordOptions.xml @@ -14,8 +14,12 @@ - To be added. - To be added. + + Options when calling . + + + This class does not currently include any options, but is added for future extensibility of the API. + @@ -31,7 +35,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -51,8 +57,10 @@ - To be added. - To be added. + The options to clone + + Initializes a new instance of the class by cloning the given options. + To be added. diff --git a/xml/Microsoft.Extensions.VectorData/DistanceFunction.xml b/xml/Microsoft.Extensions.VectorData/DistanceFunction.xml index d20a7ccc1fa..932c800caf7 100644 --- a/xml/Microsoft.Extensions.VectorData/DistanceFunction.xml +++ b/xml/Microsoft.Extensions.VectorData/DistanceFunction.xml @@ -20,8 +20,14 @@ - To be added. - To be added. + + Defines a list of well known distance functions that can be used to compare vectors. + + + Not all Vector Store connectors support all distance functions and some connectors may + support additional distance functions that are not defined here. See the documentation + for each connector for more information on what is supported. + @@ -40,8 +46,15 @@ System.String - To be added. - To be added. + + The cosine (angular) similarity between two vectors. + + + CosineDistance = 1 - CosineSimilarity. + 2 means vectors are opposite. + 1 means vectors are orthogonal. + 0 means vectors are identical. + @@ -60,8 +73,16 @@ System.String - To be added. - To be added. + + The cosine (angular) similarity between two vectors. + + + Measures only the angle between the two vectors, without taking into account the length of the vectors. + ConsineSimilarity = 1 - CosineDistance. + -1 means vectors are opposite. + 0 means vectors are orthogonal. + 1 means vectors are identical. + @@ -80,8 +101,12 @@ System.String - To be added. - To be added. + + Measures both the length and angle between two vectors. + + + The higher the value, the more similar the vectors. + @@ -100,8 +125,12 @@ System.String - To be added. - To be added. + + Measures the Euclidean distance between two vectors. + + + Also known as l2-norm. + @@ -120,8 +149,12 @@ System.String - To be added. - To be added. + + Measures the Euclidean squared distance between two vectors. + + + Also known as l2-squared. + @@ -140,7 +173,9 @@ System.String - To be added. + + Number of differences between vectors at each dimensions. + To be added. @@ -160,7 +195,9 @@ System.String - To be added. + + Measures the Manhattan distance between two vectors. + To be added. @@ -180,8 +217,13 @@ System.String - To be added. - To be added. + + Measures both the length and angle between two vectors. + + + The value of NegativeDotProduct = -1 * DotProductSimilarity. + The higher the value, the greater the distance between the vectors and the less similar the vectors. + diff --git a/xml/Microsoft.Extensions.VectorData/EqualToFilterClause.xml b/xml/Microsoft.Extensions.VectorData/EqualToFilterClause.xml index e9b61c7c72a..949b341f0bc 100644 --- a/xml/Microsoft.Extensions.VectorData/EqualToFilterClause.xml +++ b/xml/Microsoft.Extensions.VectorData/EqualToFilterClause.xml @@ -20,7 +20,9 @@ - To be added. + + which filters using equality of a field value. + To be added. @@ -41,9 +43,11 @@ - To be added. - To be added. - To be added. + Field name. + Field value. + + Initializes a new instance of the class. + To be added. @@ -63,7 +67,9 @@ System.String - To be added. + + Field name to match. + To be added. To be added. @@ -84,7 +90,9 @@ System.Object - To be added. + + Field value to match. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/FilterClause.xml b/xml/Microsoft.Extensions.VectorData/FilterClause.xml index f913cce6e89..79b9824996a 100644 --- a/xml/Microsoft.Extensions.VectorData/FilterClause.xml +++ b/xml/Microsoft.Extensions.VectorData/FilterClause.xml @@ -14,8 +14,13 @@ - To be added. - To be added. + + Base class for filter clauses. + + + A is used to request that the underlying search service should + filter search results based on the specified criteria. + diff --git a/xml/Microsoft.Extensions.VectorData/GetRecordOptions.xml b/xml/Microsoft.Extensions.VectorData/GetRecordOptions.xml index 812fb0e12d0..304ddfe868e 100644 --- a/xml/Microsoft.Extensions.VectorData/GetRecordOptions.xml +++ b/xml/Microsoft.Extensions.VectorData/GetRecordOptions.xml @@ -14,7 +14,9 @@ - To be added. + + Options when calling . + To be added. @@ -31,7 +33,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -51,8 +55,10 @@ - To be added. - To be added. + The options to clone + + Initializes a new instance of the class by cloning the given options. + To be added. @@ -72,7 +78,9 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether to include vectors in the retrieval result. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/IVectorStore.xml b/xml/Microsoft.Extensions.VectorData/IVectorStore.xml index 870e955f083..fd7d50c1332 100644 --- a/xml/Microsoft.Extensions.VectorData/IVectorStore.xml +++ b/xml/Microsoft.Extensions.VectorData/IVectorStore.xml @@ -11,8 +11,12 @@ - To be added. - To be added. + + Interface for accessing the list of collections in a vector store. + + + This interface can be used with collections of any schema type, but requires you to provide schema information when getting a collection. + @@ -52,13 +56,21 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The data type of the record key. + The record data model to use for adding, updating and retrieving data from the collection. + The name of the collection. + Defines the schema of the record type. + + Get a collection from the vector store. + + A new instance for managing the records in the collection. + + To successfully request a collection, either must be annotated with attributes that define the schema of + the record type, or must be provided. + + + + @@ -79,9 +91,11 @@ - To be added. - To be added. - To be added. + The to monitor for cancellation requests. The default is . + + Retrieve the names of all the collections in the vector store. + + The list of names of all the collections in the vector store. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/IVectorStoreRecordCollection`2.xml b/xml/Microsoft.Extensions.VectorData/IVectorStoreRecordCollection`2.xml index 34a90eb74fd..8fc2a79912b 100644 --- a/xml/Microsoft.Extensions.VectorData/IVectorStoreRecordCollection`2.xml +++ b/xml/Microsoft.Extensions.VectorData/IVectorStoreRecordCollection`2.xml @@ -26,9 +26,11 @@ - To be added. - To be added. - To be added. + The data type of the record key. + The record data model to use for adding, updating and retrieving data from the store. + + A schema aware interface for managing a named collection of records in a vector store and for creating or deleting the collection itself. + To be added. @@ -50,9 +52,12 @@ - To be added. - To be added. - To be added. + The to monitor for cancellation requests. The default is . + + Check if the collection exists in the vector store. + + + if the collection exists, otherwise. To be added. @@ -72,7 +77,9 @@ System.String - To be added. + + Gets the name of the collection. + To be added. To be added. @@ -95,9 +102,11 @@ - To be added. - To be added. - To be added. + The to monitor for cancellation requests. The default is . + + Create this collection in the vector store. + + A that completes when the collection has been created. To be added. @@ -119,9 +128,11 @@ - To be added. - To be added. - To be added. + The to monitor for cancellation requests. The default is . + + Create this collection in the vector store if it does not already exist. + + A that completes when the collection has been created. To be added. @@ -152,12 +163,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The unique id associated with the record to remove. + Optional options for removing the record. + The to monitor for cancellation requests. The default is . + + Deletes a record from the vector store. Does not guarantee that the collection exists. + + The unique identifier for the record. To be added. + Throw when the command fails to execute for any reason other than that the record does not exit. @@ -187,12 +201,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The unique ids associated with the records to remove. + Optional options for removing the records. + The to monitor for cancellation requests. The default is . + + Deletes a batch of records from the vector store. Does not guarantee that the collection exists. + Deletes will be made in a single request or in a single parallel batch depending on the available store functionality. + If a record is not found, it will be ignored and the batch will succeed. + If any record cannot be deleted for any other reason, the operation will throw. Some records may have already been deleted, while others may not, so the entire operation should be retried. + + A that completes when the records have been deleted. To be added. + Throw when the command fails to execute for any reason other than that a record does not exist. @@ -213,9 +233,11 @@ - To be added. - To be added. - To be added. + The to monitor for cancellation requests. The default is . + + Delete the collection from the vector store. + + A that completes when the collection has been deleted. To be added. @@ -252,12 +274,17 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The unique id associated with the record to get. + Optional options for retrieving the record. + The to monitor for cancellation requests. The default is . + + Gets a record from the vector store. Does not guarantee that the collection exists. + Returns null if the record is not found. + + The record if found, otherwise null. To be added. + Throw when the command fails to execute for any reason. + Throw when mapping between the storage model and record data model fails. @@ -287,12 +314,19 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The unique ids associated with the record to get. + Optional options for retrieving the records. + The to monitor for cancellation requests. The default is . + + Gets a batch of records from the vector store. Does not guarantee that the collection exists. + Gets will be made in a single request or in a single parallel batch depending on the available store functionality. + Only found records will be returned, so the resultset may be smaller than the requested keys. + Throws for any issues other than records not being found. + + The records associated with the unique keys provided. To be added. + Throw when the command fails to execute for any reason. + Throw when mapping between the storage model and record data model fails. @@ -322,12 +356,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The record to upsert. + Optional options for upserting the record. + The to monitor for cancellation requests. The default is . + + Upserts a record into the vector store. Does not guarantee that the collection exists. + If the record already exists, it will be updated. + If the record does not exist, it will be created. + + The unique identifier for the record. To be added. + Throw when the command fails to execute for any reason. + Throw when mapping between the storage model and record data model fails. @@ -357,12 +397,19 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The records to upsert. + Optional options for upserting the records. + The to monitor for cancellation requests. The default is . + + Upserts a group of records into the vector store. Does not guarantee that the collection exists. + If the record already exists, it will be updated. + If the record does not exist, it will be created. + Upserts will be made in a single request or in a single parallel batch depending on the available store functionality. + + The unique identifiers for the records. To be added. + Throw when the command fails to execute for any reason. + Throw when mapping between the storage model and record data model fails. diff --git a/xml/Microsoft.Extensions.VectorData/IVectorStoreRecordMapper`2.xml b/xml/Microsoft.Extensions.VectorData/IVectorStoreRecordMapper`2.xml index dc3f8d28e8d..882e3e18378 100644 --- a/xml/Microsoft.Extensions.VectorData/IVectorStoreRecordMapper`2.xml +++ b/xml/Microsoft.Extensions.VectorData/IVectorStoreRecordMapper`2.xml @@ -29,9 +29,11 @@ - To be added. - To be added. - To be added. + The consumer record data model to map to or from. + The storage model to map to or from. + + Interface for mapping between a storage model, and the consumer record data model. + To be added. @@ -54,9 +56,11 @@ - To be added. - To be added. - To be added. + The consumer record data model record to map. + + Map from the consumer record data model to the storage model. + + The mapped result. To be added. @@ -80,10 +84,12 @@ - To be added. - To be added. - To be added. - To be added. + The storage data model record to map. + Options to control the mapping behavior. + + Map from the storage model to the consumer record data model. + + The mapped result. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/IVectorizableTextSearch`1.xml b/xml/Microsoft.Extensions.VectorData/IVectorizableTextSearch`1.xml index bebe8c70e06..f1101337da1 100644 --- a/xml/Microsoft.Extensions.VectorData/IVectorizableTextSearch`1.xml +++ b/xml/Microsoft.Extensions.VectorData/IVectorizableTextSearch`1.xml @@ -21,8 +21,10 @@ - To be added. - To be added. + The record data model to use for retrieving data from the store. + + Contains a method for doing a vector search using text that will be vectorized downstream. + To be added. @@ -53,11 +55,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The text to search the store with. + The options that control the behavior of the search. + The to monitor for cancellation requests. The default is . + + Search the vector store for records that match the given text and filter. The text string will be vectorized downstream and used for the vector search. + + The records found by the vector search, including their result scores. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/IVectorizedSearch`1.xml b/xml/Microsoft.Extensions.VectorData/IVectorizedSearch`1.xml index 9fd944616cc..4474b96fff7 100644 --- a/xml/Microsoft.Extensions.VectorData/IVectorizedSearch`1.xml +++ b/xml/Microsoft.Extensions.VectorData/IVectorizedSearch`1.xml @@ -21,8 +21,10 @@ - To be added. - To be added. + The record data model to use for retrieving data from the store. + + Contains a method for doing a vector search using a vector. + To be added. @@ -63,12 +65,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the vector. + The vector to search the store with. + The options that control the behavior of the search. + The to monitor for cancellation requests. The default is . + + Search the vector store for records that match the given embedding and filter. + + The records found by the vector search, including their result scores. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/IndexKind.xml b/xml/Microsoft.Extensions.VectorData/IndexKind.xml index 78f100cad93..a1cbc9f6de4 100644 --- a/xml/Microsoft.Extensions.VectorData/IndexKind.xml +++ b/xml/Microsoft.Extensions.VectorData/IndexKind.xml @@ -20,8 +20,14 @@ - To be added. - To be added. + + Defines a list of well known index types that can be used to index vectors. + + + Not all Vector Store connectors support all index types and some connectors may + support additional index types that are not defined here. See the documentation + for each connector for more information on what is supported. + @@ -40,7 +46,10 @@ System.String - To be added. + + Disk-based Approximate Nearest Neighbor algorithm designed for efficiently searching for approximate nearest neighbors (ANN) in high-dimensional spaces. + The primary focus of DiskANN is to handle large-scale datasets that cannot fit entirely into memory, leveraging disk storage to store the data while maintaining fast search times. + To be added. @@ -60,7 +69,9 @@ System.String - To be added. + + Dynamic index allows to automatically switch from to indexes. + To be added. @@ -80,8 +91,15 @@ System.String - To be added. - To be added. + + Does a brute force search to find the nearest neighbors. + Calculates the distances between all pairs of data points, so has a linear time complexity, that grows directly proportional to the number of points. + Also referred to as exhaustive k nearest neighbor in some databases. + + + High recall accuracy, but slower and more expensive than HNSW. + Better with smaller datasets. + @@ -100,8 +118,12 @@ System.String - To be added. - To be added. + + Hierarchical Navigable Small World, which performs an approximate nearest neighbour (ANN) search. + + + Lower accuracy than exhaustive k nearest neighbor, but faster and more efficient. + @@ -120,7 +142,10 @@ System.String - To be added. + + Inverted File with Flat Compression. Designed to enhance search efficiency by narrowing the search area through the use of neighbor partitions or clusters. + Also referred to as approximate nearest neighbor (ANN) search. + To be added. @@ -140,7 +165,9 @@ System.String - To be added. + + Index that compresses vectors using DiskANN-based quantization methods for better efficiency in the kNN search. + To be added. diff --git a/xml/Microsoft.Extensions.VectorData/StorageToDataModelMapperOptions.xml b/xml/Microsoft.Extensions.VectorData/StorageToDataModelMapperOptions.xml index 03af272fa6c..d577086446f 100644 --- a/xml/Microsoft.Extensions.VectorData/StorageToDataModelMapperOptions.xml +++ b/xml/Microsoft.Extensions.VectorData/StorageToDataModelMapperOptions.xml @@ -14,7 +14,9 @@ - To be added. + + Options to use with the method. + To be added. @@ -51,7 +53,9 @@ System.Boolean - To be added. + + Get or sets a value indicating whether to include vectors in the retrieval result. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/UpsertRecordOptions.xml b/xml/Microsoft.Extensions.VectorData/UpsertRecordOptions.xml index ef87d1aae73..1b8619b8de1 100644 --- a/xml/Microsoft.Extensions.VectorData/UpsertRecordOptions.xml +++ b/xml/Microsoft.Extensions.VectorData/UpsertRecordOptions.xml @@ -14,8 +14,13 @@ - To be added. - To be added. + + Options when calling . + Reserved for future use. + + + This class does not currently include any options, but is added for future extensibility of the API. + @@ -31,7 +36,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -51,8 +58,10 @@ - To be added. - To be added. + The options to clone + + Initializes a new instance of the class by cloning the given options. + To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorSearchFilter.xml b/xml/Microsoft.Extensions.VectorData/VectorSearchFilter.xml index e432bb4615a..1c9324814f1 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorSearchFilter.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorSearchFilter.xml @@ -20,8 +20,15 @@ - To be added. - To be added. + + Used to provide filtering when doing vector searches. + Contains configuration for doing basic vector search filtering. + + + A filter has a collection of s that can be used + to request that the underlying service filter the search results. + All clauses are combined with and. + @@ -37,7 +44,8 @@ - To be added. + + Create an instance of To be added. @@ -58,7 +66,9 @@ To be added. - To be added. + + Create an instance of with the provided s. + The instances to use To be added. @@ -82,11 +92,16 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + Name of the property consisting of a list of values to check against. Use the name of the property from your data model or as provided in the record definition. + Value that the list should contain. + + Add an any tag equal to clause to the filter options. + + + instance to allow fluent configuration. + + This clause will check if a property consisting of a list of values contains a specific value. + @@ -105,7 +120,7 @@ Microsoft.Extensions.VectorData.VectorSearchFilter - To be added. + Gets the default search filter. To be added. To be added. @@ -130,11 +145,16 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + Name of the property to check against. Use the name of the property from your data model or as provided in the record definition. + Value that the property should match. + + Add an equal to clause to the filter options. + + + instance to allow fluent configuration. + + This clause will check if a property is equal to a specific value. + @@ -153,7 +173,9 @@ System.Collections.Generic.IEnumerable<Microsoft.Extensions.VectorData.FilterClause> - To be added. + + The filter clauses to and together. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorSearchOptions.xml b/xml/Microsoft.Extensions.VectorData/VectorSearchOptions.xml index f81681519a0..606616b9f56 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorSearchOptions.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorSearchOptions.xml @@ -20,7 +20,9 @@ - To be added. + + Options for vector search. + To be added. @@ -57,7 +59,9 @@ Microsoft.Extensions.VectorData.VectorSearchFilter - To be added. + + Gets or sets a search filter to use before doing the vector search. + To be added. To be added. @@ -78,9 +82,15 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether the total count should be included in the results. + To be added. - To be added. + + Default value is false. + Not all vector search implementations will support this option in which case the total + count will be null even if requested via this option. + @@ -99,7 +109,9 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether to include vectors in the retrieval result. + To be added. To be added. @@ -120,7 +132,9 @@ System.Int32 - To be added. + + Gets or sets the number of results to skip before returning results, i.e. the index of the first result to return. + To be added. To be added. @@ -141,7 +155,9 @@ System.Int32 - To be added. + + Gets or sets the maximum number of results to return. + To be added. To be added. @@ -162,7 +178,11 @@ System.String - To be added. + + Gets or sets the name of the vector property to search on. + Use the name of the vector property from your data model or as provided in the record definition. + If not provided will default to the first vector property in the schema. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorSearchResult`1.xml b/xml/Microsoft.Extensions.VectorData/VectorSearchResult`1.xml index fc73af44d44..347792e54e7 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorSearchResult`1.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorSearchResult`1.xml @@ -30,8 +30,10 @@ - To be added. - To be added. + The record data model to use for retrieving data from the store. + + A single search result from a vector search. + To be added. @@ -52,9 +54,11 @@ - To be added. - To be added. - To be added. + The record that was found by the search. + The score of this result in relation to the search query. + + Initializes a new instance of the class. + To be added. @@ -74,7 +78,9 @@ TRecord - To be added. + + The record that was found by the search. + To be added. To be added. @@ -95,7 +101,9 @@ System.Nullable<System.Double> - To be added. + + The score of this result in relation to the search query. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorSearchResults`1.xml b/xml/Microsoft.Extensions.VectorData/VectorSearchResults`1.xml index 2e626c88396..4e0462d0fe9 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorSearchResults`1.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorSearchResults`1.xml @@ -30,8 +30,11 @@ - To be added. - To be added. + The record data model to use for retrieving data from the store. + The list of records returned by the search operation. + + Contains the full list of search results for a vector search operation with metadata. + To be added. @@ -51,8 +54,11 @@ - To be added. - To be added. + The record data model to use for retrieving data from the store. + The list of records returned by the search operation. + + Contains the full list of search results for a vector search operation with metadata. + To be added. @@ -78,7 +84,9 @@ System.Collections.Generic.IReadOnlyDictionary<System.String,System.Object> - To be added. + + The metadata associated with the content. + To be added. To be added. @@ -99,7 +107,9 @@ System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.VectorData.VectorSearchResult<TRecord>> - To be added. + + The search results. + To be added. To be added. @@ -120,9 +130,14 @@ System.Nullable<System.Int64> - To be added. + + The total count of results found by the search operation, or null + if the count was not requested or cannot be computed. + To be added. - To be added. + + This value represents the total number of results that are available for the current query and not the number of results being returned. + diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreException.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreException.xml index 8c6764a14e6..31d9ba0d3c0 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreException.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreException.xml @@ -20,7 +20,9 @@ - To be added. + + Base exception type thrown for any type of failure when using vector stores. + To be added. @@ -37,7 +39,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -57,8 +61,10 @@ - To be added. - To be added. + The error message that explains the reason for the exception. + + Initializes a new instance of the class with a specified error message. + To be added. @@ -79,9 +85,11 @@ - To be added. - To be added. - To be added. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. + To be added. @@ -101,7 +109,9 @@ System.String - To be added. + + Gets or sets the name of the vector store collection that the failing operation was performed on. + To be added. To be added. @@ -122,7 +132,9 @@ System.String - To be added. + + Gets or sets the name of the vector store operation that failed. + To be added. To be added. @@ -143,7 +155,9 @@ System.String - To be added. + + Gets or sets the type of vector store that the failing operation was performed on. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreGenericDataModel`1.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreGenericDataModel`1.xml index d062f89539f..0c3edc4f37e 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreGenericDataModel`1.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreGenericDataModel`1.xml @@ -30,8 +30,11 @@ - To be added. - To be added. + The data type of the record key. + The key of the record. + + A generic data model that can be used to store and retrieve any data from a vector store. + To be added. @@ -51,8 +54,11 @@ - To be added. - To be added. + The data type of the record key. + The key of the record. + + A generic data model that can be used to store and retrieve any data from a vector store. + To be added. @@ -78,9 +84,13 @@ System.Collections.Generic.Dictionary<System.String,System.Object> - To be added. + + Gets or sets a dictionary of data items stored in the record. + To be added. - To be added. + + This dictionary contains all fields that are not vectors. + @@ -99,7 +109,9 @@ TKey - To be added. + + Gets or sets the key of the record. + To be added. To be added. @@ -126,7 +138,9 @@ System.Collections.Generic.Dictionary<System.String,System.Object> - To be added. + + Gets or sets a dictionary of vectors stored in the record. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreOperationException.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreOperationException.xml index d0b7f40cb93..401db6461d1 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreOperationException.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreOperationException.xml @@ -20,7 +20,9 @@ - To be added. + + Exception thrown when a vector store command fails, such as upserting a record or deleting a collection. + To be added. @@ -37,7 +39,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -57,8 +61,10 @@ - To be added. - To be added. + The error message that explains the reason for the exception. + + Initializes a new instance of the class with a specified error message. + To be added. @@ -79,9 +85,11 @@ - To be added. - To be added. - To be added. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. + To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDataAttribute.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDataAttribute.xml index df2635b285d..29eee838a85 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDataAttribute.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDataAttribute.xml @@ -24,8 +24,14 @@ - To be added. - To be added. + + Attribute to mark a property on a record class as 'data'. + + + Marking a property as 'data' means that the property is not a key, and not a vector, but optionally + this property may have an associated vector field containing an embedding for this data. + The characteristics defined here will influence how the property is treated by the vector store. + @@ -61,9 +67,13 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether this data property is filterable. + To be added. - To be added. + + Default is . + @@ -82,9 +92,13 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether this data property is full text searchable. + To be added. - To be added. + + Default is . + @@ -103,7 +117,10 @@ System.String - To be added. + + Gets or sets an optional name to use for the property in storage, if different from the property name. + E.g. the property name might be "MyProperty" but the storage name might be "my_property". + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDataProperty.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDataProperty.xml index 634b57616ac..c726dc088f3 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDataProperty.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDataProperty.xml @@ -20,8 +20,12 @@ - To be added. - To be added. + + Defines a data property on a vector store record. + + + The characteristics defined here will influence how the property is treated by the vector store. + @@ -40,8 +44,10 @@ - To be added. - To be added. + The source to clone + + Initializes a new instance of the class by cloning the given source. + To be added. @@ -62,9 +68,11 @@ - To be added. - To be added. - To be added. + The name of the property. + The type of the property. + + Initializes a new instance of the class. + To be added. @@ -84,9 +92,13 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether this data property is filterable. + To be added. - To be added. + + Default is . + @@ -105,9 +117,13 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether this data property is full text searchable. + To be added. - To be added. + + Default is . + diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDefinition.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDefinition.xml index 31d657d4993..43c781affce 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDefinition.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordDefinition.xml @@ -20,8 +20,12 @@ - To be added. - To be added. + + A description of the properties of a record stored in a vector store. + + + Each property contains additional information about how the property will be treated by the vector store. + @@ -57,7 +61,9 @@ System.Collections.Generic.IReadOnlyList<Microsoft.Extensions.VectorData.VectorStoreRecordProperty> - To be added. + + The list of properties that are stored in the record. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordKeyAttribute.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordKeyAttribute.xml index 9193925cc41..31f85902542 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordKeyAttribute.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordKeyAttribute.xml @@ -24,8 +24,12 @@ - To be added. - To be added. + + Attribute to mark a property on a record class as the key under which the record is stored in a vector store. + + + The characteristics defined here will influence how the property is treated by the vector store. + @@ -61,7 +65,10 @@ System.String - To be added. + + Gets or sets an optional name to use for the property in storage, if different from the property name. + E.g. the property name might be "MyProperty" but the storage name might be "my_property". + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordKeyProperty.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordKeyProperty.xml index 44698fac275..798c11f1fa0 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordKeyProperty.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordKeyProperty.xml @@ -20,8 +20,12 @@ - To be added. - To be added. + + Defines a key property on a vector store record. + + + The characteristics defined here will influence how the property is treated by the vector store. + @@ -40,8 +44,10 @@ - To be added. - To be added. + The source to clone + + Initializes a new instance of the class by cloning the given source. + To be added. @@ -62,9 +68,11 @@ - To be added. - To be added. - To be added. + The name of the property. + The type of the property. + + Initializes a new instance of the class. + To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordMappingException.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordMappingException.xml index b88fabc515e..8c76b7d5da8 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordMappingException.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordMappingException.xml @@ -20,7 +20,9 @@ - To be added. + + Exception thrown when a failure occurs while trying to convert models for storage or retrieval. + To be added. @@ -37,7 +39,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -57,8 +61,10 @@ - To be added. - To be added. + The error message that explains the reason for the exception. + + Initializes a new instance of the class with a specified error message. + To be added. @@ -79,9 +85,11 @@ - To be added. - To be added. - To be added. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. + To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordProperty.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordProperty.xml index e438d61549c..628158aa8fc 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordProperty.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordProperty.xml @@ -20,8 +20,12 @@ - To be added. - To be added. + + Defines a base property class for properties on a vector store record. + + + The characteristics defined here will influence how the property is treated by the vector store. + @@ -40,7 +44,9 @@ System.String - To be added. + + Gets or sets the name of the property on the data model. + To be added. To be added. @@ -61,7 +67,9 @@ System.Type - To be added. + + Gets or sets the type of the property. + To be added. To be added. @@ -88,7 +96,13 @@ System.String - To be added. + + Gets or sets an optional name to use for the property in storage, if different from the property name. + E.g. the property name might be "MyProperty" but the storage name might be "my_property". + This property will only be respected by implementations that do not support a well known + serialization mechanism like JSON, in which case the attributes used by that seriallization system will + be used. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordVectorAttribute.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordVectorAttribute.xml index 690341c05bc..84e8ad27227 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordVectorAttribute.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordVectorAttribute.xml @@ -24,8 +24,12 @@ - To be added. - To be added. + + Attribute to mark a property on a record class as a vector. + + + The characteristics defined here will influence how the property is treated by the vector store. + @@ -41,7 +45,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -61,8 +67,10 @@ - To be added. - To be added. + The number of dimensions that the vector has. + + Initializes a new instance of the class. + To be added. @@ -83,9 +91,11 @@ - To be added. - To be added. - To be added. + The number of dimensions that the vector has. + The distance function to use when comparing vectors. + + Initializes a new instance of the class. + To be added. @@ -107,10 +117,12 @@ - To be added. - To be added. - To be added. - To be added. + The number of dimensions that the vector has. + The distance function to use when comparing vectors. + The kind of index to use. + + Initializes a new instance of the class. + To be added. @@ -130,9 +142,14 @@ System.Nullable<System.Int32> - To be added. + + Gets or sets the number of dimensions that the vector has. + To be added. - To be added. + + This property is required when creating collections, but may be omitted if not using that functionality. + If not provided when trying to create a collection, create will fail. + @@ -151,9 +168,14 @@ System.String - To be added. + + Gets the distance function to use when comparing vectors. + To be added. - To be added. + + Default varies by database type. See the documentation of your chosen database connector for more information. + + @@ -172,9 +194,14 @@ System.String - To be added. + + Gets the kind of index to use. + To be added. - To be added. + + Default varies by database type. See the documentation of your chosen database connector for more information. + + @@ -193,7 +220,10 @@ System.String - To be added. + + Gets or sets an optional name to use for the property in storage, if different from the property name. + E.g. the property name might be "MyProperty" but the storage name might be "my_property". + To be added. To be added. diff --git a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordVectorProperty.xml b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordVectorProperty.xml index 45a7f7d35c7..8e5fc284187 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStoreRecordVectorProperty.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStoreRecordVectorProperty.xml @@ -20,8 +20,12 @@ - To be added. - To be added. + + Defines a vector property on a vector store record. + + + The characteristics defined here will influence how the property is treated by the vector store. + @@ -40,8 +44,10 @@ - To be added. - To be added. + The source to clone + + Initializes a new instance of the class by cloning the given source. + To be added. @@ -62,9 +68,11 @@ - To be added. - To be added. - To be added. + The name of the property. + The type of the property. + + Initializes a new instance of the class. + To be added. @@ -84,9 +92,14 @@ System.Nullable<System.Int32> - To be added. + + Gets or sets the number of dimensions that the vector has. + To be added. - To be added. + + This property is required when creating collections, but may be omitted if not using that functionality. + If not provided when trying to create a collection, create will fail. + @@ -105,9 +118,14 @@ System.String - To be added. + + Gets the distance function to use when comparing vectors. + To be added. - To be added. + + Default varies by database type. See the documentation of your chosen database connector for more information. + + @@ -126,9 +144,14 @@ System.String - To be added. + + Gets the kind of index to use. + To be added. - To be added. + + Default varies by database type. See the documentation of your chosen database connector for more information. + + diff --git a/xml/System.Formats.Asn1/AsnDecoder.xml b/xml/System.Formats.Asn1/AsnDecoder.xml index 9fefd06a97a..ea9f8c6b4cf 100644 --- a/xml/System.Formats.Asn1/AsnDecoder.xml +++ b/xml/System.Formats.Asn1/AsnDecoder.xml @@ -259,8 +259,8 @@ The decoded value. To be added. + - is not defined. @@ -289,7 +289,7 @@ . is not the same as . - + @@ -1784,8 +1784,8 @@ This method does not determine if the string used only characters defined by the encoding. + - is not defined. @@ -1810,7 +1810,7 @@ overlaps . - + diff --git a/xml/System.Formats.Asn1/AsnReader.xml b/xml/System.Formats.Asn1/AsnReader.xml index 92de1f62481..61a6068c515 100644 --- a/xml/System.Formats.Asn1/AsnReader.xml +++ b/xml/System.Formats.Asn1/AsnReader.xml @@ -375,8 +375,8 @@ The decoded value. To be added. + - is not a known character string type. @@ -401,7 +401,7 @@ . is not the same as . - + @@ -1644,8 +1644,8 @@ and the reader does not advance. To be added. + - is not a known character string type. @@ -1670,7 +1670,7 @@ . is not the same as . - + @@ -1715,8 +1715,8 @@ This method does not determine if the string used only characters defined by the encoding. + - The next value does not have the correct tag. @@ -1734,7 +1734,7 @@ . is not a character string tag type. - + diff --git a/xml/System.Numerics.Tensors/Tensor.xml b/xml/System.Numerics.Tensors/Tensor.xml index 02ca0e2db64..b1304441081 100644 --- a/xml/System.Numerics.Tensors/Tensor.xml +++ b/xml/System.Numerics.Tensors/Tensor.xml @@ -5215,7 +5215,7 @@ This method effectively computes .CosPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -5297,7 +5297,7 @@ This method effectively computes .CosPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different diff --git a/xml/System.Numerics.Tensors/TensorPrimitives.xml b/xml/System.Numerics.Tensors/TensorPrimitives.xml index 1ab88d9d58c..4b749a8e868 100644 --- a/xml/System.Numerics.Tensors/TensorPrimitives.xml +++ b/xml/System.Numerics.Tensors/TensorPrimitives.xml @@ -2397,7 +2397,7 @@ This method effectively computes [i] = .Cos([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -2440,7 +2440,7 @@ If a value is equal to , the result stored into the corresponding destination location is also NaN. - The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -2505,7 +2505,7 @@ If a value is equal to , the result stored into the corresponding destination location is also NaN. - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -2674,7 +2674,7 @@ This method effectively computes [i] = .CosPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -10117,7 +10117,7 @@ This method effectively computes [i] = .Sin([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -10294,7 +10294,7 @@ the corresponding destination location is set to that value. - The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -10359,7 +10359,7 @@ the corresponding destination location is set to that value. - The angles in x must be in radians. Use or multiply by .Pi / 180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi / 180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -10420,7 +10420,7 @@ This method effectively computes [i] = .SinPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -11191,7 +11191,7 @@ This method effectively computes [i] = .Tan([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -11235,7 +11235,7 @@ If a value is equal to , the corresponding destination location is set to NaN. - The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by /180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -11301,7 +11301,7 @@ If a value is equal to , the corresponding destination location is set to NaN. - The angles in x must be in radians. Use or multiply by .Pi / 180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi / 180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different @@ -11362,7 +11362,7 @@ This method effectively computes [i] = .TanPi([i]). - The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. + The angles in x must be in radians. Use or multiply by .Pi/180 to convert degrees to radians. This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different diff --git a/xml/System.Reflection/TypeExtensions.xml b/xml/System.Reflection/TypeExtensions.xml index 8c3e068e45c..e6b447b2962 100644 --- a/xml/System.Reflection/TypeExtensions.xml +++ b/xml/System.Reflection/TypeExtensions.xml @@ -156,22 +156,36 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + To be added. @@ -181,38 +195,23 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.EventInfo + System.Reflection.EventInfo - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents)>] - - - - + + To be added. @@ -361,39 +360,24 @@ - - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.FieldInfo + System.Reflection.FieldInfo - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] - - - - - + + + To be added. @@ -405,36 +389,22 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.FieldInfo[] + System.Reflection.FieldInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] - - - + To be added. @@ -444,37 +414,23 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.FieldInfo[] + System.Reflection.FieldInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] - - - - + + To be added. @@ -510,36 +466,22 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Type[] + System.Type[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces)>] - - - + To be added. @@ -633,36 +575,22 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] - - - + To be added. @@ -726,24 +654,39 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.MethodInfo + System.Reflection.MethodInfo - - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] + + + + + To be added. @@ -799,36 +742,22 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 + 4.1.5.0 - System.Reflection.MethodInfo[] + System.Reflection.MethodInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] - - - + To be added. @@ -865,24 +794,39 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Type + System.Type - - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)>] + + + + + To be added. @@ -1109,25 +1053,47 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 - System.Reflection.PropertyInfo + System.Reflection.PropertyInfo - - - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + To be added. diff --git a/xml/System.Runtime.CompilerServices/IsExternalInit.xml b/xml/System.Runtime.CompilerServices/IsExternalInit.xml index 8a246ff8e14..d76cd170180 100644 --- a/xml/System.Runtime.CompilerServices/IsExternalInit.xml +++ b/xml/System.Runtime.CompilerServices/IsExternalInit.xml @@ -45,8 +45,10 @@ - Reserved to be used by the compiler for tracking metadata. - This class should not be used by developers in source code. + + Reserved to be used by the compiler for tracking metadata. + This class should not be used by developers in source code. + To be added.