Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/decisions/0046-kernel-content-graduation.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Pros:
- With no deferred content we have simpler API and a single responsibility for contents.
- Can be written and read in both `Data` or `DataUri` formats.
- Can have a `Uri` reference property, which is common for specialized contexts.
- Fully serializeable.
- Fully serializable.
- Data Uri parameters support (serialization included).
- Data Uri and Base64 validation checks
- Data Uri and Data can be dynamically generated
Expand Down Expand Up @@ -197,7 +197,7 @@ Pros:
- Can be used as a `BinaryContent` type
- Can be written and read in both `Data` or `DataUri` formats.
- Can have a `Uri` dedicated for referenced location.
- Fully serializeable.
- Fully serializable.
- Data Uri parameters support (serialization included).
- Data Uri and Base64 validation checks
- Can be retrieved
Expand Down Expand Up @@ -254,7 +254,7 @@ Pros:
- Can be used as a `BinaryContent` type
- Can be written and read in both `Data` or `DataUri` formats.
- Can have a `Uri` dedicated for referenced location.
- Fully serializeable.
- Fully serializable.
- Data Uri parameters support (serialization included).
- Data Uri and Base64 validation checks
- Can be retrieved
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
namespace SemanticKernel.Connectors.AzureOpenAI.UnitTests.Extensions;

/// <summary>
/// Unit tests for the kernel builder extensions in the <see cref="AzureOpenAIServiceCollectionExtensions"/> class.
/// Unit tests for the kernel builder extensions in the <see cref="AzureOpenAIKernelBuilderExtensions"/> class.
/// </summary>
public sealed class AzureOpenAIServiceKernelBuilderExtensionsTests
public sealed class AzureOpenAIKernelBuilderExtensionsTests
{
#region Chat completion

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static class AzureOpenAIKernelBuilderExtensions
#region Chat Completion

/// <summary>
/// Adds the Azure OpenAI chat completion service to the list.
/// Adds the <see cref="AzureOpenAIChatCompletionService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -67,7 +67,7 @@ public static IKernelBuilder AddAzureOpenAIChatCompletion(
}

/// <summary>
/// Adds the Azure OpenAI chat completion service to the list.
/// Adds the <see cref="AzureOpenAIChatCompletionService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -107,7 +107,7 @@ public static IKernelBuilder AddAzureOpenAIChatCompletion(
}

/// <summary>
/// Adds the Azure OpenAI chat completion service to the list.
/// Adds the <see cref="AzureOpenAIChatCompletionService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -139,7 +139,7 @@ public static IKernelBuilder AddAzureOpenAIChatCompletion(
#region Text Embedding

/// <summary>
/// Adds an Azure OpenAI text embeddings service to the list.
/// Adds the <see cref="AzureOpenAITextEmbeddingGenerationService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -177,7 +177,7 @@ public static IKernelBuilder AddAzureOpenAITextEmbeddingGeneration(
}

/// <summary>
/// Adds an Azure OpenAI text embeddings service to the list.
/// Adds the <see cref="AzureOpenAITextEmbeddingGenerationService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -216,7 +216,7 @@ public static IKernelBuilder AddAzureOpenAITextEmbeddingGeneration(
}

/// <summary>
/// Adds an Azure OpenAI text embeddings service to the list.
/// Adds the <see cref="AzureOpenAITextEmbeddingGenerationService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -252,7 +252,7 @@ public static IKernelBuilder AddAzureOpenAITextEmbeddingGeneration(
#region Images

/// <summary>
/// Add the Azure OpenAI text-to-image service to the list.
/// Adds the <see cref="AzureOpenAITextToImageService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -290,7 +290,7 @@ public static IKernelBuilder AddAzureOpenAITextToImage(
}

/// <summary>
/// Add the Azure OpenAI text-to-image service to the list.
/// Adds the <see cref="AzureOpenAITextToImageService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -330,7 +330,7 @@ public static IKernelBuilder AddAzureOpenAITextToImage(
}

/// <summary>
/// Add the Azure OpenAI text-to-image service to the list.
/// Adds the <see cref="AzureOpenAITextToImageService"/> to the <see cref="IKernelBuilder.Services"/>.
/// </summary>
/// <param name="builder">The <see cref="IKernelBuilder"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static class AzureOpenAIServiceCollectionExtensions
#region Chat Completion

/// <summary>
/// Adds the Azure OpenAI chat completion service to the list.
/// Adds the <see cref="AzureOpenAIChatCompletionService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -65,7 +65,7 @@ public static IServiceCollection AddAzureOpenAIChatCompletion(
}

/// <summary>
/// Adds the Azure OpenAI chat completion service to the list.
/// Adds the <see cref="AzureOpenAIChatCompletionService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -103,7 +103,7 @@ public static IServiceCollection AddAzureOpenAIChatCompletion(
}

/// <summary>
/// Adds the Azure OpenAI chat completion service to the list.
/// Adds the <see cref="AzureOpenAIChatCompletionService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -135,7 +135,7 @@ public static IServiceCollection AddAzureOpenAIChatCompletion(
#region Text Embedding

