diff --git a/.github/_typos.toml b/.github/_typos.toml index 0f48033521ce..a6b5a2055f07 100644 --- a/.github/_typos.toml +++ b/.github/_typos.toml @@ -32,6 +32,7 @@ extend-exclude = [ [default.extend-words] ACI = "ACI" # Azure Container Instance +CPY = "CPY" # Ruff copyright lint rule prefix exercize = "exercize" # test typos gramatical = "gramatical" # test typos Guid = "Guid" # Globally Unique Identifier diff --git a/docs/decisions/0031-feature-branch-strategy.md b/docs/decisions/0031-feature-branch-strategy.md index e2085bbef244..d07f991133ba 100644 --- a/docs/decisions/0031-feature-branch-strategy.md +++ b/docs/decisions/0031-feature-branch-strategy.md @@ -144,7 +144,7 @@ Currently the priorities are ordered but not necessarily needs to be implemented Chosen option: "Feature Branch Strategy", because it allows individual features to be developed in isolation, minimizing conflicts with the main branch and facilitating easier code reviews. -## Fequent Asked Questions +## Frequent Asked Questions ### Is there a migration strategy for initiatives that followed the old contribution way with forks, and now have to switch to branches in microsoft/semantic-kernel? diff --git a/docs/decisions/0035-skfunction-type-descriptions.md b/docs/decisions/0035-skfunction-type-descriptions.md index 4e9150ff2e61..6af743bb4c51 100644 --- a/docs/decisions/0035-skfunction-type-descriptions.md +++ b/docs/decisions/0035-skfunction-type-descriptions.md @@ -151,7 +151,7 @@ public sealed record FunctionView( | Type | Pros | Cons | | ------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------- | | JsonSchema.Net.JsonSchema | Popular and has frequent updates, built on top of System.Net | Takes a dependency on OSS in SK core | -| NJsonShema.JsonSchema | Very popular, frequent updates, long term project | Built on top of Json.Net (Newtonsoft) | +| NJsonSchema.JsonSchema | Very popular, frequent updates, long term project | Built on top of Json.Net (Newtonsoft) | | JsonDocument | Native C# type, fast and flexible | Not a Json Schema, but a Json DOM container for the schema | | String | Native C# type | Not a Json Schema or Json DOM, very poor type hinting | diff --git a/docs/decisions/0042-samples-restructure.md b/docs/decisions/0042-samples-restructure.md index 5e0813410a29..fdd5e942b2a9 100644 --- a/docs/decisions/0042-samples-restructure.md +++ b/docs/decisions/0042-samples-restructure.md @@ -1,5 +1,5 @@ --- -# Reestructure of How Sample Code will be Structured In the Repository +# Restructure of How Sample Code will be Structured In the Repository status: accepted contact: rogerbarreto @@ -228,7 +228,7 @@ Identified Component Oriented Concepts: - Planners - - Handlerbars + - Handlebars - Authentication @@ -358,7 +358,7 @@ Concepts/ │ ├── Resiliency/ │ └── Usage/ ├── Planners/ -│ └── Handlerbars/ +│ └── Handlebars/ ├── Authentication/ │ └── Azure AD/ ├── Function Calling/ @@ -420,7 +420,7 @@ Concepts/ │ ├── Resiliency/ │ └── Usage/ ├── Planners/ -│ └── Handlerbars/ +│ └── Handlebars/ ├── Authentication/ │ └── Azure AD/ ├── Function Calling/ @@ -502,7 +502,7 @@ Concepts/ ├── DependencyInjection ├── HttpClient.Resiliency ├── HttpClient.Usage -├── Planners.Handlerbars +├── Planners.Handlebars ├── Authentication.AzureAD ├── FunctionCalling.AutoFunctionCalling ├── FunctionCalling.ManualFunctionCalling @@ -545,7 +545,7 @@ Concepts/ ├── Logging ├── DependencyInjection ├── HttpClient -├── Planners.Handlerbars +├── Planners.Handlebars ├── Authentication.AzureAD ├── FunctionCalling ├── Filtering @@ -634,7 +634,7 @@ Concepts/ Pros: -- Beginers will be oriented to the right difficulty level and examples will be more organized by complexity +- Beginners will be oriented to the right difficulty level and examples will be more organized by complexity Cons: diff --git a/docs/decisions/0072-agents-with-memory.md b/docs/decisions/0072-agents-with-memory.md index 56c4de6c256f..79b770a3ed9b 100644 --- a/docs/decisions/0072-agents-with-memory.md +++ b/docs/decisions/0072-agents-with-memory.md @@ -170,7 +170,7 @@ await ragStore.UpsertDocumentsAsync( var agentThread = new ChatHistoryAgentThread(); agentThread.ThreadExtensionsManager.RegisterThreadExtension(ragComponent); -// Inovke the agent. +// Invoke the agent. var asyncResults1 = agent.InvokeAsync("What was the income of Contoso for 2023", agentThread); // Expected response contains the 174M income from the document. ``` diff --git a/dotnet/samples/Concepts/Agents/README.md b/dotnet/samples/Concepts/Agents/README.md index 6cc68a036131..60583e647bcd 100644 --- a/dotnet/samples/Concepts/Agents/README.md +++ b/dotnet/samples/Concepts/Agents/README.md @@ -19,7 +19,7 @@ Prefix|Description ---|--- OpenAIAssistant|How to use agents based on the [Open AI Assistant API](https://platform.openai.com/docs/assistants). MixedChat|How to combine different agent types. -ComplexChat|How to deveop complex agent chat solutions. +ComplexChat|How to develop complex agent chat solutions. Legacy|How to use the legacy _Experimental Agent API_. ## Legacy Agents diff --git a/dotnet/samples/Concepts/Functions/MethodFunctions_Types.cs b/dotnet/samples/Concepts/Functions/MethodFunctions_Types.cs index 9170d1cc53fb..3f2d76d9cc25 100644 --- a/dotnet/samples/Concepts/Functions/MethodFunctions_Types.cs +++ b/dotnet/samples/Concepts/Functions/MethodFunctions_Types.cs @@ -253,7 +253,7 @@ public async Task TaskInjectingCultureInfoOrIFormatProviderWithStringRes [KernelFunction] public async Task TaskInjectingCancellationTokenWithStringResult(CancellationToken cancellationToken) { - var result = $"Cancellation resquested: {cancellationToken.IsCancellationRequested}"; + var result = $"Cancellation requested: {cancellationToken.IsCancellationRequested}"; this._output.WriteLine($"Running {nameof(this.TaskInjectingCultureInfoOrIFormatProviderWithStringResult)} -> Injected Cancellation Token -> result: {result}"); return result; } diff --git a/dotnet/samples/Concepts/Memory/TextChunkingAndEmbedding.cs b/dotnet/samples/Concepts/Memory/TextChunkingAndEmbedding.cs index 14bb887effb6..7def0f2a7a78 100644 --- a/dotnet/samples/Concepts/Memory/TextChunkingAndEmbedding.cs +++ b/dotnet/samples/Concepts/Memory/TextChunkingAndEmbedding.cs @@ -127,7 +127,7 @@ private async Task RunExampleAsync() Jane: Darn, it's just repeating stuff now. John: I think we're done. Jane: We're not though! We need like 1500 more characters. -John: Oh Cananda, our home and native land. +John: Oh Canada, our home and native land. Jane: True patriot love in all thy sons command. John: With glowing hearts we see thee rise. Jane: The True North strong and free. diff --git a/dotnet/samples/Concepts/Plugins/ConversationSummaryPlugin.cs b/dotnet/samples/Concepts/Plugins/ConversationSummaryPlugin.cs index dbfd3f08fdc0..e4a5a69dc57e 100644 --- a/dotnet/samples/Concepts/Plugins/ConversationSummaryPlugin.cs +++ b/dotnet/samples/Concepts/Plugins/ConversationSummaryPlugin.cs @@ -79,7 +79,7 @@ public class ConversationSummaryPlugin(ITestOutputHelper output) : BaseTest(outp Jane: Darn, it's just repeating stuff now. John: I think we're done. Jane: We're not though! We need like 1500 more characters. -John: Oh Cananda, our home and native land. +John: Oh Canada, our home and native land. Jane: True patriot love in all thy sons command. John: With glowing hearts we see thee rise. Jane: The True North strong and free. diff --git a/dotnet/samples/Concepts/Plugins/ImportPluginFromGrpc.cs b/dotnet/samples/Concepts/Plugins/ImportPluginFromGrpc.cs index 5f70d8aa0c72..59b84a160103 100644 --- a/dotnet/samples/Concepts/Plugins/ImportPluginFromGrpc.cs +++ b/dotnet/samples/Concepts/Plugins/ImportPluginFromGrpc.cs @@ -8,7 +8,7 @@ namespace Plugins; // This example shows how to use gRPC plugins. public class ImportPluginFromGrpc(ITestOutputHelper output) : BaseTest(output) { - [Fact(Skip = "Setup crendentials")] + [Fact(Skip = "Setup credentials")] public async Task RunAsync() { Kernel kernel = new(); diff --git a/dotnet/samples/Demos/ProcessFrameworkWithSignalR/src/ProcessFramework.Aspire.SignalR.ProcessOrchestrator/Steps/GenerateDocumentationStep.cs b/dotnet/samples/Demos/ProcessFrameworkWithSignalR/src/ProcessFramework.Aspire.SignalR.ProcessOrchestrator/Steps/GenerateDocumentationStep.cs index 978e4410a68c..841051bca909 100644 --- a/dotnet/samples/Demos/ProcessFrameworkWithSignalR/src/ProcessFramework.Aspire.SignalR.ProcessOrchestrator/Steps/GenerateDocumentationStep.cs +++ b/dotnet/samples/Demos/ProcessFrameworkWithSignalR/src/ProcessFramework.Aspire.SignalR.ProcessOrchestrator/Steps/GenerateDocumentationStep.cs @@ -12,7 +12,7 @@ namespace ProcessFramework.Aspire.SignalR.ProcessOrchestrator.Steps; public class GenerateDocumentationStep : KernelProcessStep { /// - /// Function names of the steps, to be refereced when hooking up the step in a SK process + /// Function names of the steps, to be referenced when hooking up the step in a SK process /// public static class ProcessFunctions { diff --git a/dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Processes/Steps/GenerateDocumentationStep.cs b/dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Processes/Steps/GenerateDocumentationStep.cs index 5b9f3b1591b4..0620439e3d53 100644 --- a/dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Processes/Steps/GenerateDocumentationStep.cs +++ b/dotnet/samples/Demos/ProcessWithCloudEvents/ProcessWithCloudEvents.Processes/Steps/GenerateDocumentationStep.cs @@ -12,7 +12,7 @@ namespace ProcessWithCloudEvents.Processes.Steps; public class GenerateDocumentationStep : KernelProcessStep { /// - /// Function names of the steps, to be refereced when hooking up the step in a SK process + /// Function names of the steps, to be referenced when hooking up the step in a SK process /// public static class ProcessFunctions { diff --git a/dotnet/src/Agents/Abstractions/Agent.cs b/dotnet/src/Agents/Abstractions/Agent.cs index 0413475be286..046d99cd60f8 100644 --- a/dotnet/src/Agents/Abstractions/Agent.cs +++ b/dotnet/src/Agents/Abstractions/Agent.cs @@ -369,7 +369,7 @@ protected virtual async Task EnsureThreadExistsWithMessagesAsync - /// Notfiy the given thread that a new message is available. + /// Notify the given thread that a new message is available. /// /// /// diff --git a/dotnet/src/Agents/OpenAI/Extensions/KernelContentExtensions.cs b/dotnet/src/Agents/OpenAI/Extensions/KernelContentExtensions.cs index 4be9d36f5031..d3a074c4d502 100644 --- a/dotnet/src/Agents/OpenAI/Extensions/KernelContentExtensions.cs +++ b/dotnet/src/Agents/OpenAI/Extensions/KernelContentExtensions.cs @@ -6,7 +6,7 @@ namespace Microsoft.SemanticKernel.Agents.OpenAI; /// -/// Extensons methods for . +/// Extension methods for . /// internal static class KernelContentExtensions { diff --git a/dotnet/src/Agents/UnitTests/Internal/KeyEncoderTests.cs b/dotnet/src/Agents/UnitTests/Internal/KeyEncoderTests.cs index 13cc3203d58c..499e63e63b59 100644 --- a/dotnet/src/Agents/UnitTests/Internal/KeyEncoderTests.cs +++ b/dotnet/src/Agents/UnitTests/Internal/KeyEncoderTests.cs @@ -18,16 +18,16 @@ public class KeyEncoderTests public void VerifyKeyEncoderUniqueness() { // Act - this.VerifyHashEquivalancy([]); - this.VerifyHashEquivalancy(nameof(KeyEncoderTests)); - this.VerifyHashEquivalancy(nameof(KeyEncoderTests), "http://localhost", "zoo"); + this.VerifyHashEquivalency([]); + this.VerifyHashEquivalency(nameof(KeyEncoderTests)); + this.VerifyHashEquivalency(nameof(KeyEncoderTests), "http://localhost", "zoo"); // Assert: Verify "well-known" value string localHash = KeyEncoder.GenerateHash([typeof(ChatHistoryChannel).FullName!]); Assert.Equal("Vdx37EnWT9BS+kkCkEgFCg9uHvHNw1+hXMA4sgNMKs4=", localHash); } - private void VerifyHashEquivalancy(params string[] keys) + private void VerifyHashEquivalency(params string[] keys) { // Act string hash1 = KeyEncoder.GenerateHash(keys); diff --git a/dotnet/src/Connectors/Connectors.Amazon.UnitTests/Settings/BedrockChatCompletionModelExecutionSettingsTests.cs b/dotnet/src/Connectors/Connectors.Amazon.UnitTests/Settings/BedrockChatCompletionModelExecutionSettingsTests.cs index 375e9ce599d3..533c7a06aac2 100644 --- a/dotnet/src/Connectors/Connectors.Amazon.UnitTests/Settings/BedrockChatCompletionModelExecutionSettingsTests.cs +++ b/dotnet/src/Connectors/Connectors.Amazon.UnitTests/Settings/BedrockChatCompletionModelExecutionSettingsTests.cs @@ -15,7 +15,7 @@ namespace Microsoft.SemanticKernel.Connectors.Amazon.UnitTests; /// -/// Unit tests for prompt execution settings confirgurations for different Bedrock Models. +/// Unit tests for prompt execution settings configurations for different Bedrock Models. /// public class BedrockChatCompletionModelExecutionSettingsTests { diff --git a/dotnet/src/Experimental/Orchestration.Flow/Plugins/ReActEngine.gpt4.yaml b/dotnet/src/Experimental/Orchestration.Flow/Plugins/ReActEngine.gpt4.yaml index 26e3b1d777cf..7db0c545e95d 100644 --- a/dotnet/src/Experimental/Orchestration.Flow/Plugins/ReActEngine.gpt4.yaml +++ b/dotnet/src/Experimental/Orchestration.Flow/Plugins/ReActEngine.gpt4.yaml @@ -47,7 +47,7 @@ template: | If there is not a fitting function available to validate the result, I can provide the final answer in a clear and human-readable format. [END THOUGHT PROCESS] - IMOPRTANT REMINDER: your each response should contain only one next step and only single one $JSON_BLOB. Do not provide more than one step. + IMPORTANT REMINDER: each response should contain only one next step and only a single $JSON_BLOB. Do not provide more than one step. Let's break down the problem step by step and think about the best approach. Begin! diff --git a/dotnet/src/Experimental/Process.Core/MessageSourceBuilder.cs b/dotnet/src/Experimental/Process.Core/MessageSourceBuilder.cs index 91723bc542bf..18b689a1cdf6 100644 --- a/dotnet/src/Experimental/Process.Core/MessageSourceBuilder.cs +++ b/dotnet/src/Experimental/Process.Core/MessageSourceBuilder.cs @@ -12,7 +12,7 @@ public sealed class MessageSourceBuilder /// /// Initializes a new instance of the class. /// - /// The meassage type + /// The message type /// The source step builder /// Condition that must be met for the message to be processed public MessageSourceBuilder(string messageType, ProcessStepBuilder source, KernelProcessEdgeCondition? condition = null) diff --git a/dotnet/src/InternalUtilities/planning/Schema/JsonSchemaResponse.cs b/dotnet/src/InternalUtilities/planning/Schema/JsonSchemaResponse.cs index 0a9549dbb49b..3ec3031e6b52 100644 --- a/dotnet/src/InternalUtilities/planning/Schema/JsonSchemaResponse.cs +++ b/dotnet/src/InternalUtilities/planning/Schema/JsonSchemaResponse.cs @@ -5,7 +5,7 @@ namespace Microsoft.SemanticKernel; /// -/// A class to describe the content schma of a response/return type from an KernelFunctionFactory, in a JSON Schema friendly way. +/// A class to describe the content schema of a response/return type from a KernelFunctionFactory, in a JSON Schema friendly way. /// internal sealed class JsonSchemaResponse { diff --git a/dotnet/src/SemanticKernel.Core/Memory/Whiteboard/WhiteboardProvider.cs b/dotnet/src/SemanticKernel.Core/Memory/Whiteboard/WhiteboardProvider.cs index 0d30bfe87d6e..0b6c2c8eaeff 100644 --- a/dotnet/src/SemanticKernel.Core/Memory/Whiteboard/WhiteboardProvider.cs +++ b/dotnet/src/SemanticKernel.Core/Memory/Whiteboard/WhiteboardProvider.cs @@ -156,7 +156,7 @@ private async Task UpdateWhiteboardAsync(ChatMessage newMessage, CancellationTok var inputMessagesJson = JsonSerializer.Serialize(basicMessages, WhiteboardProviderSourceGenerationContext.Default.IEnumerableBasicMessage); var currentWhiteboardJson = JsonSerializer.Serialize(this._currentWhiteboardContent, WhiteboardProviderSourceGenerationContext.Default.ListString); - // Inovke the LLM to extract the latest information from the input messages and update the whiteboard. + // Invoke the LLM to extract the latest information from the input messages and update the whiteboard. var result = await this._chatClient.GetResponseAsync( this.FormatPromptTemplate(inputMessagesJson, currentWhiteboardJson, this._maxWhiteboardMessages), new() diff --git a/python/samples/getting_started_with_agents/README.md b/python/samples/getting_started_with_agents/README.md index f36b7be26cb4..74603bbdebf8 100644 --- a/python/samples/getting_started_with_agents/README.md +++ b/python/samples/getting_started_with_agents/README.md @@ -32,7 +32,7 @@ Example|Description [step08_chat_completion_agent_json_result](../getting_started_with_agents/chat_completion/step08_chat_completion_agent_json_result.py)|How to have an agent produce JSON. [step09_chat_completion_agent_logging](../getting_started_with_agents/chat_completion/step09_chat_completion_agent_logging.py)|How to enable logging for agents. [step10_chat_completion_agent_structured_outputs](../getting_started_with_agents/chat_completion/step10_chat_completion_agent_structured_outputs.py)|How to use have a chat completion agent use structured outputs -[step11_chat_completion_agent_declarative](../getting_started_with_agents/chat_completion/step11_chat_completion_agent_declarative.py)|How to create a chat compltion agent from a declarative spec. +[step11_chat_completion_agent_declarative](../getting_started_with_agents/chat_completion/step11_chat_completion_agent_declarative.py)|How to create a chat completion agent from a declarative spec. ## Azure AI Agent