AzureOpenAIKernelBuilderExtensions.AddAzureOpenAITextToImage Method

Definition

Namespace:

Microsoft.SemanticKernel

Assembly:

Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll

Package:

Microsoft.SemanticKernel.Connectors.AzureOpenAI v1.20.0

Overloads

AddAzureOpenAITextToImage(IKernelBuilder, String, AzureOpenAIClient, String, String)	Adds the AzureOpenAITextToImageService to the Services.
AddAzureOpenAITextToImage(IKernelBuilder, String, String, TokenCredential, String, String, String)	Adds the AzureOpenAITextToImageService to the Services.
AddAzureOpenAITextToImage(IKernelBuilder, String, String, String, String, String, String, HttpClient)	Adds the AzureOpenAITextToImageService to the Services.

AddAzureOpenAITextToImage(IKernelBuilder, String, AzureOpenAIClient, String, String)

Adds the AzureOpenAITextToImageService to the Services.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureOpenAITextToImage (this Microsoft.SemanticKernel.IKernelBuilder builder, string deploymentName, Azure.AI.OpenAI.AzureOpenAIClient? azureOpenAIClient = default, string? modelId = default, string? serviceId = default);

static member AddAzureOpenAITextToImage : Microsoft.SemanticKernel.IKernelBuilder * string * Azure.AI.OpenAI.AzureOpenAIClient * string * string -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddAzureOpenAITextToImage (builder As IKernelBuilder, deploymentName As String, Optional azureOpenAIClient As AzureOpenAIClient = Nothing, Optional modelId As String = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder

Parameters

builder

IKernelBuilder

The IKernelBuilder instance to augment.

deploymentName

String

Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource

azureOpenAIClient

AzureOpenAIClient

AzureOpenAIClient to use for the service. If null, one must be available in the service provider when this service is resolved.

modelId

String

Model identifier, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

serviceId

String

A local identifier for the given AI service

Returns

IKernelBuilder

The same instance as builder.

AddAzureOpenAITextToImage(IKernelBuilder, String, String, TokenCredential, String, String, String)

Adds the AzureOpenAITextToImageService to the Services.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureOpenAITextToImage (this Microsoft.SemanticKernel.IKernelBuilder builder, string deploymentName, string endpoint, Azure.Core.TokenCredential credentials, string? modelId = default, string? serviceId = default, string? apiVersion = default);

static member AddAzureOpenAITextToImage : Microsoft.SemanticKernel.IKernelBuilder * string * string * Azure.Core.TokenCredential * string * string * string -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddAzureOpenAITextToImage (builder As IKernelBuilder, deploymentName As String, endpoint As String, credentials As TokenCredential, Optional modelId As String = Nothing, Optional serviceId As String = Nothing, Optional apiVersion As String = Nothing) As IKernelBuilder

Parameters

builder

IKernelBuilder

The IKernelBuilder instance to augment.

deploymentName

String

Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource

endpoint

String

Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

credentials

TokenCredential

Token credentials, e.g. DefaultAzureCredential, ManagedIdentityCredential, EnvironmentCredential, etc.

modelId

String

Model identifier, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

serviceId

String

A local identifier for the given AI service

apiVersion

String

Azure OpenAI API version

Returns

IKernelBuilder

The same instance as builder.

AddAzureOpenAITextToImage(IKernelBuilder, String, String, String, String, String, String, HttpClient)

Adds the AzureOpenAITextToImageService to the Services.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureOpenAITextToImage (this Microsoft.SemanticKernel.IKernelBuilder builder, string deploymentName, string endpoint, string apiKey, string? modelId = default, string? serviceId = default, string? apiVersion = default, System.Net.Http.HttpClient? httpClient = default);

static member AddAzureOpenAITextToImage : Microsoft.SemanticKernel.IKernelBuilder * string * string * string * string * string * string * System.Net.Http.HttpClient -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddAzureOpenAITextToImage (builder As IKernelBuilder, deploymentName As String, endpoint As String, apiKey As String, Optional modelId As String = Nothing, Optional serviceId As String = Nothing, Optional apiVersion As String = Nothing, Optional httpClient As HttpClient = Nothing) As IKernelBuilder

Parameters

builder

IKernelBuilder

The IKernelBuilder instance to augment.

deploymentName

String

Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource

endpoint

String

Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

apiKey

String

Azure OpenAI API key

modelId

String

Model identifier, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

serviceId

String

A local identifier for the given AI service

apiVersion

String

Azure OpenAI API version

httpClient

HttpClient

The HttpClient to use with this service.

Returns

IKernelBuilder

The same instance as builder.