diff --git a/xml/Microsoft.Extensions.AI/AIContent.xml b/xml/Microsoft.Extensions.AI/AIContent.xml index cf84a3fe5c7..f2a52023ed8 100644 --- a/xml/Microsoft.Extensions.AI/AIContent.xml +++ b/xml/Microsoft.Extensions.AI/AIContent.xml @@ -52,7 +52,7 @@ - To be added. + Provides a base class for all content used with AI services. To be added. @@ -69,7 +69,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -89,7 +91,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets additional properties for the content. To be added. To be added. @@ -116,9 +118,13 @@ System.Object - To be added. + Gets or sets the raw representation of the content from an underlying implementation. To be added. - To be added. + + If an is created to represent some underlying object from another object + model, this property can be used to store that original object. This can be useful for debugging or + for enabling a consumer to access the underlying object model if needed. + diff --git a/xml/Microsoft.Extensions.AI/AIFunction.xml b/xml/Microsoft.Extensions.AI/AIFunction.xml index d38e2c477e2..dbc8693e908 100644 --- a/xml/Microsoft.Extensions.AI/AIFunction.xml +++ b/xml/Microsoft.Extensions.AI/AIFunction.xml @@ -24,7 +24,7 @@ - To be added. + Represents a function that can be described to an AI service and invoked. To be added. @@ -77,10 +77,10 @@ - To be added. - To be added. - To be added. - To be added. + The arguments to pass to the function's invocation. + The to monitor for cancellation requests. The default is . + Invokes the and returns its result. + The result of the function's execution. To be added. @@ -117,10 +117,10 @@ - To be added. - To be added. - To be added. - To be added. + The arguments to pass to the function's invocation. + The to monitor for cancellation requests. + Invokes the and returns its result. + The result of the function's execution. To be added. @@ -140,7 +140,7 @@ Microsoft.Extensions.AI.AIFunctionMetadata - To be added. + Gets metadata describing the function. To be added. To be added. @@ -165,6 +165,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/AIFunctionContext.xml b/xml/Microsoft.Extensions.AI/AIFunctionContext.xml index 493d207cda9..f83a07050e9 100644 --- a/xml/Microsoft.Extensions.AI/AIFunctionContext.xml +++ b/xml/Microsoft.Extensions.AI/AIFunctionContext.xml @@ -14,8 +14,14 @@ - To be added. - To be added. + Provides additional context to the invocation of an created by . + + A delegate or passed to methods may represent a method that has a parameter + of type . Whereas all other parameters are passed by name from the supplied collection of arguments, + a parameter is passed specially by the implementation, in order to pass relevant + context into the method's invocation. For example, any passed to the + method is available from the property. + @@ -31,7 +37,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -51,7 +57,7 @@ System.Threading.CancellationToken - To be added. + Gets or sets a related to the operation. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/AIFunctionFactory.xml b/xml/Microsoft.Extensions.AI/AIFunctionFactory.xml index a3be393543f..2b8a726bdfc 100644 --- a/xml/Microsoft.Extensions.AI/AIFunctionFactory.xml +++ b/xml/Microsoft.Extensions.AI/AIFunctionFactory.xml @@ -20,7 +20,7 @@ - To be added. + Provides factory methods for creating commonly-used implementations of . To be added. @@ -51,10 +51,10 @@ - To be added. - To be added. - To be added. - To be added. + The method to be represented via the created . + Metadata to use to override defaults inferred from . + Creates an instance for a method, specified via a delegate. + The created for invoking . To be added. @@ -93,11 +93,17 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The method to be represented via the created . + + The target object for the if it represents an instance method. + This should be if and only if is a static method. + + Metadata to use to override defaults inferred from . + + Creates an instance for a method, specified via an instance + and an optional target object if the method is an instance method. + + The created for invoking . To be added. @@ -135,12 +141,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The method to be represented via the created . + The name to use for the . + The description to use for the . + The used to marshal function parameters and any return value. + Creates an instance for a method, specified via a delegate. + The created for invoking . To be added. @@ -179,13 +185,19 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The method to be represented via the created . + + The target object for the if it represents an instance method. + This should be if and only if is a static method. + + The name to use for the . + The description to use for the . + The used to marshal function parameters and return value. + + Creates an instance for a method, specified via an instance + and an optional target object if the method is an instance method. + + The created for invoking . To be added. diff --git a/xml/Microsoft.Extensions.AI/AIFunctionFactoryCreateOptions.xml b/xml/Microsoft.Extensions.AI/AIFunctionFactoryCreateOptions.xml index 48772f6cfec..8a6b3169c1a 100644 --- a/xml/Microsoft.Extensions.AI/AIFunctionFactoryCreateOptions.xml +++ b/xml/Microsoft.Extensions.AI/AIFunctionFactoryCreateOptions.xml @@ -20,7 +20,9 @@ - To be added. + + Options that can be provided when creating an from a method. + To be added. @@ -37,7 +39,9 @@ - To be added. + + Initializes a new instance of the class. + To be added. @@ -63,9 +67,13 @@ System.Collections.Generic.IReadOnlyDictionary<System.String,System.Object> - To be added. + + Gets or sets additional values that will be stored on the resulting property. + To be added. - To be added. + + This can be used to provide arbitrary information about the function. + @@ -84,9 +92,12 @@ System.String - To be added. + Gets or sets the description to use for the function. To be added. - To be added. + + If , it will default to one derived from the passed or , if possible + (e.g. via a on the method). + @@ -105,9 +116,11 @@ System.String - To be added. + Gets or sets the name to use for the function. To be added. - To be added. + + If , it will default to one derived from the method represented by the passed or . + @@ -132,9 +145,11 @@ System.Collections.Generic.IReadOnlyList<Microsoft.Extensions.AI.AIFunctionParameterMetadata> - To be added. + Gets or sets metadata for the parameters of the function. To be added. - To be added. + + If , it will default to metadata derived from the passed or . + @@ -153,9 +168,11 @@ Microsoft.Extensions.AI.AIFunctionReturnParameterMetadata - To be added. + Gets or sets metadata for function's return parameter. To be added. - To be added. + + If , it will default to one derived from the passed or . + @@ -180,7 +197,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets the used to marshal .NET values being passed to the underlying delegate. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/AIFunctionMetadata.xml b/xml/Microsoft.Extensions.AI/AIFunctionMetadata.xml index b6d665b634c..6992179b843 100644 --- a/xml/Microsoft.Extensions.AI/AIFunctionMetadata.xml +++ b/xml/Microsoft.Extensions.AI/AIFunctionMetadata.xml @@ -20,7 +20,9 @@ - To be added. + + Provides read-only metadata for an . + To be added. @@ -41,8 +43,12 @@ To be added. - To be added. - To be added. + Initializes a new instance of the class as a copy of another . + + This creates a shallow clone of . The new instance's and + properties will return the same objects as in the original instance. + + The was null. @@ -61,9 +67,10 @@ - To be added. - To be added. + The name of the function. + Initializes a new instance of the class for a function with the specified name. To be added. + The was null. @@ -88,7 +95,7 @@ System.Collections.Generic.IReadOnlyDictionary<System.String,System.Object> - To be added. + Gets any additional properties associated with the function. To be added. To be added. @@ -109,7 +116,7 @@ System.String - To be added. + Gets a description of the function, suitable for use in describing the purpose to a model. To be added. To be added. @@ -139,9 +146,9 @@ - To be added. - To be added. - To be added. + The name of the parameter. + Gets the for a parameter by its name. + The corresponding , if found; otherwise, null. To be added. @@ -167,7 +174,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets a that may be used to marshal function parameters. To be added. To be added. @@ -188,7 +195,7 @@ System.String - To be added. + Gets the name of the function. To be added. To be added. @@ -209,9 +216,9 @@ System.Collections.Generic.IReadOnlyList<Microsoft.Extensions.AI.AIFunctionParameterMetadata> - To be added. + Gets the metadata for the parameters to the function. To be added. - To be added. + If the function has no parameters, the returned list will be empty. @@ -230,9 +237,9 @@ Microsoft.Extensions.AI.AIFunctionReturnParameterMetadata - To be added. + Gets parameter metadata for the return parameter. To be added. - To be added. + If the function has no return parameter, the returned value will be a default instance of a . diff --git a/xml/Microsoft.Extensions.AI/AIFunctionParameterMetadata.xml b/xml/Microsoft.Extensions.AI/AIFunctionParameterMetadata.xml index 710208f9a0d..e109163c61e 100644 --- a/xml/Microsoft.Extensions.AI/AIFunctionParameterMetadata.xml +++ b/xml/Microsoft.Extensions.AI/AIFunctionParameterMetadata.xml @@ -20,7 +20,9 @@ - To be added. + + Provides read-only metadata for a parameter. + To be added. @@ -41,8 +43,9 @@ To be added. - To be added. - To be added. + Initializes a new instance of the class as a copy of another . + This creates a shallow clone of . + The was null. @@ -61,9 +64,11 @@ - To be added. - To be added. + The name of the parameter. + Initializes a new instance of the class for a parameter with the specified name. To be added. + The was null. + The was empty or composed entirely of whitespace. @@ -82,7 +87,7 @@ System.Object - To be added. + Gets the default value of the parameter. To be added. To be added. @@ -103,7 +108,7 @@ System.String - To be added. + Gets a description of the parameter, suitable for use in describing the purpose to a model. To be added. To be added. @@ -124,7 +129,7 @@ System.Boolean - To be added. + Gets a value indicating whether the parameter has a default value. To be added. To be added. @@ -145,7 +150,7 @@ System.Boolean - To be added. + Gets a value indicating whether the parameter is required. To be added. To be added. @@ -172,7 +177,7 @@ System.String - To be added. + Gets the name of the parameter. To be added. To be added. @@ -193,7 +198,7 @@ System.Type - To be added. + Gets the .NET type of the parameter. To be added. To be added. @@ -214,7 +219,7 @@ System.Object - To be added. + Gets a JSON Schema describing the parameter's type. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/AIFunctionReturnParameterMetadata.xml b/xml/Microsoft.Extensions.AI/AIFunctionReturnParameterMetadata.xml index f575998a76c..706924a98d0 100644 --- a/xml/Microsoft.Extensions.AI/AIFunctionReturnParameterMetadata.xml +++ b/xml/Microsoft.Extensions.AI/AIFunctionReturnParameterMetadata.xml @@ -20,7 +20,9 @@ - To be added. + + Provides read-only metadata for a 's return parameter. + To be added. @@ -37,7 +39,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -58,7 +60,7 @@ To be added. - To be added. + Initializes a new instance of the class as a copy of another . To be added. @@ -78,7 +80,7 @@ System.String - To be added. + Gets a description of the return parameter, suitable for use in describing the purpose to a model. To be added. To be added. @@ -105,7 +107,7 @@ Microsoft.Extensions.AI.AIFunctionReturnParameterMetadata - To be added. + Gets an empty return parameter metadata instance. To be added. To be added. @@ -126,7 +128,7 @@ System.Type - To be added. + Gets the .NET type of the return parameter. To be added. To be added. @@ -147,7 +149,7 @@ System.Object - To be added. + Gets a JSON Schema describing the type of the return parameter. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/AIJsonSchemaCreateOptions.xml b/xml/Microsoft.Extensions.AI/AIJsonSchemaCreateOptions.xml index ab92a6a75bd..b7d2c1fc74c 100644 --- a/xml/Microsoft.Extensions.AI/AIJsonSchemaCreateOptions.xml +++ b/xml/Microsoft.Extensions.AI/AIJsonSchemaCreateOptions.xml @@ -20,7 +20,9 @@ - To be added. + + An options class for configuring the behavior of JSON schema creation functionality. + To be added. @@ -57,7 +59,9 @@ Microsoft.Extensions.AI.AIJsonSchemaCreateOptions - To be added. + + Gets the default options instance. + To be added. To be added. @@ -78,7 +82,9 @@ System.Boolean - To be added. + + Gets a value indicating whether to generate schemas with the additionalProperties set to false for .NET objects. + To be added. To be added. @@ -99,7 +105,9 @@ System.Boolean - To be added. + + Gets a value indicating whether to include the $schema keyword in inferred schemas. + To be added. To be added. @@ -120,7 +128,9 @@ System.Boolean - To be added. + + Gets a value indicating whether to include the type keyword in inferred schemas for .NET enums. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/AIJsonUtilities.xml b/xml/Microsoft.Extensions.AI/AIJsonUtilities.xml index 4cfee609b97..fd3e2c8dfc0 100644 --- a/xml/Microsoft.Extensions.AI/AIJsonUtilities.xml +++ b/xml/Microsoft.Extensions.AI/AIJsonUtilities.xml @@ -20,7 +20,7 @@ - To be added. + Provides a collection of utility methods for marshalling JSON data. To be added. @@ -47,14 +47,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type for which to generate the schema. + The description of the parameter. + Whether the parameter is optional. + The default value of the optional parameter, if applicable. + The options used to extract the schema from the specified type. + The options controlling schema inference. + Creates a JSON schema for the specified type. + A representing the schema. To be added. @@ -89,15 +89,17 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the parameter. + The name of the parameter. + The description of the parameter. + Whether the parameter is optional. + The default value of the optional parameter, if applicable. + The options used to extract the schema from the specified type. + The options controlling schema inference. + + Creates a JSON schema for the provided parameter metadata. + + A JSON schema document encoded as a . To be added. @@ -117,7 +119,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets the singleton used as the default in JSON serialization operations. To be added. To be added. @@ -157,12 +159,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The parameter metadata from which to infer the schema. + The containing function metadata. + The options used to extract the schema from the specified type. + The options controlling schema inference. + + Determines a JSON schema for the provided parameter metadata. + + A JSON schema document encoded as a . To be added. diff --git a/xml/Microsoft.Extensions.AI/AITool.xml b/xml/Microsoft.Extensions.AI/AITool.xml index 031b2ac3581..b171680d07b 100644 --- a/xml/Microsoft.Extensions.AI/AITool.xml +++ b/xml/Microsoft.Extensions.AI/AITool.xml @@ -14,7 +14,7 @@ - To be added. + Represents a tool that may be specified to an AI service. To be added. @@ -31,7 +31,7 @@ - To be added. + Initializes a new instance of the class. To be added. diff --git a/xml/Microsoft.Extensions.AI/AdditionalPropertiesDictionary.xml b/xml/Microsoft.Extensions.AI/AdditionalPropertiesDictionary.xml index eeeeeb2680f..50262add1f9 100644 --- a/xml/Microsoft.Extensions.AI/AdditionalPropertiesDictionary.xml +++ b/xml/Microsoft.Extensions.AI/AdditionalPropertiesDictionary.xml @@ -51,7 +51,7 @@ - To be added. + Provides a dictionary used as the AdditionalProperties dictionary on Microsoft.Extensions.AI objects. To be added. @@ -68,7 +68,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -96,7 +96,7 @@ To be added. - To be added. + Initializes a new instance of the class. To be added. @@ -124,7 +124,7 @@ To be added. - To be added. + Initializes a new instance of the class. To be added. @@ -162,6 +162,7 @@ To be added. To be added. To be added. + @@ -186,6 +187,7 @@ To be added. To be added. + @@ -205,8 +207,11 @@ - To be added. - To be added. + Creates a shallow clone of the properties dictionary. + + A shallow clone of the properties dictionary. The instance will not be the same as the current instance, + but it will contain all of the same key-value pairs. + To be added. @@ -237,6 +242,7 @@ To be added. To be added. To be added. + @@ -262,6 +268,7 @@ To be added. To be added. To be added. + @@ -293,6 +300,7 @@ To be added. To be added. To be added. + @@ -327,6 +335,7 @@ To be added. To be added. To be added. + @@ -351,6 +360,7 @@ To be added. To be added. To be added. + @@ -379,6 +389,7 @@ To be added. To be added. To be added. + @@ -413,6 +424,7 @@ To be added. To be added. To be added. + @@ -448,6 +460,7 @@ To be added. To be added. To be added. + @@ -484,6 +497,7 @@ To be added. To be added. To be added. + @@ -508,6 +522,7 @@ To be added. To be added. To be added. + @@ -543,6 +558,7 @@ To be added. To be added. To be added. + @@ -567,6 +583,7 @@ To be added. To be added. To be added. + @@ -597,6 +614,7 @@ To be added. To be added. To be added. + @@ -622,6 +640,7 @@ To be added. To be added. To be added. + @@ -656,6 +675,7 @@ To be added. To be added. To be added. + @@ -695,12 +715,21 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + Specifies the type of the value to be retrieved. + The key to locate. + + The value retrieved from the dictionary, if found and successfully converted to the requested type; + otherwise, the default value of . + + Attempts to extract a typed value from the dictionary. + + if a non- value was found for + in the dictionary and converted to the requested type; otherwise, . + + + If a non- is found for the key in the dictionary, but the value is not of the requested type but is + an object, the method will attempt to convert the object to the requested type. + @@ -731,6 +760,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/AudioContent.xml b/xml/Microsoft.Extensions.AI/AudioContent.xml index 98f6bff25b3..784abef7757 100644 --- a/xml/Microsoft.Extensions.AI/AudioContent.xml +++ b/xml/Microsoft.Extensions.AI/AudioContent.xml @@ -14,7 +14,9 @@ - To be added. + + Represents audio content. + To be added. @@ -41,9 +43,11 @@ - To be added. - To be added. - To be added. + The byte contents. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. @@ -83,9 +87,11 @@ - To be added. - To be added. - To be added. + The URI of the content. This may be a data URI. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. @@ -112,9 +118,11 @@ - To be added. - To be added. - To be added. + The URI of the content. This may be a data URI. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. diff --git a/xml/Microsoft.Extensions.AI/AutoChatToolMode.xml b/xml/Microsoft.Extensions.AI/AutoChatToolMode.xml index f8b0549080e..3b83747d700 100644 --- a/xml/Microsoft.Extensions.AI/AutoChatToolMode.xml +++ b/xml/Microsoft.Extensions.AI/AutoChatToolMode.xml @@ -20,8 +20,12 @@ - To be added. - To be added. + + Indicates that an is free to select any of the available tools, or none at all. + + + Use to get an instance of . + @@ -37,8 +41,8 @@ - To be added. - To be added. + Initializes a new instance of the class. + Use to get an instance of . @@ -64,6 +68,7 @@ To be added. To be added. To be added. + @@ -86,6 +91,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/AzureAIInferenceChatClient.xml b/xml/Microsoft.Extensions.AI/AzureAIInferenceChatClient.xml index 7f1836345a5..03d0b101ab7 100644 --- a/xml/Microsoft.Extensions.AI/AzureAIInferenceChatClient.xml +++ b/xml/Microsoft.Extensions.AI/AzureAIInferenceChatClient.xml @@ -27,7 +27,7 @@ - To be added. + An for an Azure AI Inference . To be added. @@ -54,9 +54,9 @@ - To be added. - To be added. - To be added. + The underlying client. + The id of the model to use. If null, it may be provided per request via . + Initializes a new instance of the class for the specified . To be added. @@ -96,6 +96,7 @@ To be added. To be added. To be added. + @@ -147,6 +148,7 @@ To be added. To be added. To be added. + @@ -188,6 +190,7 @@ To be added. To be added. To be added. + @@ -212,6 +215,7 @@ To be added. To be added. To be added. + @@ -236,6 +240,7 @@ To be added. To be added. + @@ -260,7 +265,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets to use for any serialization activities related to tool call arguments and results. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/AzureAIInferenceEmbeddingGenerator.xml b/xml/Microsoft.Extensions.AI/AzureAIInferenceEmbeddingGenerator.xml index 36237f4acb9..b7727d2031d 100644 --- a/xml/Microsoft.Extensions.AI/AzureAIInferenceEmbeddingGenerator.xml +++ b/xml/Microsoft.Extensions.AI/AzureAIInferenceEmbeddingGenerator.xml @@ -27,7 +27,7 @@ - To be added. + An for an Azure.AI.Inference . To be added. @@ -55,10 +55,13 @@ - To be added. - To be added. - To be added. - To be added. + The underlying client. + + The id of the model to use. This may also be overridden per request via . + Either this parameter or must provide a valid model id. + + The number of dimensions to generate in each embedding. + Initializes a new instance of the class. To be added. @@ -98,6 +101,7 @@ To be added. To be added. To be added. + @@ -139,6 +143,7 @@ To be added. To be added. To be added. + @@ -163,6 +168,7 @@ To be added. To be added. To be added. + @@ -187,6 +193,7 @@ To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/AzureAIInferenceExtensions.xml b/xml/Microsoft.Extensions.AI/AzureAIInferenceExtensions.xml index 62d6a66e96e..9e29956a563 100644 --- a/xml/Microsoft.Extensions.AI/AzureAIInferenceExtensions.xml +++ b/xml/Microsoft.Extensions.AI/AzureAIInferenceExtensions.xml @@ -20,7 +20,7 @@ - To be added. + Provides extension methods for working with Azure AI Inference. To be added. @@ -50,10 +50,10 @@ - To be added. - To be added. - To be added. - To be added. + The client. + The id of the model to use. If null, it may be provided per request via . + Gets an for use with this . + An that may be used to converse via the . To be added. @@ -84,11 +84,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The client. + The id of the model to use. If null, it may be provided per request via . + The number of dimensions to generate in each embedding. + Gets an for use with this . + An that may be used to generate embeddings via the . To be added. diff --git a/xml/Microsoft.Extensions.AI/CachingChatClient.xml b/xml/Microsoft.Extensions.AI/CachingChatClient.xml index 4bd87bdc90d..6b21cd3e41f 100644 --- a/xml/Microsoft.Extensions.AI/CachingChatClient.xml +++ b/xml/Microsoft.Extensions.AI/CachingChatClient.xml @@ -20,7 +20,9 @@ - To be added. + + A delegating chat client that caches the results of chat calls. + To be added. @@ -40,8 +42,8 @@ - To be added. - To be added. + The underlying . + Initializes a new instance of the class. To be added. @@ -61,9 +63,19 @@ System.Boolean - To be added. + Gets or sets a value indicating whether to coalesce streaming updates. To be added. - To be added. + + + When , the client will attempt to coalesce contiguous streaming updates + into a single update, in order to reduce the number of individual items that are yielded on + subsequent enumerations of the cached data. When , the updates are + kept unaltered. + + + The default is . + + @@ -99,6 +111,7 @@ To be added. To be added. To be added. + @@ -147,6 +160,7 @@ To be added. To be added. To be added. + @@ -177,11 +191,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A flag to indicate if this is a streaming call. + The chat content. + The chat options to configure the request. + + Computes a cache key for the specified call parameters. + + A string that will be used as a cache key. To be added. @@ -211,10 +227,13 @@ - To be added. - To be added. - To be added. - To be added. + The cache key. + The to monitor for cancellation requests. + + Returns a previously cached , if available. + This is used when there is a call to . + + The previously cached data, if available, otherwise . To be added. @@ -244,10 +263,13 @@ - To be added. - To be added. - To be added. - To be added. + The cache key. + The to monitor for cancellation requests. + + Returns a previously cached list of values, if available. + This is used when there is a call to . + + The previously cached data, if available, otherwise . To be added. @@ -272,11 +294,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The cache key. + The to be stored. + The to monitor for cancellation requests. + + Stores a in the underlying cache. + This is used when there is a call to . + + A representing the completion of the operation. To be added. @@ -301,11 +326,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The cache key. + The to be stored. + The to monitor for cancellation requests. + + Stores a list of values in the underlying cache. + This is used when there is a call to . + + A representing the completion of the operation. To be added. diff --git a/xml/Microsoft.Extensions.AI/CachingEmbeddingGenerator`2.xml b/xml/Microsoft.Extensions.AI/CachingEmbeddingGenerator`2.xml index ee528a5c67b..8034663728f 100644 --- a/xml/Microsoft.Extensions.AI/CachingEmbeddingGenerator`2.xml +++ b/xml/Microsoft.Extensions.AI/CachingEmbeddingGenerator`2.xml @@ -45,9 +45,9 @@ - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embeddings to generate. + A delegating embedding generator that caches the results of embedding generation calls. To be added. @@ -67,8 +67,8 @@ - To be added. - To be added. + The underlying . + Initializes a new instance of the class. To be added. @@ -105,6 +105,7 @@ To be added. To be added. To be added. + @@ -134,10 +135,12 @@ - To be added. - To be added. - To be added. - To be added. + The for which an embedding is being requested. + The options to configure the request. + + Computes a cache key for the specified call parameters. + + A string that will be used as a cache key. To be added. @@ -167,10 +170,10 @@ - To be added. - To be added. - To be added. - To be added. + The cache key. + The to monitor for cancellation requests. + Returns a previously cached , if available. + The previously cached data, if available, otherwise . To be added. @@ -195,11 +198,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The cache key. + The to be stored. + The to monitor for cancellation requests. + Stores a in the underlying cache. + A representing the completion of the operation. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatClientBuilder.xml b/xml/Microsoft.Extensions.AI/ChatClientBuilder.xml index 0783143c8e3..fa76550a71c 100644 --- a/xml/Microsoft.Extensions.AI/ChatClientBuilder.xml +++ b/xml/Microsoft.Extensions.AI/ChatClientBuilder.xml @@ -20,7 +20,7 @@ - To be added. + A builder for creating pipelines of . To be added. @@ -39,8 +39,8 @@ - To be added. - To be added. + The service provider to use for dependency injection. + Initializes a new instance of the class. To be added. @@ -60,7 +60,7 @@ System.IServiceProvider - To be added. + Gets the associated with the builder instance. To be added. To be added. @@ -84,9 +84,9 @@ - To be added. - To be added. - To be added. + The inner client to use. + Completes the pipeline by adding a final that represents the underlying backend. This is typically a client for an LLM service. + An instance of that represents the entire pipeline. Calls to this instance will pass through each of the pipeline stages in turn. To be added. @@ -109,9 +109,9 @@ - To be added. - To be added. - To be added. + The client factory function. + Adds a factory for an intermediate chat client to the chat client pipeline. + The updated instance. To be added. @@ -134,9 +134,9 @@ - To be added. - To be added. - To be added. + The client factory function. + Adds a factory for an intermediate chat client to the chat client pipeline. + The updated instance. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatClientBuilderServiceCollectionExtensions.xml b/xml/Microsoft.Extensions.AI/ChatClientBuilderServiceCollectionExtensions.xml index f962c2164aa..199478dce76 100644 --- a/xml/Microsoft.Extensions.AI/ChatClientBuilderServiceCollectionExtensions.xml +++ b/xml/Microsoft.Extensions.AI/ChatClientBuilderServiceCollectionExtensions.xml @@ -20,7 +20,7 @@ - To be added. + Provides extension methods for registering with a . To be added. @@ -44,11 +44,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The to which the client should be added. + The factory to use to construct the instance. + Adds a chat client to the . + The collection. + The client is registered as a scoped service. @@ -72,12 +72,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to which the client should be added. + The key with which to associate the client. + The factory to use to construct the instance. + Adds a chat client to the . + The collection. + The client is registered as a scoped service. diff --git a/xml/Microsoft.Extensions.AI/ChatClientExtensions.xml b/xml/Microsoft.Extensions.AI/ChatClientExtensions.xml index 0cfbbdc41c4..f8134a869b9 100644 --- a/xml/Microsoft.Extensions.AI/ChatClientExtensions.xml +++ b/xml/Microsoft.Extensions.AI/ChatClientExtensions.xml @@ -20,7 +20,7 @@ - To be added. + Provides a collection of static methods for extending instances. To be added. @@ -52,12 +52,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The chat client. + The text content for the chat message to send. + The chat options to configure the request. + The to monitor for cancellation requests. The default is . + Sends a user chat text message to the model and returns the response messages. + The response messages generated by the client. To be added. @@ -89,12 +89,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The chat client. + The text content for the chat message to send. + The chat options to configure the request. + The to monitor for cancellation requests. The default is . + Sends a user chat text message to the model and streams the response messages. + The response messages generated by the client. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatClientMetadata.xml b/xml/Microsoft.Extensions.AI/ChatClientMetadata.xml index 6ec7f980266..2442186b666 100644 --- a/xml/Microsoft.Extensions.AI/ChatClientMetadata.xml +++ b/xml/Microsoft.Extensions.AI/ChatClientMetadata.xml @@ -20,7 +20,7 @@ - To be added. + Provides metadata about an . To be added. @@ -41,10 +41,10 @@ - To be added. - To be added. - To be added. - To be added. + The name of the chat completion provider, if applicable. + The URL for accessing the chat completion provider, if applicable. + The id of the chat completion model used, if applicable. + Initializes a new instance of the class. To be added. @@ -64,9 +64,9 @@ System.String - To be added. + Gets the id of the model used by this chat completion provider. To be added. - To be added. + This may be null if either the name is unknown or there are multiple possible models associated with this instance. @@ -85,7 +85,7 @@ System.String - To be added. + Gets the name of the chat completion provider. To be added. To be added. @@ -106,7 +106,7 @@ System.Uri - To be added. + Gets the URL for accessing the chat completion provider. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatClientStructuredOutputExtensions.xml b/xml/Microsoft.Extensions.AI/ChatClientStructuredOutputExtensions.xml index 11ceec49522..370221acf9b 100644 --- a/xml/Microsoft.Extensions.AI/ChatClientStructuredOutputExtensions.xml +++ b/xml/Microsoft.Extensions.AI/ChatClientStructuredOutputExtensions.xml @@ -20,7 +20,9 @@ - To be added. + + Provides extension methods on that simplify working with structured output. + To be added. @@ -63,15 +65,22 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of structured output to request. + The . + The chat content to send. + The chat options to configure the request. + + Optionally specifies whether to set a JSON schema on the . + This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it. + If not specified, the underlying provider's default will be used. + + The to monitor for cancellation requests. The default is . + Sends chat messages to the model, requesting a response matching the type . + The response messages generated by the client. + + The returned messages will not have been added to . However, any intermediate messages generated implicitly + by the client, including any messages for roundtrips to the model as part of the implementation of this request, will be included. + @@ -113,14 +122,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of structured output to request. + The . + The text content for the chat message to send. + The chat options to configure the request. + + Optionally specifies whether to set a JSON schema on the . + This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it. + If not specified, the underlying provider's default will be used. + + The to monitor for cancellation requests. The default is . + Sends a user chat text message to the model, requesting a response matching the type . + The response messages generated by the client. To be added. @@ -164,16 +177,23 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of structured output to request. + The . + The chat content to send. + The JSON serialization options to use. + The chat options to configure the request. + + Optionally specifies whether to set a JSON schema on the . + This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it. + If not specified, the underlying provider's default will be used. + + The to monitor for cancellation requests. The default is . + Sends chat messages to the model, requesting a response matching the type . + The response messages generated by the client. + + The returned messages will not have been added to . However, any intermediate messages generated implicitly + by the client, including any messages for roundtrips to the model as part of the implementation of this request, will be included. + @@ -216,15 +236,19 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of structured output to request. + The . + The text content for the chat message to send. + The JSON serialization options to use. + The chat options to configure the request. + + Optionally specifies whether to set a JSON schema on the . + This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it. + If not specified, the underlying provider's default will be used. + + The to monitor for cancellation requests. The default is . + Sends a user chat text message to the model, requesting a response matching the type . + The response messages generated by the client. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatCompletion.xml b/xml/Microsoft.Extensions.AI/ChatCompletion.xml index df4c96e26d5..820135da4a6 100644 --- a/xml/Microsoft.Extensions.AI/ChatCompletion.xml +++ b/xml/Microsoft.Extensions.AI/ChatCompletion.xml @@ -20,7 +20,7 @@ - To be added. + Represents the result of a chat completion request. To be added. @@ -40,8 +40,8 @@ - To be added. - To be added. + The chat message representing the singular choice in the completion. + Initializes a new instance of the class. To be added. @@ -67,8 +67,8 @@ - To be added. - To be added. + The list of choices in the completion, one message per choice. + Initializes a new instance of the class. To be added. @@ -88,7 +88,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets any additional properties associated with the chat completion. To be added. To be added. @@ -115,7 +115,7 @@ System.Collections.Generic.IList<Microsoft.Extensions.AI.ChatMessage> - To be added. + Gets or sets the list of chat completion choices. To be added. To be added. @@ -136,7 +136,7 @@ System.String - To be added. + Gets or sets the ID of the chat completion. To be added. To be added. @@ -157,7 +157,7 @@ System.Nullable<System.DateTimeOffset> - To be added. + Gets or sets a timestamp for the chat completion. To be added. To be added. @@ -178,7 +178,7 @@ System.Nullable<Microsoft.Extensions.AI.ChatFinishReason> - To be added. + Gets or sets the reason for the chat completion. To be added. To be added. @@ -209,9 +209,12 @@ Microsoft.Extensions.AI.ChatMessage - To be added. + Gets the chat completion message. To be added. - To be added. + + If there are multiple choices, this property returns the first choice. + If is empty, this will throw. Use to access all choices directly."/>. + @@ -230,7 +233,7 @@ System.String - To be added. + Gets or sets the model ID used in the creation of the chat completion. To be added. To be added. @@ -257,9 +260,13 @@ System.Object - To be added. + Gets or sets the raw representation of the chat completion from an underlying implementation. To be added. - To be added. + + If a is created to represent some underlying object from another object + model, this property can be used to store that original object. This can be useful for debugging or + for enabling a consumer to access the underlying object model if needed. + @@ -282,6 +289,7 @@ To be added. To be added. To be added. + @@ -300,7 +308,7 @@ Microsoft.Extensions.AI.UsageDetails - To be added. + Gets or sets usage details for the chat completion. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatCompletion`1.xml b/xml/Microsoft.Extensions.AI/ChatCompletion`1.xml index bca9209e492..452573cec49 100644 --- a/xml/Microsoft.Extensions.AI/ChatCompletion`1.xml +++ b/xml/Microsoft.Extensions.AI/ChatCompletion`1.xml @@ -30,9 +30,13 @@ - To be added. - To be added. - To be added. + The type of value expected from the chat completion. + Represents the result of a chat completion request with structured output. + + Language models are not guaranteed to honor the requested schema. If the model's output is not + parseable as the expected type, then will return . + You can access the underlying JSON response on the property. + @@ -52,9 +56,9 @@ - To be added. - To be added. - To be added. + The unstructured that is being wrapped. + The to use when deserializing the result. + Initializes a new instance of the class. To be added. @@ -74,7 +78,11 @@ T - To be added. + + Gets the result of the chat completion as an instance of . + If the response did not contain JSON, or if deserialization fails, this property will throw. + To avoid exceptions, use instead. + To be added. To be added. @@ -105,9 +113,12 @@ - To be added. - To be added. - To be added. + The result. + + Attempts to deserialize the result to produce an instance of . + + + if the result was produced, otherwise . To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatFinishReason+Converter.xml b/xml/Microsoft.Extensions.AI/ChatFinishReason+Converter.xml index 5d448eb1174..82b6090f567 100644 --- a/xml/Microsoft.Extensions.AI/ChatFinishReason+Converter.xml +++ b/xml/Microsoft.Extensions.AI/ChatFinishReason+Converter.xml @@ -27,7 +27,7 @@ - To be added. + Provides a for serializing instances. To be added. @@ -75,6 +75,7 @@ To be added. To be added. To be added. + @@ -103,6 +104,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/ChatFinishReason.xml b/xml/Microsoft.Extensions.AI/ChatFinishReason.xml index acd8eb6a52c..70324f9fa36 100644 --- a/xml/Microsoft.Extensions.AI/ChatFinishReason.xml +++ b/xml/Microsoft.Extensions.AI/ChatFinishReason.xml @@ -32,7 +32,7 @@ - To be added. + Represents the reason a chat response completed. To be added. @@ -58,9 +58,13 @@ - To be added. - To be added. + The reason value. + Initializes a new instance of the struct with a string that describes the reason. To be added. + + is null. + + is empty or composed entirely of whitespace. @@ -79,7 +83,7 @@ Microsoft.Extensions.AI.ChatFinishReason - To be added. + Gets a representing the model filtering content, whether for safety, prohibited content, sensitive content, or other such issues. To be added. To be added. @@ -110,6 +114,7 @@ To be added. To be added. To be added. + @@ -142,6 +147,7 @@ To be added. To be added. To be added. + @@ -164,6 +170,7 @@ To be added. To be added. To be added. + @@ -182,7 +189,7 @@ Microsoft.Extensions.AI.ChatFinishReason - To be added. + Gets a representing the model reaching the maximum length allowed for the request and/or response (typically in terms of tokens). To be added. To be added. @@ -207,10 +214,13 @@ - To be added. - To be added. - To be added. - To be added. + Left argument of the comparison. + Right argument of the comparison. + + Compares two instances. + + + when equal, otherwise. To be added. @@ -234,10 +244,13 @@ - To be added. - To be added. - To be added. - To be added. + Left argument of the comparison. + Right argument of the comparison. + + Compares two instances. + + + when not equal, otherwise. To be added. @@ -257,7 +270,7 @@ Microsoft.Extensions.AI.ChatFinishReason - To be added. + Gets a representing the model encountering a natural stop point or provided stop sequence. To be added. To be added. @@ -278,7 +291,7 @@ Microsoft.Extensions.AI.ChatFinishReason - To be added. + Gets a representing the model requesting the use of a tool that was defined in the request. To be added. To be added. @@ -300,8 +313,8 @@ - To be added. - To be added. + Gets the of the finish reason. + The of the finish reason. To be added. @@ -321,7 +334,7 @@ System.String - To be added. + Gets the finish reason value. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatMessage.xml b/xml/Microsoft.Extensions.AI/ChatMessage.xml index 4efd8a15d63..8a3b72d39cf 100644 --- a/xml/Microsoft.Extensions.AI/ChatMessage.xml +++ b/xml/Microsoft.Extensions.AI/ChatMessage.xml @@ -20,7 +20,7 @@ - To be added. + Represents a chat message used by an . To be added. @@ -43,7 +43,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -64,9 +64,9 @@ - To be added. - To be added. - To be added. + Role of the author of the message. + The contents for this message. + Initializes a new instance of the class. To be added. @@ -87,9 +87,9 @@ - To be added. - To be added. - To be added. + Role of the author of the message. + Content of the message. + Initializes a new instance of the class. To be added. @@ -109,7 +109,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets any additional properties associated with the message. To be added. To be added. @@ -130,7 +130,7 @@ System.String - To be added. + Gets or sets the name of the author of the message. To be added. To be added. @@ -157,7 +157,7 @@ System.Collections.Generic.IList<Microsoft.Extensions.AI.AIContent> - To be added. + Gets or sets the chat message content items. To be added. To be added. @@ -184,9 +184,13 @@ System.Object - To be added. + Gets or sets the raw representation of the chat message from an underlying implementation. To be added. - To be added. + + If a is created to represent some underlying object from another object + model, this property can be used to store that original object. This can be useful for debugging or + for enabling a consumer to access the underlying object model if needed. + @@ -205,7 +209,7 @@ Microsoft.Extensions.AI.ChatRole - To be added. + Gets or sets the role of the author of the message. To be added. To be added. @@ -232,9 +236,14 @@ System.String - To be added. + + Gets or sets the text of the first instance in . + To be added. - To be added. + + If there is no instance in , then the getter returns , + and the setter will add a new instance with the provided value. + @@ -257,6 +266,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/ChatOptions.xml b/xml/Microsoft.Extensions.AI/ChatOptions.xml index 44e279a50ba..1c6992a4b1a 100644 --- a/xml/Microsoft.Extensions.AI/ChatOptions.xml +++ b/xml/Microsoft.Extensions.AI/ChatOptions.xml @@ -20,7 +20,7 @@ - To be added. + Represents the options for a chat request. To be added. @@ -57,7 +57,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets any additional properties associated with the options. To be added. To be added. @@ -79,9 +79,13 @@ - To be added. - To be added. - To be added. + Produces a clone of the current instance. + A clone of the current instance. + + The clone will have the same values for all properties as the original instance. Any collections, like , + , and , are shallow-cloned, meaning a new collection instance is created, + but any references contained by the collections are shared with the original. + @@ -100,7 +104,7 @@ System.Nullable<System.Single> - To be added. + Gets or sets the frequency penalty for generating chat responses. To be added. To be added. @@ -121,7 +125,7 @@ System.Nullable<System.Int32> - To be added. + Gets or sets the maximum number of tokens in the generated chat response. To be added. To be added. @@ -142,7 +146,7 @@ System.String - To be added. + Gets or sets the model ID for the chat request. To be added. To be added. @@ -163,7 +167,7 @@ System.Nullable<System.Single> - To be added. + Gets or sets the presence penalty for generating chat responses. To be added. To be added. @@ -184,9 +188,19 @@ Microsoft.Extensions.AI.ChatResponseFormat - To be added. + + Gets or sets the response format for the chat request. + To be added. - To be added. + + If null, no response format is specified and the client will use its default. + This may be set to to specify that the response should be unstructured text, + to to specify that the response should be structured JSON data, or + an instance of constructed with a specific JSON schema to request that the + response be structured JSON data according to that schema. It is up to the client implementation if or how + to honor the request. If the client implementation doesn't recognize the specific kind of , + it may be ignored. + @@ -211,7 +225,7 @@ System.Collections.Generic.IList<System.String> - To be added. + Gets or sets the stop sequences for generating chat responses. To be added. To be added. @@ -232,7 +246,7 @@ System.Nullable<System.Single> - To be added. + Gets or sets the temperature for generating chat responses. To be added. To be added. @@ -259,7 +273,7 @@ Microsoft.Extensions.AI.ChatToolMode - To be added. + Gets or sets the tool mode for the chat request. To be added. To be added. @@ -290,7 +304,7 @@ System.Collections.Generic.IList<Microsoft.Extensions.AI.AITool> - To be added. + Gets or sets the list of tools to include with a chat request. To be added. To be added. @@ -311,7 +325,7 @@ System.Nullable<System.Int32> - To be added. + Gets or sets a count indicating how many of the most probable tokens the model should consider when generating the next part of the text. To be added. To be added. @@ -332,7 +346,7 @@ System.Nullable<System.Single> - To be added. + Gets or sets the "nucleus sampling" factor (or "top p") for generating chat responses. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatResponseFormat.xml b/xml/Microsoft.Extensions.AI/ChatResponseFormat.xml index af7339fea68..850dc2e18c3 100644 --- a/xml/Microsoft.Extensions.AI/ChatResponseFormat.xml +++ b/xml/Microsoft.Extensions.AI/ChatResponseFormat.xml @@ -32,7 +32,7 @@ - To be added. + Represents the response format that is desired by the caller. To be added. @@ -77,11 +77,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The JSON schema. + An optional name of the schema, e.g. if the schema represents a particular class, this could be the name of the class. + An optional description of the schema. + Creates a representing structured JSON data with the specified schema. + The instance. To be added. @@ -101,7 +101,7 @@ Microsoft.Extensions.AI.ChatResponseFormatJson - To be added. + Gets a singleton instance representing structured JSON data but without any particular schema. To be added. To be added. @@ -122,7 +122,7 @@ Microsoft.Extensions.AI.ChatResponseFormatText - To be added. + Gets a singleton instance representing unstructured textual data. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatResponseFormatJson.xml b/xml/Microsoft.Extensions.AI/ChatResponseFormatJson.xml index 1684502c874..adb4de1eb75 100644 --- a/xml/Microsoft.Extensions.AI/ChatResponseFormatJson.xml +++ b/xml/Microsoft.Extensions.AI/ChatResponseFormatJson.xml @@ -24,7 +24,7 @@ - To be added. + Represents a response format for structured JSON data. To be added. @@ -58,10 +58,10 @@ - To be added. - To be added. - To be added. - To be added. + The schema to associate with the JSON response. + A name for the schema. + A description of the schema. + Initializes a new instance of the class with the specified schema. To be added. @@ -88,6 +88,7 @@ To be added. To be added. To be added. + @@ -110,6 +111,7 @@ To be added. To be added. To be added. + @@ -128,7 +130,7 @@ System.String - To be added. + Gets the JSON schema associated with the response, or null if there is none. To be added. To be added. @@ -149,7 +151,7 @@ System.String - To be added. + Gets a description of the schema. To be added. To be added. @@ -170,7 +172,7 @@ System.String - To be added. + Gets a name for the schema. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/ChatResponseFormatText.xml b/xml/Microsoft.Extensions.AI/ChatResponseFormatText.xml index a594f6e0e1b..5a0e17cd997 100644 --- a/xml/Microsoft.Extensions.AI/ChatResponseFormatText.xml +++ b/xml/Microsoft.Extensions.AI/ChatResponseFormatText.xml @@ -20,8 +20,10 @@ - To be added. - To be added. + Represents a response format with no constraints around the format. + + Use to get an instance of . + @@ -37,8 +39,8 @@ - To be added. - To be added. + Initializes a new instance of the class. + Use to get an instance of . @@ -64,6 +66,7 @@ To be added. To be added. To be added. + @@ -86,6 +89,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/ChatRole+Converter.xml b/xml/Microsoft.Extensions.AI/ChatRole+Converter.xml index 4e82f8c0b26..407b1c45862 100644 --- a/xml/Microsoft.Extensions.AI/ChatRole+Converter.xml +++ b/xml/Microsoft.Extensions.AI/ChatRole+Converter.xml @@ -27,7 +27,7 @@ - To be added. + Provides a for serializing instances. To be added. @@ -75,6 +75,7 @@ To be added. To be added. To be added. + @@ -103,6 +104,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/ChatRole.xml b/xml/Microsoft.Extensions.AI/ChatRole.xml index 8538ad7ff15..0b234fc0b46 100644 --- a/xml/Microsoft.Extensions.AI/ChatRole.xml +++ b/xml/Microsoft.Extensions.AI/ChatRole.xml @@ -32,7 +32,9 @@ - To be added. + + Describes the intended purpose of a message within a chat completion interaction. + To be added. @@ -58,8 +60,10 @@ - To be added. - To be added. + The value to associate with this . + + Initializes a new instance of the struct with the provided value. + To be added. @@ -79,7 +83,7 @@ Microsoft.Extensions.AI.ChatRole - To be added. + Gets the role that provides responses to system-instructed, user-prompted input. To be added. To be added. @@ -110,6 +114,7 @@ To be added. To be added. To be added. + @@ -142,6 +147,7 @@ To be added. To be added. To be added. + @@ -164,6 +170,7 @@ To be added. To be added. To be added. + @@ -186,10 +193,13 @@ - To be added. - To be added. - To be added. - To be added. + the first instance to compare. + the second instance to compare. + + Returns a value indicating whether two instances are equivalent, as determined by a + case-insensitive comparison of their values. + + true if left and right are both null or have equivalent values; false otherwise. To be added. @@ -213,10 +223,13 @@ - To be added. - To be added. - To be added. - To be added. + the first instance to compare. + the second instance to compare. + + Returns a value indicating whether two instances are not equivalent, as determined by a + case-insensitive comparison of their values. + + false if left and right are both null or have equivalent values; true otherwise. To be added. @@ -236,7 +249,7 @@ Microsoft.Extensions.AI.ChatRole - To be added. + Gets the role that instructs or sets the behavior of the assistant. To be added. To be added. @@ -257,7 +270,7 @@ Microsoft.Extensions.AI.ChatRole - To be added. + Gets the role that provides additional information and references for chat completions. To be added. To be added. @@ -282,6 +295,7 @@ To be added. To be added. To be added. + @@ -300,7 +314,7 @@ Microsoft.Extensions.AI.ChatRole - To be added. + Gets the role that provides input for chat completions. To be added. To be added. @@ -321,9 +335,13 @@ System.String - To be added. + + Gets the value associated with this . + To be added. - To be added. + + The value is what will be serialized into the "role" message field of the Chat Message format. + diff --git a/xml/Microsoft.Extensions.AI/ChatToolMode.xml b/xml/Microsoft.Extensions.AI/ChatToolMode.xml index 228f4fb7e5e..84bd8898c60 100644 --- a/xml/Microsoft.Extensions.AI/ChatToolMode.xml +++ b/xml/Microsoft.Extensions.AI/ChatToolMode.xml @@ -32,8 +32,13 @@ - To be added. - To be added. + + Describes how tools should be selected by a . + + + The predefined values and are provided. + To nominate a specific function, use . + @@ -52,9 +57,14 @@ Microsoft.Extensions.AI.AutoChatToolMode - To be added. + + Gets a predefined indicating that tool usage is optional. + To be added. - To be added. + + may contain zero or more + instances, and the is free to invoke zero or more of them. + @@ -73,7 +83,10 @@ Microsoft.Extensions.AI.RequiredChatToolMode - To be added. + + Gets a predefined indicating that tool usage is required, + but that any tool may be selected. At least one tool must be provided in . + To be added. To be added. @@ -97,9 +110,13 @@ - To be added. - To be added. - To be added. + The name of the required function. + + Instantiates a indicating that tool usage is required, + and that the specified must be selected. The function name + must match an entry in . + + An instance of for the specified function name. To be added. diff --git a/xml/Microsoft.Extensions.AI/ConfigureOptionsChatClient.xml b/xml/Microsoft.Extensions.AI/ConfigureOptionsChatClient.xml index cbf3e027e1b..4d3f6484f9b 100644 --- a/xml/Microsoft.Extensions.AI/ConfigureOptionsChatClient.xml +++ b/xml/Microsoft.Extensions.AI/ConfigureOptionsChatClient.xml @@ -20,8 +20,29 @@ - To be added. - To be added. + A delegating chat client that updates or replaces the used by the remainder of the pipeline. + + + The configuration callback is invoked with the caller-supplied instance. To override the caller-supplied options + with a new instance, the callback may simply return that new instance, for example _ => new ChatOptions() { MaxTokens = 1000 }. To provide + a new instance only if the caller-supplied instance is `null`, the callback may conditionally return a new instance, for example + options => options ?? new ChatOptions() { MaxTokens = 1000 }. Any changes to the caller-provided options instance will persist on the + original instance, so the callback must take care to only do so when such mutations are acceptable, such as by cloning the original instance + and mutating the clone, for example: + + options => + { + var newOptions = options?.Clone() ?? new(); + newOptions.MaxTokens = 1000; + return newOptions; + } + + + The provided implementation of is thread-safe for concurrent use so long as the employed configuration + callback is also thread-safe for concurrent requests. If callers employ a shared options instance, care should be taken in the + configuration callback, as multiple calls to it may end up running in parallel with the same options instance. + + @@ -48,9 +69,12 @@ - To be added. - To be added. - To be added. + The inner client. + + The delegate to invoke to configure the instance. It is passed the caller-supplied + instance and should return the configured instance to use. + + Initializes a new instance of the class with the specified callback. To be added. @@ -87,6 +111,7 @@ To be added. To be added. To be added. + @@ -135,6 +160,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/ConfigureOptionsChatClientBuilderExtensions.xml b/xml/Microsoft.Extensions.AI/ConfigureOptionsChatClientBuilderExtensions.xml index 4f06c5a0677..33f46ca6990 100644 --- a/xml/Microsoft.Extensions.AI/ConfigureOptionsChatClientBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.AI/ConfigureOptionsChatClientBuilderExtensions.xml @@ -14,7 +14,7 @@ - To be added. + Provides extensions for configuring instances. To be added. @@ -45,11 +45,30 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The . + + The delegate to invoke to configure the instance. It is passed the caller-supplied + instance and should return the configured instance to use. + + + Adds a callback that updates or replaces . This can be used to set default options. + + The . + + The configuration callback is invoked with the caller-supplied instance. To override the caller-supplied options + with a new instance, the callback may simply return that new instance, for example _ => new ChatOptions() { MaxTokens = 1000 }. To provide + a new instance only if the caller-supplied instance is `null`, the callback may conditionally return a new instance, for example + options => options ?? new ChatOptions() { MaxTokens = 1000 }. Any changes to the caller-provided options instance will persist on the + original instance, so the callback must take care to only do so when such mutations are acceptable, such as by cloning the original instance + and mutating the clone, for example: + + options => + { + var newOptions = options?.Clone() ?? new(); + newOptions.MaxTokens = 1000; + return newOptions; + } + diff --git a/xml/Microsoft.Extensions.AI/DataContent.xml b/xml/Microsoft.Extensions.AI/DataContent.xml index aebb70ebde4..559562eb949 100644 --- a/xml/Microsoft.Extensions.AI/DataContent.xml +++ b/xml/Microsoft.Extensions.AI/DataContent.xml @@ -20,8 +20,19 @@ - To be added. - To be added. + + Represents data content, such as an image or audio. + + + + The represented content may either be the actual bytes stored in this instance, or it may + be a URI that references the location of the content. + + + always returns a valid URI string, even if the instance was constructed from + a . In that case, a data URI will be constructed and returned. + + @@ -47,9 +58,11 @@ - To be added. - To be added. - To be added. + The byte contents. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. @@ -89,9 +102,11 @@ - To be added. - To be added. - To be added. + The URI of the content. This may be a data URI. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. @@ -118,9 +133,11 @@ - To be added. - To be added. - To be added. + The URI of the content. This may be a data URI. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. @@ -146,9 +163,15 @@ System.Boolean - To be added. + + Gets a value indicating whether the content contains data rather than only being a reference to data. + To be added. - To be added. + + If the instance is constructed from a or from a data URI, this property will return , + as the instance actually contains all of the data it represents. If, however, the instance was constructed from another form of URI, one + that simply references where the data can be found but doesn't actually contain the data, this property will return . + @@ -185,9 +208,12 @@ System.Nullable<System.ReadOnlyMemory<System.Byte>> - To be added. + Gets the data represented by this instance. To be added. - To be added. + + If is , this property will return the represented data. + If is , this property will return . + @@ -212,9 +238,14 @@ System.String - To be added. + Gets the media type (also known as MIME type) of the content. To be added. - To be added. + + If the media type was explicitly specified, this property will return that value. + If the media type was not explicitly specified, but a data URI was supplied and that data URI contained a non-default + media type, that media type will be returned. + Otherwise, this will return null. + @@ -243,9 +274,13 @@ System.String - To be added. + Gets the URI for this . To be added. - To be added. + + The returned URI is always a valid URI string, even if the instance was constructed from a + or from a . In the case of a , this will return a data URI containing + that data. + diff --git a/xml/Microsoft.Extensions.AI/DelegatingChatClient.xml b/xml/Microsoft.Extensions.AI/DelegatingChatClient.xml index c6d4bdc8dfc..adb42814631 100644 --- a/xml/Microsoft.Extensions.AI/DelegatingChatClient.xml +++ b/xml/Microsoft.Extensions.AI/DelegatingChatClient.xml @@ -27,8 +27,13 @@ - To be added. - To be added. + + Provides an optional base class for an that passes through calls to another instance. + + + This is recommended as a base type when building clients that can be chained in any order around an underlying . + The default implementation simply passes each call to the inner client instance. + @@ -47,8 +52,10 @@ - To be added. - To be added. + The wrapped client instance. + + Initializes a new instance of the class. + To be added. @@ -88,6 +95,7 @@ To be added. To be added. To be added. + @@ -126,6 +134,7 @@ To be added. To be added. To be added. + @@ -150,6 +159,7 @@ To be added. To be added. + @@ -171,8 +181,8 @@ - To be added. - To be added. + true if being called from ; otherwise, false. + Provides a mechanism for releasing unmanaged resources. To be added. @@ -215,6 +225,7 @@ To be added. To be added. To be added. + @@ -233,7 +244,7 @@ Microsoft.Extensions.AI.IChatClient - To be added. + Gets the inner . To be added. To be added. @@ -260,6 +271,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/DelegatingEmbeddingGenerator`2.xml b/xml/Microsoft.Extensions.AI/DelegatingEmbeddingGenerator`2.xml index 83d09af08fa..dc25b41f7ff 100644 --- a/xml/Microsoft.Extensions.AI/DelegatingEmbeddingGenerator`2.xml +++ b/xml/Microsoft.Extensions.AI/DelegatingEmbeddingGenerator`2.xml @@ -48,10 +48,15 @@ - To be added. - To be added. - To be added. - To be added. + Specifies the type of the input passed to the generator. + Specifies the type of the embedding instance produced by the generator. + + Provides an optional base class for an that passes through calls to another instance. + + + This is recommended as a base type when building generators that can be chained in any order around an underlying . + The default implementation simply passes each call to the inner generator instance. + @@ -70,8 +75,10 @@ - To be added. - To be added. + The wrapped generator instance. + + Initializes a new instance of the class. + To be added. @@ -97,6 +104,7 @@ To be added. To be added. + @@ -118,8 +126,8 @@ - To be added. - To be added. + true if being called from ; otherwise, false. + Provides a mechanism for releasing unmanaged resources. To be added. @@ -159,6 +167,7 @@ To be added. To be added. To be added. + @@ -200,6 +209,7 @@ To be added. To be added. To be added. + @@ -218,7 +228,7 @@ Microsoft.Extensions.AI.IEmbeddingGenerator<TInput,TEmbedding> - To be added. + Gets the inner . To be added. To be added. @@ -245,6 +255,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/DistributedCachingChatClient.xml b/xml/Microsoft.Extensions.AI/DistributedCachingChatClient.xml index f776a976b49..1f8504ec6bf 100644 --- a/xml/Microsoft.Extensions.AI/DistributedCachingChatClient.xml +++ b/xml/Microsoft.Extensions.AI/DistributedCachingChatClient.xml @@ -20,8 +20,13 @@ - To be added. - To be added. + + A delegating chat client that caches the results of completion calls, storing them as JSON in an . + + + The provided implementation of is thread-safe for concurrent use so long as the employed + is similarly thread-safe for concurrent use. + @@ -41,9 +46,9 @@ - To be added. - To be added. - To be added. + The underlying . + An instance that will be used as the backing store for the cache. + Initializes a new instance of the class. To be added. @@ -81,6 +86,7 @@ To be added. To be added. To be added. + @@ -99,7 +105,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets JSON serialization options to use when serializing cache data. To be added. To be added. @@ -135,6 +141,7 @@ To be added. To be added. To be added. + @@ -168,6 +175,7 @@ To be added. To be added. To be added. + @@ -197,6 +205,7 @@ To be added. To be added. To be added. + @@ -226,6 +235,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/DistributedCachingChatClientBuilderExtensions.xml b/xml/Microsoft.Extensions.AI/DistributedCachingChatClientBuilderExtensions.xml index 25120b468b0..9a4f23df7e9 100644 --- a/xml/Microsoft.Extensions.AI/DistributedCachingChatClientBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.AI/DistributedCachingChatClientBuilderExtensions.xml @@ -14,7 +14,9 @@ - To be added. + + Extension methods for adding a to an pipeline. + To be added. @@ -52,11 +54,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The . + + An optional instance that will be used as the backing store for the cache. If not supplied, an instance will be resolved from the service provider. + + An optional callback that can be used to configure the instance. + + Adds a as the next stage in the pipeline. + + The provided as . To be added. diff --git a/xml/Microsoft.Extensions.AI/DistributedCachingEmbeddingGeneratorBuilderExtensions.xml b/xml/Microsoft.Extensions.AI/DistributedCachingEmbeddingGeneratorBuilderExtensions.xml index b11268eb43e..bbd32735562 100644 --- a/xml/Microsoft.Extensions.AI/DistributedCachingEmbeddingGeneratorBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.AI/DistributedCachingEmbeddingGeneratorBuilderExtensions.xml @@ -14,7 +14,10 @@ - To be added. + + Extension methods for adding a to an + pipeline. + To be added. @@ -73,13 +76,17 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embeddings to generate. + The . + + An optional instance that will be used as the backing store for the cache. If not supplied, an instance will be resolved from the service provider. + + An optional callback that can be used to configure the instance. + + Adds a as the next stage in the pipeline. + + The provided as . To be added. diff --git a/xml/Microsoft.Extensions.AI/DistributedCachingEmbeddingGenerator`2.xml b/xml/Microsoft.Extensions.AI/DistributedCachingEmbeddingGenerator`2.xml index a813e650156..82dbe165dbc 100644 --- a/xml/Microsoft.Extensions.AI/DistributedCachingEmbeddingGenerator`2.xml +++ b/xml/Microsoft.Extensions.AI/DistributedCachingEmbeddingGenerator`2.xml @@ -45,10 +45,16 @@ - To be added. - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embeddings to generate. + + A delegating embedding generator that caches the results of embedding generation calls, + storing them as JSON in an . + + + The provided implementation of is thread-safe for concurrent + use so long as the employed is similarly thread-safe for concurrent use. + @@ -68,9 +74,9 @@ - To be added. - To be added. - To be added. + The underlying . + A instance that will be used as the backing store for the cache. + Initializes a new instance of the class. To be added. @@ -106,6 +112,7 @@ To be added. To be added. To be added. + @@ -124,7 +131,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets JSON serialization options to use when serializing cache data. To be added. To be added. @@ -160,6 +167,7 @@ To be added. To be added. To be added. + @@ -189,6 +197,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/Embedding.xml b/xml/Microsoft.Extensions.AI/Embedding.xml index 27a2fea206c..87a33104c6e 100644 --- a/xml/Microsoft.Extensions.AI/Embedding.xml +++ b/xml/Microsoft.Extensions.AI/Embedding.xml @@ -44,8 +44,8 @@ - To be added. - To be added. + Represents an embedding generated by a . + This base class provides metadata about the embedding. Derived types provide the concrete data contained in the embedding. @@ -61,7 +61,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -81,7 +81,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets any additional properties associated with the embedding. To be added. To be added. @@ -102,7 +102,7 @@ System.Nullable<System.DateTimeOffset> - To be added. + Gets or sets a timestamp at which the embedding was created. To be added. To be added. @@ -123,7 +123,7 @@ System.String - To be added. + Gets or sets the model ID using in the creation of the embedding. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/EmbeddingGenerationOptions.xml b/xml/Microsoft.Extensions.AI/EmbeddingGenerationOptions.xml index 282358f122c..313f3e11a46 100644 --- a/xml/Microsoft.Extensions.AI/EmbeddingGenerationOptions.xml +++ b/xml/Microsoft.Extensions.AI/EmbeddingGenerationOptions.xml @@ -20,7 +20,7 @@ - To be added. + Represents the options for an embedding generation request. To be added. @@ -57,7 +57,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets additional properties for the embedding generation request. To be added. To be added. @@ -79,9 +79,12 @@ - To be added. - To be added. - To be added. + Produces a clone of the current instance. + A clone of the current instance. + + The clone will have the same values for all properties as the original instance. Any collections, like + are shallow-cloned, meaning a new collection instance is created, but any references contained by the collections are shared with the original. + @@ -100,7 +103,7 @@ System.Nullable<System.Int32> - To be added. + Gets or sets the number of dimensions requested in the embedding. To be added. To be added. @@ -121,7 +124,7 @@ System.String - To be added. + Gets or sets the model ID for the embedding generation request. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilderServiceCollectionExtensions.xml b/xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilderServiceCollectionExtensions.xml index c83b2a2445d..e05ee9bc5a5 100644 --- a/xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilderServiceCollectionExtensions.xml +++ b/xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilderServiceCollectionExtensions.xml @@ -20,7 +20,7 @@ - To be added. + Provides extension methods for registering with a . To be added. @@ -65,13 +65,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embeddings to generate. + The to which the generator should be added. + The factory to use to construct the instance. + Adds a embedding generator to the . + The collection. + The generator is registered as a scoped service. @@ -116,14 +116,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embeddings to generate. + The to which the service should be added. + The key with which to associated the generator. + The factory to use to construct the instance. + Adds an embedding generator to the . + The collection. + The generator is registered as a scoped service. diff --git a/xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilder`2.xml b/xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilder`2.xml index e3710b6f64a..fd67b8b7912 100644 --- a/xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilder`2.xml +++ b/xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilder`2.xml @@ -41,9 +41,9 @@ - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embeddings to generate. + A builder for creating pipelines of . To be added. @@ -62,8 +62,8 @@ - To be added. - To be added. + The service provider to use for dependency injection. + Initializes a new instance of the class. To be added. @@ -83,7 +83,7 @@ System.IServiceProvider - To be added. + Gets the associated with the builder instance. To be added. To be added. @@ -107,10 +107,16 @@ - To be added. - To be added. - To be added. - To be added. + The inner generator to use. + + Builds an instance of using the specified inner generator. + + An instance of . + + If there are any factories registered with this builder, is used as a seed to + the last factory, and the result of each factory delegate is passed to the previously registered factory. + The final result is then returned from this call. + @@ -132,9 +138,9 @@ - To be added. - To be added. - To be added. + The generator factory function. + Adds a factory for an intermediate embedding generator to the embedding generator pipeline. + The updated instance. To be added. @@ -157,9 +163,9 @@ - To be added. - To be added. - To be added. + The generator factory function. + Adds a factory for an intermediate embedding generator to the embedding generator pipeline. + The updated instance. To be added. diff --git a/xml/Microsoft.Extensions.AI/EmbeddingGeneratorExtensions.xml b/xml/Microsoft.Extensions.AI/EmbeddingGeneratorExtensions.xml index 06bc297ef87..bcab3e7dbd6 100644 --- a/xml/Microsoft.Extensions.AI/EmbeddingGeneratorExtensions.xml +++ b/xml/Microsoft.Extensions.AI/EmbeddingGeneratorExtensions.xml @@ -20,7 +20,7 @@ - To be added. + Provides a collection of static methods for extending instances. To be added. @@ -83,14 +83,17 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embedding to generate. + The embedding generator. + The collection of values for which to generate embeddings. + The embedding generation options to configure the request. + The to monitor for cancellation requests. The default is . + + Generates embeddings for each of the supplied and produces a list that pairs + each input value with its resulting embedding. + + An array containing tuples of the input values and the associated generated embeddings. To be added. @@ -143,15 +146,21 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embedding to generate. + The embedding generator. + A value from which an embedding will be generated. + The embedding generation options to configure the request. + The to monitor for cancellation requests. The default is . + Generates an embedding from the specified . + + The generated embedding for the specified . + + + This operations is equivalent to using with a + collection composed of the single and then returning the first embedding element from the + resulting collection. + @@ -199,15 +208,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The numeric type of the embedding data. + The embedding generator. + A value from which an embedding will be generated. + The embedding generation options to configure the request. + The to monitor for cancellation requests. The default is . + Generates an embedding vector from the specified . + The generated embedding for the specified . + + This operation is equivalent to using and returning the + resulting 's property. + diff --git a/xml/Microsoft.Extensions.AI/EmbeddingGeneratorMetadata.xml b/xml/Microsoft.Extensions.AI/EmbeddingGeneratorMetadata.xml index 13487962afa..4ecaab3c2d2 100644 --- a/xml/Microsoft.Extensions.AI/EmbeddingGeneratorMetadata.xml +++ b/xml/Microsoft.Extensions.AI/EmbeddingGeneratorMetadata.xml @@ -20,7 +20,7 @@ - To be added. + Provides metadata about an . To be added. @@ -42,11 +42,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The name of the embedding generation provider, if applicable. + The URL for accessing the embedding generation provider, if applicable. + The id of the embedding generation model used, if applicable. + The number of dimensions in vectors produced by this generator, if applicable. + Initializes a new instance of the class. To be added. @@ -66,7 +66,7 @@ System.Nullable<System.Int32> - To be added. + Gets the number of dimensions in the embeddings produced by this instance. To be added. To be added. @@ -87,9 +87,9 @@ System.String - To be added. + Gets the id of the model used by this embedding generation provider. To be added. - To be added. + This may be null if either the name is unknown or there are multiple possible models associated with this instance. @@ -108,7 +108,7 @@ System.String - To be added. + Gets the name of the embedding generation provider. To be added. To be added. @@ -129,7 +129,7 @@ System.Uri - To be added. + Gets the URL for accessing the embedding generation provider. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/Embedding`1.xml b/xml/Microsoft.Extensions.AI/Embedding`1.xml index f4dc05f4478..e35011ae636 100644 --- a/xml/Microsoft.Extensions.AI/Embedding`1.xml +++ b/xml/Microsoft.Extensions.AI/Embedding`1.xml @@ -24,9 +24,9 @@ - To be added. - To be added. - To be added. + The type of the values in the embedding vector. + Represents an embedding composed of a vector of values. + Typical values of are , , or Half. @@ -52,8 +52,8 @@ - To be added. - To be added. + The embedding vector this embedding represents. + Initializes a new instance of the class with the embedding vector. To be added. @@ -79,7 +79,7 @@ System.ReadOnlyMemory<T> - To be added. + Gets or sets the embedding vector this embedding represents. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/FunctionCallContent.xml b/xml/Microsoft.Extensions.AI/FunctionCallContent.xml index fc21b467b52..31c77f50a9d 100644 --- a/xml/Microsoft.Extensions.AI/FunctionCallContent.xml +++ b/xml/Microsoft.Extensions.AI/FunctionCallContent.xml @@ -24,7 +24,9 @@ - To be added. + + Represents a function call request. + To be added. @@ -58,10 +60,12 @@ - To be added. - To be added. - To be added. - To be added. + The function call ID. + The function name. + The function original arguments. + + Initializes a new instance of the class. + To be added. @@ -87,7 +91,9 @@ System.Collections.Generic.IDictionary<System.String,System.Object> - To be added. + + Gets or sets the arguments requested to be provided to the function. + To be added. To be added. @@ -108,7 +114,9 @@ System.String - To be added. + + Gets or sets the function call ID. + To be added. To be added. @@ -152,13 +160,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The encoding format from which to parse function call arguments. + The input arguments encoded in . + The function call ID. + The function name. + The parsing implementation converting the encoding to a dictionary of arguments. + + Creates a new instance of parsing arguments using a specified encoding and parser. + + A new instance of containing the parse result. To be added. @@ -188,9 +198,15 @@ System.Exception - To be added. + + Gets or sets any exception that occurred while mapping the original function call data to this class. + To be added. - To be added. + + This property is for information purposes only. The is not serialized as part of serializing + instances of this class with ; as such, upon deserialization, this property will be . + Consumers should not rely on indicating success. + @@ -209,7 +225,9 @@ System.String - To be added. + + Gets or sets the name of the function requested. + To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionInvocationContext.xml b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionInvocationContext.xml index df7f5ca0aff..d3128176e55 100644 --- a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionInvocationContext.xml +++ b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionInvocationContext.xml @@ -20,7 +20,7 @@ - To be added. + Provides context for a function invocation. To be added. @@ -40,7 +40,7 @@ Microsoft.Extensions.AI.FunctionCallContent - To be added. + Gets or sets the function call content information associated with this invocation. To be added. To be added. @@ -61,7 +61,7 @@ System.Collections.Generic.IList<Microsoft.Extensions.AI.ChatMessage> - To be added. + Gets or sets the chat contents associated with the operation that initiated this function call request. To be added. To be added. @@ -82,7 +82,7 @@ Microsoft.Extensions.AI.AIFunction - To be added. + Gets or sets the AI function to be invoked. To be added. To be added. @@ -103,9 +103,12 @@ System.Int32 - To be added. + Gets or sets the index of the function call within the iteration. To be added. - To be added. + + The response from the underlying client may include multiple function call requests. + This index indicates the position of the function call within the iteration. + @@ -124,9 +127,12 @@ System.Int32 - To be added. + Gets or sets the total number of function call requests within the iteration. To be added. - To be added. + + The response from the underlying client may include multiple function call requests. + This count indicates how many there were. + @@ -145,9 +151,12 @@ System.Int32 - To be added. + Gets or sets the number of this iteration with the underlying client. To be added. - To be added. + + The initial request to the client that passes along the chat contents provided to the + is iteration 1. If the client responds with a function call request, the next request to the client is iteration 2, and so on. + @@ -166,9 +175,14 @@ System.Boolean - To be added. + Gets or sets a value indicating whether to terminate the request. To be added. - To be added. + + In response to a function call request, the function may be invoked, its result added to the chat contents, + and a new request issued to the wrapped client. If this property is set to true, that subsequent request + will not be issued and instead the loop immediately terminated rather than continuing until there are no + more function call requests in responses. + diff --git a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionInvocationResult.xml b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionInvocationResult.xml index cca9336bc36..d83b2d09ba6 100644 --- a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionInvocationResult.xml +++ b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionInvocationResult.xml @@ -20,7 +20,7 @@ - To be added. + Provides information about the invocation of a function call. To be added. @@ -46,7 +46,7 @@ Microsoft.Extensions.AI.FunctionCallContent - To be added. + Gets the function call content information associated with this invocation. To be added. To be added. @@ -67,7 +67,7 @@ System.Exception - To be added. + Gets any exception the function call threw. To be added. To be added. @@ -88,7 +88,7 @@ System.Object - To be added. + Gets the result of the function call. To be added. To be added. @@ -109,7 +109,7 @@ Microsoft.Extensions.AI.FunctionInvokingChatClient+FunctionStatus - To be added. + Gets status about how the function invocation completed. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionStatus.xml b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionStatus.xml index 723b9004809..68c50e19cda 100644 --- a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionStatus.xml +++ b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient+FunctionStatus.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Provides error codes for when errors occur as part of the function calling loop. To be added. @@ -34,7 +34,7 @@ 0 - To be added. + The operation completed successfully. @@ -54,7 +54,7 @@ 2 - To be added. + The function call failed with an exception. @@ -74,7 +74,7 @@ 1 - To be added. + The requested function could not be found. diff --git a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient.xml b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient.xml index a86b4647289..f29eff64d12 100644 --- a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient.xml +++ b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClient.xml @@ -20,8 +20,28 @@ - To be added. - To be added. + + A delegating chat client that invokes functions defined on . + Include this in a chat pipeline to resolve function calls automatically. + + + + When this client receives a in a chat completion, it responds + by calling the corresponding defined in , + producing a . + + + The provided implementation of is thread-safe for concurrent use so long as the + instances employed as part of the supplied are also safe. + The property may be used to control whether multiple function invocation + requests as part of the same request are invocable concurrently, but even with that set to + (the default), multiple concurrent requests to this same instance and using the same tools could result in those + tools being used concurrently (one per request). For example, a function that accesses the HttpContext of a specific + ASP.NET web request should only be used as part of a single at a time, and only with + set to , in case the inner client decided to issue multiple + invocation requests to that same function. + + @@ -40,8 +60,10 @@ - To be added. - To be added. + The underlying , or the next instance in a chain of clients. + + Initializes a new instance of the class. + To be added. @@ -72,10 +94,10 @@ - To be added. - To be added. - To be added. - To be added. + The chat to which to add the one or more response messages. + Information about the function call invocations and results. + Adds one or more response messages for function invocation results. + A list of all chat messages added to . To be added. @@ -112,6 +134,7 @@ To be added. To be added. To be added. + @@ -160,6 +183,7 @@ To be added. To be added. To be added. + @@ -178,9 +202,20 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether to allow concurrent invocation of functions. + To be added. - To be added. + + + An individual response from the inner client may contain multiple function call requests. + By default, such function calls are processed serially. Set to + to enable concurrent invocation such that multiple function calls may execute in parallel. + + + The default value is . + + @@ -199,9 +234,31 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether detailed exception information should be included + in the chat history when calling the underlying . + To be added. - To be added. + + + The default value is , meaning that only a generic error message will + be included in the chat history. This prevents the underlying language model from disclosing + raw exception details to the end user, since it does not receive that information. Even in this + case, the raw object is available to application code by inspecting + the property. + + + If set to , the full exception message will be added to the chat history + when calling the underlying . This can help it to bypass problems on + its own, for example by retrying the function call with different arguments. However it may + result in disclosing the raw exception information to external users, which may be a security + concern depending on the application scenario. + + + Changing the value of this property while the client is in use may result in inconsistencies + as to whether detailed errors are provided during an in-flight request. + + @@ -230,10 +287,12 @@ - To be added. - To be added. - To be added. - To be added. + + The function invocation context detailing the function to be invoked and its arguments along with additional request information. + + The to monitor for cancellation requests. The default is . + Invokes the function asynchronously. + The result of the function invocation. This may be null if the function invocation returned null. To be added. @@ -253,9 +312,27 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether to keep intermediate messages in the chat history. + To be added. - To be added. + + + When the inner returns to the + , the adds + those messages to the list of messages, along with instances + it creates with the results of invoking the requested functions. The resulting augmented + list of messages is then passed to the inner client in order to send the results back. + By default, is , and those + messages will persist in the list provided to + and by the caller. Set + to to remove those messages prior to completing the operation. + + + Changing the value of this property while the client is in use may result in inconsistencies + as to whether function calling messages are kept during an in-flight request. + + @@ -274,9 +351,27 @@ System.Nullable<System.Int32> - To be added. + + Gets or sets the maximum number of iterations per request. + To be added. - To be added. + + + Each request to this may end up making + multiple requests to the inner client. Each time the inner client responds with + a function call request, this client may perform that invocation and send the results + back to the inner client in a new request. This property limits the number of times + such a roundtrip is performed. If null, there is no limit applied. If set, the value + must be at least one, as it includes the initial request. + + + Changing the value of this property while the client is in use may result in inconsistencies + as to how many iterations are allowed for an in-flight request. + + + The default value is . + + @@ -295,9 +390,28 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether to handle exceptions that occur during function calls. + To be added. - To be added. + + + If the value is , then if a function call fails with an exception, the + underlying will be instructed to give a response without invoking + any further functions. + + + If the value is , the underlying will be allowed + to continue attempting function calls until is reached. + + + Changing the value of this property while the client is in use may result in inconsistencies + as to whether errors are retried during an in-flight request. + + + The default value is . + + diff --git a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClientBuilderExtensions.xml b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClientBuilderExtensions.xml index 88469a2ef37..4897445d884 100644 --- a/xml/Microsoft.Extensions.AI/FunctionInvokingChatClientBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.AI/FunctionInvokingChatClientBuilderExtensions.xml @@ -14,7 +14,9 @@ - To be added. + + Provides extension methods for attaching a to a chat pipeline. + To be added. @@ -44,11 +46,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The being used to build the chat pipeline. + An optional callback that can be used to configure the instance. + + Enables automatic function call invocation on the chat pipeline. + + The supplied . + This works by adding an instance of with default options. diff --git a/xml/Microsoft.Extensions.AI/FunctionResultContent.xml b/xml/Microsoft.Extensions.AI/FunctionResultContent.xml index cd42806c4fb..f5ac5f82fe8 100644 --- a/xml/Microsoft.Extensions.AI/FunctionResultContent.xml +++ b/xml/Microsoft.Extensions.AI/FunctionResultContent.xml @@ -24,7 +24,9 @@ - To be added. + + Represents the result of a function call. + To be added. @@ -59,10 +61,16 @@ - To be added. - To be added. - To be added. - To be added. + The function call ID for which this is the result. + The function name that produced the result. + + This may be if the function returned , if the function was void-returning + and thus had no result, or if the function call failed. Typically, however, in order to provide meaningfully representative + information to an AI service, a human-readable representation of those conditions should be supplied. + + + Initializes a new instance of the class. + To be added. @@ -82,9 +90,14 @@ System.String - To be added. + + Gets or sets the ID of the function call for which this is the result. + To be added. - To be added. + + If this is the result for a , this should contain the same + value. + @@ -113,9 +126,15 @@ System.Exception - To be added. + + Gets or sets an exception that occurred if the function call failed. + To be added. - To be added. + + This property is for information purposes only. The is not serialized as part of serializing + instances of this class with ; as such, upon deserialization, this property will be . + Consumers should not rely on indicating success. + @@ -134,7 +153,9 @@ System.String - To be added. + + Gets or sets the name of the function that was called. + To be added. To be added. @@ -161,9 +182,15 @@ System.Object - To be added. + + Gets or sets the result of the function call, or a generic error message if the function call failed. + To be added. - To be added. + + This may be if the function returned , if the function was void-returning + and thus had no result, or if the function call failed. Typically, however, in order to provide meaningfully representative + information to an AI service, a human-readable representation of those conditions should be supplied. + diff --git a/xml/Microsoft.Extensions.AI/GeneratedEmbeddings`1.xml b/xml/Microsoft.Extensions.AI/GeneratedEmbeddings`1.xml index afecdff0104..afb3ff4d27d 100644 --- a/xml/Microsoft.Extensions.AI/GeneratedEmbeddings`1.xml +++ b/xml/Microsoft.Extensions.AI/GeneratedEmbeddings`1.xml @@ -61,8 +61,8 @@ - To be added. - To be added. + Specifies the type of the generated embeddings. + Represents the result of an operation to generate embeddings. To be added. @@ -79,7 +79,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -99,8 +99,10 @@ - To be added. - To be added. + The collection whose embeddings are copied to the new list. + + Initializes a new instance of the class that contains all of the embeddings from the specified collection. + To be added. @@ -120,8 +122,8 @@ - To be added. - To be added. + The number of embeddings that the new list can initially store. + Initializes a new instance of the class with the specified capacity. To be added. @@ -150,6 +152,7 @@ To be added. To be added. To be added. + @@ -174,7 +177,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets any additional properties associated with the embeddings. To be added. To be added. @@ -198,8 +201,8 @@ - To be added. - To be added. + The collection whose elements should be added to this list. + Adds the embeddings from the specified collection to the end of this list. To be added. @@ -225,6 +228,7 @@ To be added. To be added. + @@ -253,6 +257,7 @@ To be added. To be added. To be added. + @@ -282,6 +287,7 @@ To be added. To be added. To be added. + @@ -307,6 +313,7 @@ To be added. To be added. To be added. + @@ -332,6 +339,7 @@ To be added. To be added. To be added. + @@ -360,6 +368,7 @@ To be added. To be added. To be added. + @@ -389,6 +398,7 @@ To be added. To be added. To be added. + @@ -417,6 +427,7 @@ To be added. To be added. To be added. + @@ -445,6 +456,7 @@ To be added. To be added. To be added. + @@ -472,6 +484,7 @@ To be added. To be added. To be added. + @@ -496,6 +509,7 @@ To be added. To be added. To be added. + @@ -521,6 +535,7 @@ To be added. To be added. To be added. + @@ -545,7 +560,7 @@ Microsoft.Extensions.AI.UsageDetails - To be added. + Gets or sets usage details for the embeddings' generation. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/IChatClient.xml b/xml/Microsoft.Extensions.AI/IChatClient.xml index 91fa5c04007..7912c97bcd4 100644 --- a/xml/Microsoft.Extensions.AI/IChatClient.xml +++ b/xml/Microsoft.Extensions.AI/IChatClient.xml @@ -15,8 +15,21 @@ - To be added. - To be added. + Represents a chat completion client. + + + Unless otherwise specified, all members of are thread-safe for concurrent use. + It is expected that all implementations of support being used by multiple requests concurrently. + + + However, implementations of may mutate the arguments supplied to and + , such as by adding additional messages to the messages list or configuring the options + instance. Thus, consumers of the interface either should avoid using shared instances of these arguments for concurrent + invocations or should otherwise ensure by construction that no instances are used which might employ + such mutation. For example, the WithChatOptions method be provided with a callback that could mutate the supplied options + argument, and that should be avoided if using a singleton options instance. + + @@ -46,12 +59,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The chat content to send. + The chat options to configure the request. + The to monitor for cancellation requests. The default is . + Sends chat messages to the model and returns the response messages. + The response messages generated by the client. + + The returned messages will not have been added to . However, any intermediate messages generated implicitly + by the client, including any messages for roundtrips to the model as part of the implementation of this request, will be included. + @@ -81,12 +97,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The chat content to send. + The chat options to configure the request. + The to monitor for cancellation requests. The default is . + Sends chat messages to the model and streams the response messages. + The response messages generated by the client. + + The returned messages will not have been added to . However, any intermediate messages generated implicitly + by the client, including any messages for roundtrips to the model as part of the implementation of this request, will be included. + @@ -120,11 +139,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the object to be retrieved. + An optional key that may be used to help identify the target service. + Asks the for an object of type . + The found object, otherwise . + + The purpose of this method is to allow for the retrieval of strongly-typed services that may be provided by the , + including itself or any services it might be wrapping. + @@ -143,7 +165,7 @@ Microsoft.Extensions.AI.ChatClientMetadata - To be added. + Gets metadata that describes the . To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/IEmbeddingGenerator`2.xml b/xml/Microsoft.Extensions.AI/IEmbeddingGenerator`2.xml index a1ed2fcdcba..0129d080cb5 100644 --- a/xml/Microsoft.Extensions.AI/IEmbeddingGenerator`2.xml +++ b/xml/Microsoft.Extensions.AI/IEmbeddingGenerator`2.xml @@ -36,10 +36,22 @@ - To be added. - To be added. - To be added. - To be added. + The type from which embeddings will be generated. + The type of embeddings to generate. + Represents a generator of embeddings. + + + Unless otherwise specified, all members of are thread-safe for concurrent use. + It is expected that all implementations of support being used by multiple requests concurrently. + + + However, implementations of may mutate the arguments supplied to + , such as by adding additional values to the values list or configuring the options + instance. Thus, consumers of the interface either should avoid using shared instances of these arguments for concurrent + invocations or should otherwise ensure by construction that no instances + are used which might employ such mutation. + + @@ -69,11 +81,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The collection of values for which to generate embeddings. + The embedding generation options to configure the request. + The to monitor for cancellation requests. The default is . + Generates embeddings for each of the supplied . + The generated embeddings. To be added. @@ -108,11 +120,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the object to be retrieved. + An optional key that may be used to help identify the target service. + Asks the for an object of type . + The found object, otherwise . + + The purpose of this method is to allow for the retrieval of strongly-typed services that may be provided by the , + including itself or any services it might be wrapping. + @@ -131,7 +146,7 @@ Microsoft.Extensions.AI.EmbeddingGeneratorMetadata - To be added. + Gets metadata that describes the . To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/ImageContent.xml b/xml/Microsoft.Extensions.AI/ImageContent.xml index ca48f13179c..4dc80dc23af 100644 --- a/xml/Microsoft.Extensions.AI/ImageContent.xml +++ b/xml/Microsoft.Extensions.AI/ImageContent.xml @@ -14,7 +14,9 @@ - To be added. + + Represents image content. + To be added. @@ -41,9 +43,11 @@ - To be added. - To be added. - To be added. + The byte contents. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. @@ -83,9 +87,11 @@ - To be added. - To be added. - To be added. + The URI of the content. This may be a data URI. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. @@ -112,9 +118,11 @@ - To be added. - To be added. - To be added. + The URI of the content. This may be a data URI. + The media type (also known as MIME type) represented by the content. + + Initializes a new instance of the class. + To be added. diff --git a/xml/Microsoft.Extensions.AI/LoggingChatClient.xml b/xml/Microsoft.Extensions.AI/LoggingChatClient.xml index 3f50a02d31e..ac8b92518c5 100644 --- a/xml/Microsoft.Extensions.AI/LoggingChatClient.xml +++ b/xml/Microsoft.Extensions.AI/LoggingChatClient.xml @@ -20,8 +20,12 @@ - To be added. + A delegating chat client that logs chat operations to an . To be added. + + The provided implementation of is thread-safe for concurrent use so long as the + employed is also thread-safe for concurrent use. + @@ -41,9 +45,9 @@ - To be added. - To be added. - To be added. + The underlying . + An instance that will be used for all logging. + Initializes a new instance of the class. To be added. @@ -80,6 +84,7 @@ To be added. To be added. To be added. + @@ -128,6 +133,7 @@ To be added. To be added. To be added. + @@ -146,7 +152,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets JSON serialization options to use when serializing logging data. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/LoggingChatClientBuilderExtensions.xml b/xml/Microsoft.Extensions.AI/LoggingChatClientBuilderExtensions.xml index 6671aa7e3ec..e38829a3236 100644 --- a/xml/Microsoft.Extensions.AI/LoggingChatClientBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.AI/LoggingChatClientBuilderExtensions.xml @@ -14,7 +14,7 @@ - To be added. + Provides extensions for configuring instances. To be added. @@ -52,11 +52,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The . + + An optional with which logging should be performed. If not supplied, an instance will be resolved from the service provider. + + An optional callback that can be used to configure the instance. + Adds logging to the chat client pipeline. + The . To be added. diff --git a/xml/Microsoft.Extensions.AI/LoggingEmbeddingGeneratorBuilderExtensions.xml b/xml/Microsoft.Extensions.AI/LoggingEmbeddingGeneratorBuilderExtensions.xml index 49f967495b7..603e4ab42ff 100644 --- a/xml/Microsoft.Extensions.AI/LoggingEmbeddingGeneratorBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.AI/LoggingEmbeddingGeneratorBuilderExtensions.xml @@ -14,7 +14,7 @@ - To be added. + Provides extensions for configuring instances. To be added. @@ -73,13 +73,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + Specifies the type of the input passed to the generator. + Specifies the type of the embedding instance produced by the generator. + The . + + An optional with which logging should be performed. If not supplied, an instance will be resolved from the service provider. + + An optional callback that can be used to configure the instance. + Adds logging to the embedding generator pipeline. + The . To be added. diff --git a/xml/Microsoft.Extensions.AI/LoggingEmbeddingGenerator`2.xml b/xml/Microsoft.Extensions.AI/LoggingEmbeddingGenerator`2.xml index 9cd43c08799..94a339243ca 100644 --- a/xml/Microsoft.Extensions.AI/LoggingEmbeddingGenerator`2.xml +++ b/xml/Microsoft.Extensions.AI/LoggingEmbeddingGenerator`2.xml @@ -45,10 +45,14 @@ - To be added. - To be added. - To be added. + Specifies the type of the input passed to the generator. + Specifies the type of the embedding instance produced by the generator. + A delegating embedding generator that logs embedding generation operations to an . To be added. + + The provided implementation of is thread-safe for concurrent use + so long as the employed is also thread-safe for concurrent use. + @@ -68,9 +72,9 @@ - To be added. - To be added. - To be added. + The underlying . + An instance that will be used for all logging. + Initializes a new instance of the class. To be added. @@ -107,6 +111,7 @@ To be added. To be added. To be added. + @@ -125,7 +130,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets JSON serialization options to use when serializing logging data. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/OllamaChatClient.xml b/xml/Microsoft.Extensions.AI/OllamaChatClient.xml index d0de3531085..eafabf15ae6 100644 --- a/xml/Microsoft.Extensions.AI/OllamaChatClient.xml +++ b/xml/Microsoft.Extensions.AI/OllamaChatClient.xml @@ -27,7 +27,7 @@ - To be added. + An for Ollama. To be added. @@ -55,10 +55,13 @@ - To be added. - To be added. - To be added. - To be added. + The endpoint URI where Ollama is hosted. + + The id of the model to use. This may also be overridden per request via . + Either this parameter or must provide a valid model id. + + An instance to use for HTTP operations. + Initializes a new instance of the class. To be added. @@ -86,10 +89,13 @@ - To be added. - To be added. - To be added. - To be added. + The endpoint URI where Ollama is hosted. + + The id of the model to use. This may also be overridden per request via . + Either this parameter or must provide a valid model id. + + An instance to use for HTTP operations. + Initializes a new instance of the class. To be added. @@ -129,6 +135,7 @@ To be added. To be added. To be added. + @@ -180,6 +187,7 @@ To be added. To be added. To be added. + @@ -204,6 +212,7 @@ To be added. To be added. + @@ -245,6 +254,7 @@ To be added. To be added. To be added. + @@ -269,6 +279,7 @@ To be added. To be added. To be added. + @@ -293,7 +304,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets to use for any serialization activities related to tool call arguments and results. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/OllamaEmbeddingGenerator.xml b/xml/Microsoft.Extensions.AI/OllamaEmbeddingGenerator.xml index b94448733ce..363897597a7 100644 --- a/xml/Microsoft.Extensions.AI/OllamaEmbeddingGenerator.xml +++ b/xml/Microsoft.Extensions.AI/OllamaEmbeddingGenerator.xml @@ -27,7 +27,7 @@ - To be added. + An for Ollama. To be added. @@ -55,10 +55,13 @@ - To be added. - To be added. - To be added. - To be added. + The endpoint URI where Ollama is hosted. + + The id of the model to use. This may also be overridden per request via . + Either this parameter or must provide a valid model id. + + An instance to use for HTTP operations. + Initializes a new instance of the class. To be added. @@ -86,10 +89,13 @@ - To be added. - To be added. - To be added. - To be added. + The endpoint URI where Ollama is hosted. + + The id of the model to use. This may also be overridden per request via . + Either this parameter or must provide a valid model id. + + An instance to use for HTTP operations. + Initializes a new instance of the class. To be added. @@ -115,6 +121,7 @@ To be added. To be added. + @@ -153,6 +160,7 @@ To be added. To be added. To be added. + @@ -194,6 +202,7 @@ To be added. To be added. To be added. + @@ -218,6 +227,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/OpenAIChatClient.xml b/xml/Microsoft.Extensions.AI/OpenAIChatClient.xml index 193ea1ad078..c17348b06e6 100644 --- a/xml/Microsoft.Extensions.AI/OpenAIChatClient.xml +++ b/xml/Microsoft.Extensions.AI/OpenAIChatClient.xml @@ -27,7 +27,7 @@ - To be added. + An for an OpenAI or . To be added. @@ -47,8 +47,8 @@ - To be added. - To be added. + The underlying client. + Initializes a new instance of the class for the specified . To be added. @@ -69,9 +69,9 @@ - To be added. - To be added. - To be added. + The underlying client. + The model to use. + Initializes a new instance of the class for the specified . To be added. @@ -111,6 +111,7 @@ To be added. To be added. To be added. + @@ -162,6 +163,7 @@ To be added. To be added. To be added. + @@ -203,6 +205,7 @@ To be added. To be added. To be added. + @@ -227,6 +230,7 @@ To be added. To be added. To be added. + @@ -251,6 +255,7 @@ To be added. To be added. + @@ -275,7 +280,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets to use for any serialization activities related to tool call arguments and results. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/OpenAIClientExtensions.xml b/xml/Microsoft.Extensions.AI/OpenAIClientExtensions.xml index 3d796b0e5bd..b3069acfc11 100644 --- a/xml/Microsoft.Extensions.AI/OpenAIClientExtensions.xml +++ b/xml/Microsoft.Extensions.AI/OpenAIClientExtensions.xml @@ -20,7 +20,7 @@ - To be added. + Provides extension methods for working with s. To be added. @@ -43,9 +43,9 @@ - To be added. - To be added. - To be added. + The client. + Gets an for use with this . + An that may be used to converse via the . To be added. @@ -69,10 +69,10 @@ - To be added. - To be added. - To be added. - To be added. + The client. + The model. + Gets an for use with this . + An that may be used to converse via the . To be added. @@ -95,10 +95,10 @@ - To be added. - To be added. - To be added. - To be added. + The client. + The number of dimensions to generate in each embedding. + Gets an for use with this . + An that may be used to generate embeddings via the . To be added. @@ -122,11 +122,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The client. + The model to use. + The number of dimensions to generate in each embedding. + Gets an for use with this . + An that may be used to generate embeddings via the . To be added. diff --git a/xml/Microsoft.Extensions.AI/OpenAIEmbeddingGenerator.xml b/xml/Microsoft.Extensions.AI/OpenAIEmbeddingGenerator.xml index 39c8ca4637c..98bab8f2409 100644 --- a/xml/Microsoft.Extensions.AI/OpenAIEmbeddingGenerator.xml +++ b/xml/Microsoft.Extensions.AI/OpenAIEmbeddingGenerator.xml @@ -27,7 +27,7 @@ - To be added. + An for an OpenAI . To be added. @@ -47,9 +47,9 @@ - To be added. - To be added. - To be added. + The underlying client. + The number of dimensions to generate in each embedding. + Initializes a new instance of the class. To be added. @@ -70,10 +70,10 @@ - To be added. - To be added. - To be added. - To be added. + The underlying client. + The model to use. + The number of dimensions to generate in each embedding. + Initializes a new instance of the class. To be added. @@ -113,6 +113,7 @@ To be added. To be added. To be added. + @@ -154,6 +155,7 @@ To be added. To be added. To be added. + @@ -178,6 +180,7 @@ To be added. To be added. To be added. + @@ -202,6 +205,7 @@ To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/OpenTelemetryChatClient.xml b/xml/Microsoft.Extensions.AI/OpenTelemetryChatClient.xml index 7fc0aacb1d7..7621e01a87b 100644 --- a/xml/Microsoft.Extensions.AI/OpenTelemetryChatClient.xml +++ b/xml/Microsoft.Extensions.AI/OpenTelemetryChatClient.xml @@ -20,8 +20,11 @@ - To be added. - To be added. + A delegating chat client that implements the OpenTelemetry Semantic Conventions for Generative AI systems. + + The draft specification this follows is available at https://opentelemetry.io/docs/specs/semconv/gen-ai/. + The specification is still experimental and subject to change; as such, the telemetry output by this client is also subject to change. + @@ -48,10 +51,10 @@ - To be added. - To be added. - To be added. - To be added. + The underlying . + The to use for emitting events. + An optional source name that will be used on the telemetry data. + Initializes a new instance of the class. To be added. @@ -88,6 +91,7 @@ To be added. To be added. To be added. + @@ -136,6 +140,7 @@ To be added. To be added. To be added. + @@ -160,6 +165,7 @@ To be added. To be added. To be added. + @@ -178,9 +184,14 @@ System.Boolean - To be added. + + Gets or sets a value indicating whether potentially sensitive information should be included in telemetry. + To be added. - To be added. + + The value is by default, meaning that telemetry will include metadata such as token counts but not raw inputs + and outputs such as message content, function call arguments, and function call results. + @@ -199,7 +210,7 @@ System.Text.Json.JsonSerializerOptions - To be added. + Gets or sets JSON serialization options to use when formatting chat data into telemetry strings. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/OpenTelemetryChatClientBuilderExtensions.xml b/xml/Microsoft.Extensions.AI/OpenTelemetryChatClientBuilderExtensions.xml index be1b0639b7f..9540d57670c 100644 --- a/xml/Microsoft.Extensions.AI/OpenTelemetryChatClientBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.AI/OpenTelemetryChatClientBuilderExtensions.xml @@ -14,7 +14,7 @@ - To be added. + Provides extensions for configuring instances. To be added. @@ -60,13 +60,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The . + An optional to use to create a logger for logging events. + An optional source name that will be used on the telemetry data. + An optional callback that can be used to configure the instance. + + Adds OpenTelemetry support to the chat client pipeline, following the OpenTelemetry Semantic Conventions for Generative AI systems. + + The . + + The draft specification this follows is available at https://opentelemetry.io/docs/specs/semconv/gen-ai/. + The specification is still experimental and subject to change; as such, the telemetry output by this client is also subject to change. + diff --git a/xml/Microsoft.Extensions.AI/OpenTelemetryEmbeddingGeneratorBuilderExtensions.xml b/xml/Microsoft.Extensions.AI/OpenTelemetryEmbeddingGeneratorBuilderExtensions.xml index 2254cd487df..253b17ec897 100644 --- a/xml/Microsoft.Extensions.AI/OpenTelemetryEmbeddingGeneratorBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.AI/OpenTelemetryEmbeddingGeneratorBuilderExtensions.xml @@ -14,7 +14,7 @@ - To be added. + Provides extensions for configuring instances. To be added. @@ -81,15 +81,20 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The type of input used to produce embeddings. + The type of embedding generated. + The . + An optional to use to create a logger for logging events. + An optional source name that will be used on the telemetry data. + An optional callback that can be used to configure the instance. + + Adds OpenTelemetry support to the embedding generator pipeline, following the OpenTelemetry Semantic Conventions for Generative AI systems. + + The . + + The draft specification this follows is available at https://opentelemetry.io/docs/specs/semconv/gen-ai/. + The specification is still experimental and subject to change; as such, the telemetry output by this generator is also subject to change. + diff --git a/xml/Microsoft.Extensions.AI/OpenTelemetryEmbeddingGenerator`2.xml b/xml/Microsoft.Extensions.AI/OpenTelemetryEmbeddingGenerator`2.xml index 968e47c4726..e689f382b36 100644 --- a/xml/Microsoft.Extensions.AI/OpenTelemetryEmbeddingGenerator`2.xml +++ b/xml/Microsoft.Extensions.AI/OpenTelemetryEmbeddingGenerator`2.xml @@ -38,10 +38,13 @@ - To be added. - To be added. - To be added. - To be added. + The type of input used to produce embeddings. + The type of embedding generated. + A delegating embedding generator that implements the OpenTelemetry Semantic Conventions for Generative AI systems. + + The draft specification this follows is available at https://opentelemetry.io/docs/specs/semconv/gen-ai/. + The specification is still experimental and subject to change; as such, the telemetry output by this generator is also subject to change. + @@ -68,10 +71,12 @@ - To be added. - To be added. - To be added. - To be added. + The underlying , which is the next stage of the pipeline. + The to use for emitting events. + An optional source name that will be used on the telemetry data. + + Initializes a new instance of the class. + To be added. @@ -97,6 +102,7 @@ To be added. To be added. To be added. + @@ -132,6 +138,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/RequiredChatToolMode.xml b/xml/Microsoft.Extensions.AI/RequiredChatToolMode.xml index 580f11be4ed..1fe6cc47140 100644 --- a/xml/Microsoft.Extensions.AI/RequiredChatToolMode.xml +++ b/xml/Microsoft.Extensions.AI/RequiredChatToolMode.xml @@ -24,7 +24,10 @@ - To be added. + + Indicates that a chat tool must be called. It may optionally nominate a specific function, + or if not, indicates that any of them may be selected. + To be added. @@ -44,9 +47,14 @@ - To be added. - To be added. - To be added. + The name of the function that must be called. + + Initializes a new instance of the class that requires a specific function to be called. + + + may be . However, it is preferable to use + when any function may be selected. + @@ -72,6 +80,7 @@ To be added. To be added. To be added. + @@ -94,6 +103,7 @@ To be added. To be added. To be added. + @@ -112,9 +122,13 @@ System.String - To be added. + + Gets the name of a specific that must be called. + To be added. - To be added. + + If the value is , any available function may be selected (but at least one must be). + diff --git a/xml/Microsoft.Extensions.AI/StreamingChatCompletionUpdate.xml b/xml/Microsoft.Extensions.AI/StreamingChatCompletionUpdate.xml index 929129c1a7a..417df8ec28a 100644 --- a/xml/Microsoft.Extensions.AI/StreamingChatCompletionUpdate.xml +++ b/xml/Microsoft.Extensions.AI/StreamingChatCompletionUpdate.xml @@ -20,7 +20,9 @@ - To be added. + + Represents a single response chunk from an . + To be added. @@ -57,7 +59,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets additional properties for the update. To be added. To be added. @@ -78,7 +80,7 @@ System.String - To be added. + Gets or sets the name of the author of the completion update. To be added. To be added. @@ -99,7 +101,7 @@ System.Int32 - To be added. + Gets or sets the zero-based index of the choice with which this update is associated in the streaming sequence. To be added. To be added. @@ -120,7 +122,7 @@ System.String - To be added. + Gets or sets the ID of the completion of which this update is a part. To be added. To be added. @@ -147,7 +149,7 @@ System.Collections.Generic.IList<Microsoft.Extensions.AI.AIContent> - To be added. + Gets or sets the chat completion update content items. To be added. To be added. @@ -168,7 +170,7 @@ System.Nullable<System.DateTimeOffset> - To be added. + Gets or sets a timestamp for the completion update. To be added. To be added. @@ -189,7 +191,7 @@ System.Nullable<Microsoft.Extensions.AI.ChatFinishReason> - To be added. + Gets or sets the finish reason for the operation. To be added. To be added. @@ -210,7 +212,7 @@ System.String - To be added. + Gets or sets the model ID using in the creation of the chat completion of which this update is a part. To be added. To be added. @@ -237,9 +239,13 @@ System.Object - To be added. + Gets or sets the raw representation of the completion update from an underlying implementation. To be added. - To be added. + + If a is created to represent some underlying object from another object + model, this property can be used to store that original object. This can be useful for debugging or + for enabling a consumer to access the underlying object model if needed. + @@ -258,7 +264,7 @@ System.Nullable<Microsoft.Extensions.AI.ChatRole> - To be added. + Gets or sets the role of the author of the completion update. To be added. To be added. @@ -285,9 +291,14 @@ System.String - To be added. + + Gets or sets the text of the first instance in . + To be added. - To be added. + + If there is no instance in , then the getter returns , + and the setter will add new instance with the provided value. + @@ -310,6 +321,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/TextContent.xml b/xml/Microsoft.Extensions.AI/TextContent.xml index 8de5565659f..74de826975e 100644 --- a/xml/Microsoft.Extensions.AI/TextContent.xml +++ b/xml/Microsoft.Extensions.AI/TextContent.xml @@ -20,7 +20,9 @@ - To be added. + + Represents text content in a chat. + To be added. @@ -40,8 +42,10 @@ - To be added. - To be added. + The text content. + + Initializes a new instance of the class. + To be added. @@ -61,7 +65,9 @@ System.String - To be added. + + Gets or sets the text content. + To be added. To be added. @@ -86,6 +92,7 @@ To be added. To be added. To be added. + diff --git a/xml/Microsoft.Extensions.AI/UsageContent.xml b/xml/Microsoft.Extensions.AI/UsageContent.xml index 34bcecabae7..314f07c9dbe 100644 --- a/xml/Microsoft.Extensions.AI/UsageContent.xml +++ b/xml/Microsoft.Extensions.AI/UsageContent.xml @@ -24,7 +24,9 @@ - To be added. + + Represents usage information associated with a chat response. + To be added. @@ -41,7 +43,7 @@ - To be added. + Initializes a new instance of the class with an empty . To be added. @@ -67,8 +69,8 @@ - To be added. - To be added. + The usage details to store in this content. + Initializes a new instance of the class with the specified instance. To be added. @@ -88,7 +90,7 @@ Microsoft.Extensions.AI.UsageDetails - To be added. + Gets or sets the usage information. To be added. To be added. diff --git a/xml/Microsoft.Extensions.AI/UsageDetails.xml b/xml/Microsoft.Extensions.AI/UsageDetails.xml index 78cdd42c7b4..85188a54b65 100644 --- a/xml/Microsoft.Extensions.AI/UsageDetails.xml +++ b/xml/Microsoft.Extensions.AI/UsageDetails.xml @@ -24,7 +24,7 @@ - To be added. + Provides usage details about a request/response. To be added. @@ -61,7 +61,7 @@ Microsoft.Extensions.AI.AdditionalPropertiesDictionary - To be added. + Gets or sets additional properties for the usage details. To be added. To be added. @@ -82,7 +82,7 @@ System.Nullable<System.Int32> - To be added. + Gets or sets the number of tokens in the input. To be added. To be added. @@ -103,7 +103,7 @@ System.Nullable<System.Int32> - To be added. + Gets or sets the number of tokens in the output. To be added. To be added. @@ -124,7 +124,7 @@ System.Nullable<System.Int32> - To be added. + Gets or sets the total number of tokens used to produce the response. To be added. To be added. diff --git a/xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml b/xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml index 63217235a39..30db322202d 100644 --- a/xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml +++ b/xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml @@ -180,8 +180,8 @@ The type of additional state required by . The type of the data being considered. The key of the entry to look for or create. - The state required for . Provides the underlying data service if the data is not available in the cache. + The state required for . Additional options for this cache entry. The tags to associate with this cache item. The used to propagate notifications that the operation should be canceled. diff --git a/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml b/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml index ca3cbbb51ce..3b70498194b 100644 --- a/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml @@ -664,8 +664,8 @@ The type of the service to add. The . - The service key. The factory that creates the service. + The service key. Adds the specified as a service using the factory specified in diff --git a/xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml b/xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml index 8f160b98144..c383644cfb7 100644 --- a/xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml +++ b/xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml @@ -48,8 +48,8 @@ - The . The implementation type of the listener. + The . Registers a new instance. diff --git a/xml/System.Reflection/TypeExtensions.xml b/xml/System.Reflection/TypeExtensions.xml index f434a7a073f..fc1c1a1e1a1 100644 --- a/xml/System.Reflection/TypeExtensions.xml +++ b/xml/System.Reflection/TypeExtensions.xml @@ -76,36 +76,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.ConstructorInfo[] + System.Reflection.ConstructorInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] - - - + To be added. @@ -115,37 +101,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.ConstructorInfo[] + System.Reflection.ConstructorInfo[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)>] - - - - + + To be added. @@ -156,22 +128,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,23 +167,38 @@ - - - - - - + + + + + + + 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.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. @@ -487,22 +488,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.Type[] + System.Type[] - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces)>] + + + To be added. @@ -582,22 +597,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. @@ -634,23 +663,38 @@ - - - - - - + + + + + + + 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.PublicMethods)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] + + + + To be added. @@ -661,24 +705,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. @@ -734,36 +793,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. @@ -773,23 +818,37 @@ - - - - - - + + + + + + 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. @@ -950,38 +1009,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.PropertyInfo + System.Reflection.PropertyInfo - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] - - - - + + To be added. @@ -992,24 +1036,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.PropertyInfo + System.Reflection.PropertyInfo - - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + + + To be added. @@ -1072,47 +1131,25 @@ - - - - - - - + + + + + + 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.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.