/// <summary>
/// Adds an Azure OpenAI text embeddings service to the list.
/// Adds the <see cref="AzureOpenAITextEmbeddingGenerationService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -169,7 +169,7 @@ public static IServiceCollection AddAzureOpenAITextEmbeddingGeneration(
}

/// <summary>
/// Adds an Azure OpenAI text embeddings service to the list.
/// Adds the <see cref="AzureOpenAITextEmbeddingGenerationService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -204,7 +204,7 @@ public static IServiceCollection AddAzureOpenAITextEmbeddingGeneration(
}

/// <summary>
/// Adds an Azure OpenAI text embeddings service to the list.
/// Adds the <see cref="AzureOpenAITextEmbeddingGenerationService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -238,7 +238,7 @@ public static IServiceCollection AddAzureOpenAITextEmbeddingGeneration(
#region Images

/// <summary>
/// Add the Azure OpenAI text-to-image service to the list.
/// Adds the <see cref="AzureOpenAITextToImageService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -274,7 +274,7 @@ public static IServiceCollection AddAzureOpenAITextToImage(
}

/// <summary>
/// Add the Azure OpenAI text-to-image service to the list.
/// Adds the <see cref="AzureOpenAITextToImageService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down Expand Up @@ -309,7 +309,7 @@ public static IServiceCollection AddAzureOpenAITextToImage(
}

/// <summary>
/// Add the Azure OpenAI text-to-image service to the list.
/// Adds the <see cref="AzureOpenAITextToImageService"/> to the <see cref="IServiceCollection"/>.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> instance to augment.</param>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
using Microsoft.SemanticKernel.ChatCompletion;
using Microsoft.SemanticKernel.Services;
using Microsoft.SemanticKernel.TextGeneration;
using OpenAI;

namespace Microsoft.SemanticKernel.Connectors.AzureOpenAI;

Expand All @@ -23,7 +22,7 @@ public sealed class AzureOpenAIChatCompletionService : IChatCompletionService, I
private readonly ClientCore _core;

/// <summary>
/// Create an instance of the <see cref="AzureOpenAIChatCompletionService"/> connector with API key auth.
/// Initializes a new instance of the <see cref="AzureOpenAIChatCompletionService"/> class.
/// </summary>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
/// <param name="endpoint">Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart</param>
Expand All @@ -45,7 +44,7 @@ public AzureOpenAIChatCompletionService(
}

/// <summary>
/// Create an instance of the <see cref="AzureOpenAIChatCompletionService"/> connector with AAD auth.
/// Initializes a new instance of the <see cref="AzureOpenAIChatCompletionService"/> class.
/// </summary>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
/// <param name="endpoint">Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart</param>
Expand All @@ -66,7 +65,7 @@ public AzureOpenAIChatCompletionService(
}

/// <summary>
/// Creates a new <see cref="AzureOpenAIChatCompletionService"/> client instance using the specified <see cref="OpenAIClient"/>.
/// Initializes a new instance of the <see cref="AzureOpenAIChatCompletionService"/> class.
/// </summary>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
/// <param name="azureOpenAIClient">Custom <see cref="AzureOpenAIClient"/>.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public sealed class AzureOpenAITextEmbeddingGenerationService : ITextEmbeddingGe
private readonly int? _dimensions;

/// <summary>
/// Creates a new <see cref="AzureOpenAITextEmbeddingGenerationService"/> client instance using API Key auth.
/// Initializes a new instance of the <see cref="AzureOpenAITextEmbeddingGenerationService"/> class.
/// </summary>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
/// <param name="endpoint">Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart</param>
Expand All @@ -50,7 +50,7 @@ public AzureOpenAITextEmbeddingGenerationService(
}

/// <summary>
/// Creates a new <see cref="AzureOpenAITextEmbeddingGenerationService"/> client instance supporting AAD auth.
/// Initializes a new instance of the <see cref="AzureOpenAITextEmbeddingGenerationService"/> class.
/// </summary>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
/// <param name="endpoint">Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart</param>
Expand All @@ -76,7 +76,7 @@ public AzureOpenAITextEmbeddingGenerationService(
}

/// <summary>
/// Creates a new <see cref="AzureOpenAITextEmbeddingGenerationService"/> client.
/// Initializes a new instance of the <see cref="AzureOpenAITextEmbeddingGenerationService"/> class.
/// </summary>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
/// <param name="azureOpenAIClient">Custom <see cref="AzureOpenAIClient"/> for HTTP requests.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public sealed class AzureOpenAITextToAudioService : ITextToAudioService
public static string DeploymentNameKey => "DeploymentName";

/// <summary>
/// Creates an instance of the <see cref="AzureOpenAITextToAudioService"/> connector with API key auth.
/// Initializes a new instance of the <see cref="AzureOpenAITextToAudioService"/> class.
/// </summary>
/// <param name="deploymentName">Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource</param>
/// <param name="endpoint">Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart</param>
Expand Down
Loading