Add MemberGroup descriptions (Microsoft.Extensions.AI)#12830
Draft
gewarren wants to merge 1 commit into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing ECMAXML <MemberGroup> summaries for constructor and overload groups across the Microsoft.Extensions.AI surface area (including Evaluation/Reporting/Safety/Quality/NLP), improving how overload sets are presented in generated reference docs.
Changes:
- Added
<MemberGroup>summaries for many.ctoroverload sets across Microsoft.Extensions.AI types. - Added
<MemberGroup>summaries for common overload groups (for exampleUse,UploadAsync,EditImageAsync, and variousAsI*helpers). - Added
<MemberGroup>summaries for Microsoft.Extensions.AI.*.Evaluation extension methods and model/context types.
Reviewed changes
Copilot reviewed 74 out of 74 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/Microsoft.Extensions.AI/UsageContent.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/UriContent.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/TextToSpeechResponseUpdate.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/TextToSpeechResponse.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/TextToSpeechOptions.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/TextToSpeechClientBuilder.xml | Add .ctor and Use MemberGroup summaries. |
| xml/Microsoft.Extensions.AI/SpeechToTextResponseUpdate.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/SpeechToTextResponse.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/SpeechToTextOptions.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/SpeechToTextClientBuilder.xml | Add .ctor and Use MemberGroup summaries. |
| xml/Microsoft.Extensions.AI/ResponseContinuationToken.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/RealtimeClientBuilder.xml | Add .ctor and Use MemberGroup summaries. |
| xml/Microsoft.Extensions.AI/OpenAIRealtimeClient.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/OpenAIClientExtensions.xml | Add MemberGroup summaries for AsIChatClient and AsIHostedFileClient overload groups. |
| xml/Microsoft.Extensions.AI/ImageGeneratorExtensions.xml | Add MemberGroup summary for EditImageAsync overload group. |
| xml/Microsoft.Extensions.AI/ImageGeneratorBuilder.xml | Add .ctor and Use MemberGroup summaries. |
| xml/Microsoft.Extensions.AI/ImageGenerationResponse.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/ImageGenerationRequest.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/ImageGenerationOptions.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/HostedWebSearchTool.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/HostedToolSearchTool.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/HostedMcpServerTool.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/HostedImageGenerationTool.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/HostedFileSearchTool.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/HostedFileClientOptions.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/HostedFileClientExtensions.xml | Add MemberGroup summary for UploadAsync overload group. |
| xml/Microsoft.Extensions.AI/HostedFileClientBuilder.xml | Add .ctor and Use MemberGroup summaries. |
| xml/Microsoft.Extensions.AI/HostedCodeInterpreterTool.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/GeneratedEmbeddings`1.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/EmbeddingGeneratorBuilder`2.xml | Add .ctor and Use MemberGroup summaries. |
| xml/Microsoft.Extensions.AI/EmbeddingGenerationOptions.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/DelegatingTextToSpeechClient.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.AI/DelegatingSpeechToTextClient.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.AI/DelegatingRealtimeClient.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.AI/DelegatingImageGenerator.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.AI/DelegatingHostedFileClient.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.AI/DelegatingEmbeddingGenerator`2.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.AI/DelegatingChatClient.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.AI/DataContent.xml | Add .ctor and LoadFromAsync MemberGroup summaries. |
| xml/Microsoft.Extensions.AI/ChatResponseUpdate.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/ChatResponseFormat.xml | Add MemberGroup summary for ForJsonSchema overload group. |
| xml/Microsoft.Extensions.AI/ChatResponseExtensions.xml | Add MemberGroup summary for AddMessages overload group. |
| xml/Microsoft.Extensions.AI/ChatResponse.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/ChatOptions.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/ChatMessage.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/ChatClientStructuredOutputExtensions.xml | Add MemberGroup summary for GetResponseAsync<T> overload group. |
| xml/Microsoft.Extensions.AI/ChatClientExtensions.xml | Add MemberGroup summaries for GetResponseAsync and GetStreamingResponseAsync overload groups. |
| xml/Microsoft.Extensions.AI/ChatClientBuilder.xml | Add .ctor and Use MemberGroup summaries. |
| xml/Microsoft.Extensions.AI/AzureAIInferenceExtensions.xml | Add MemberGroup summary for AsIEmbeddingGenerator overload group. |
| xml/Microsoft.Extensions.AI/AIJsonSchemaTransformCache.xml | Add MemberGroup summary for GetOrCreateTransformedSchema. |
| xml/Microsoft.Extensions.AI/AIFunctionFactory.xml | Add MemberGroup summary for Create overload group. |
| xml/Microsoft.Extensions.AI/AIFunctionArguments.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/AdditionalPropertiesDictionary`1.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI/AdditionalPropertiesDictionary.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation/EvaluatorExtensions.xml | Add MemberGroup summary for EvaluateAsync overload group. |
| xml/Microsoft.Extensions.AI.Evaluation/EvaluationResultExtensions.xml | Add MemberGroup summaries for AddDiagnosticsToAllMetrics, AddOrUpdateContextInAllMetrics, and AddOrUpdateMetadataInAllMetrics. |
| xml/Microsoft.Extensions.AI.Evaluation/EvaluationResult.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation/EvaluationMetricExtensions.xml | Add MemberGroup summaries for AddDiagnostics, AddOrUpdateContext, and AddOrUpdateMetadata. |
| xml/Microsoft.Extensions.AI.Evaluation/EvaluationContext.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation/CompositeEvaluator.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation/ChatMessageExtensions.xml | Add MemberGroup summaries for RenderText and TryGetUserRequest overload groups. |
| xml/Microsoft.Extensions.AI.Evaluation.Safety/ContentSafetyServiceConfigurationExtensions.xml | Add MemberGroup summary for ToChatConfiguration. |
| xml/Microsoft.Extensions.AI.Evaluation.Safety/ContentSafetyServiceConfiguration.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.Reporting/ScenarioRunResult.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.Reporting/ScenarioRunExtensions.xml | Add MemberGroup summary for EvaluateAsync. |
| xml/Microsoft.Extensions.AI.Evaluation.Reporting/ChatTurnDetails.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.Reporting/ChatDetailsExtensions.xml | Add MemberGroup summary for AddTurnDetails. |
| xml/Microsoft.Extensions.AI.Evaluation.Reporting/ChatDetails.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.Quality/ToolCallAccuracyEvaluatorContext.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.Quality/TaskAdherenceEvaluatorContext.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.Quality/RetrievalEvaluatorContext.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.Quality/IntentResolutionEvaluatorContext.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.NLP/GLEUEvaluatorContext.xml | Add .ctor MemberGroup summary. |
| xml/Microsoft.Extensions.AI.Evaluation.NLP/BLEUEvaluatorContext.xml | Add .ctor MemberGroup summary. |
| <Members> | ||
| <MemberGroup MemberName="EditImageAsync"> | ||
| <Docs> | ||
| <summary>Edits a single image based on a byte array and the specified prompt.</summary> |
| </Member> | ||
| <MemberGroup MemberName="UploadAsync"> | ||
| <Docs> | ||
| <summary>Uploads a file from a local file path.</summary> |
| </Member> | ||
| <MemberGroup MemberName="LoadFromAsync"> | ||
| <Docs> | ||
| <summary>Loads a <see cref="T:Microsoft.Extensions.AI.DataContent" /> from a stream asynchronously.</summary> |
| </Member> | ||
| <MemberGroup MemberName="AsIHostedFileClient"> | ||
| <Docs> | ||
| <summary>Gets an <see cref="T:Microsoft.Extensions.AI.IHostedFileClient" /> for use with this <see cref="T:OpenAI.OpenAIClient" />.</summary> |
Comment on lines
+43
to
+45
| <summary>Renders the supplied <paramref name="message" /> to a <see langword="string" />. The returned | ||
| <see langword="string" /> can used as part of constructing an evaluation prompt to evaluate a conversation | ||
| that includes the supplied <paramref name="message" />.</summary> |
Comment on lines
+133
to
+135
| <summary>Given a collection of <paramref name="messages" /> representing an LLM chat conversation, returns a | ||
| single <see cref="T:Microsoft.Extensions.AI.ChatMessage" /> representing the last <paramref name="userRequest" /> in this conversation.</summary> | ||
| </Docs> |
| </Member> | ||
| <MemberGroup MemberName="Dispose"> | ||
| <Docs> | ||
| <summary>Disposes the instance.</summary> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contributes to #12626.