OpenAIKernelBuilderExtensions.AddOpenAIChatCompletion Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| AddOpenAIChatCompletion(IKernelBuilder, String, OpenAIClient, String) |
Adds the OpenAI chat completion service to the list. |
| AddOpenAIChatCompletion(IKernelBuilder, String, String, String, String, HttpClient) |
Adds the OpenAI chat completion service to the list. |
| AddOpenAIChatCompletion(IKernelBuilder, String, Uri, String, String, String, HttpClient) |
Adds the Custom Endpoint OpenAI chat completion service to the list. |
AddOpenAIChatCompletion(IKernelBuilder, String, OpenAIClient, String)
Adds the OpenAI chat completion service to the list.
public static Microsoft.SemanticKernel.IKernelBuilder AddOpenAIChatCompletion (this Microsoft.SemanticKernel.IKernelBuilder builder, string modelId, OpenAI.OpenAIClient? openAIClient = default, string? serviceId = default);static member AddOpenAIChatCompletion : Microsoft.SemanticKernel.IKernelBuilder * string * OpenAI.OpenAIClient * string -> Microsoft.SemanticKernel.IKernelBuilder<Extension()>
Public Function AddOpenAIChatCompletion (builder As IKernelBuilder, modelId As String, Optional openAIClient As OpenAIClient = Nothing, Optional serviceId As String = Nothing) As IKernelBuilderParameters
- builder
- IKernelBuilder
The IKernelBuilder instance to augment.
- modelId
- String
OpenAI model id
- openAIClient
- OpenAI.OpenAIClient
OpenAI.OpenAIClient to use for the service. If null, one must be available in the service provider when this service is resolved.
- serviceId
- String
A local identifier for the given AI service
Returns
The same instance as builder.
Applies to
AddOpenAIChatCompletion(IKernelBuilder, String, String, String, String, HttpClient)
Adds the OpenAI chat completion service to the list.
public static Microsoft.SemanticKernel.IKernelBuilder AddOpenAIChatCompletion (this Microsoft.SemanticKernel.IKernelBuilder builder, string modelId, string apiKey, string? orgId = default, string? serviceId = default, System.Net.Http.HttpClient? httpClient = default);static member AddOpenAIChatCompletion : Microsoft.SemanticKernel.IKernelBuilder * string * string * string * string * System.Net.Http.HttpClient -> Microsoft.SemanticKernel.IKernelBuilder<Extension()>
Public Function AddOpenAIChatCompletion (builder As IKernelBuilder, modelId As String, apiKey As String, Optional orgId As String = Nothing, Optional serviceId As String = Nothing, Optional httpClient As HttpClient = Nothing) As IKernelBuilderParameters
- builder
- IKernelBuilder
The IKernelBuilder instance to augment.
- modelId
- String
OpenAI model name, see https://platform.openai.com/docs/models
- apiKey
- String
OpenAI API key, see https://platform.openai.com/account/api-keys
- orgId
- String
OpenAI organization id. This is usually optional unless your account belongs to multiple organizations.
- serviceId
- String
A local identifier for the given AI service
- httpClient
- HttpClient
The HttpClient to use with this service.
Returns
The same instance as builder.
Applies to
AddOpenAIChatCompletion(IKernelBuilder, String, Uri, String, String, String, HttpClient)
Adds the Custom Endpoint OpenAI chat completion service to the list.
public static Microsoft.SemanticKernel.IKernelBuilder AddOpenAIChatCompletion (this Microsoft.SemanticKernel.IKernelBuilder builder, string modelId, Uri endpoint, string? apiKey, string? orgId = default, string? serviceId = default, System.Net.Http.HttpClient? httpClient = default);static member AddOpenAIChatCompletion : Microsoft.SemanticKernel.IKernelBuilder * string * Uri * string * string * string * System.Net.Http.HttpClient -> Microsoft.SemanticKernel.IKernelBuilder<Extension()>
Public Function AddOpenAIChatCompletion (builder As IKernelBuilder, modelId As String, endpoint As Uri, apiKey As String, Optional orgId As String = Nothing, Optional serviceId As String = Nothing, Optional httpClient As HttpClient = Nothing) As IKernelBuilderParameters
- builder
- IKernelBuilder
The IKernelBuilder instance to augment.
- modelId
- String
OpenAI model name, see https://platform.openai.com/docs/models
- endpoint
- Uri
Custom OpenAI Compatible Message API endpoint
- apiKey
- String
OpenAI API key, see https://platform.openai.com/account/api-keys
- orgId
- String
OpenAI organization id. This is usually optional unless your account belongs to multiple organizations.
- serviceId
- String
A local identifier for the given AI service
- httpClient
- HttpClient
The HttpClient to use with this service.
Returns
The same instance as builder.