Share via

OpenAIChatCompletion Class

OpenAI Chat completion class.

Initialize an OpenAIChatCompletion service.

Constructor

OpenAIChatCompletion(ai_model_id: str | None = None, service_id: str | None = None, api_key: str | None = None, org_id: str | None = None, default_headers: Mapping[str, str] | None = None, async_client: AsyncOpenAI | None = None, env_file_path: str | None = None, env_file_encoding: str | None = None, instruction_role: str | None = None)

Parameters

Name Description
ai_model_id
str

OpenAI model name, see https://platform.openai.com/docs/models

Default value: None
service_id
<xref:<xref:semantic_kernel.connectors.ai.open_ai.str | None>>

Service ID tied to the execution settings.

Default value: None
api_key
<xref:<xref:semantic_kernel.connectors.ai.open_ai.str | None>>

The optional API key to use. If provided will override, the env vars or .env file value.

Default value: None
org_id
<xref:<xref:semantic_kernel.connectors.ai.open_ai.str | None>>

The optional org ID to use. If provided will override, the env vars or .env file value.

Default value: None
default_headers

The default headers mapping of string keys to string values for HTTP requests. (Optional)

Default value: None
async_client
<xref:Optional>[<xref:AsyncOpenAI>]

An existing client to use. (Optional)

Default value: None
env_file_path
<xref:<xref:semantic_kernel.connectors.ai.open_ai.str | None>>

Use the environment settings file as a fallback to environment variables. (Optional)

Default value: None
env_file_encoding
<xref:<xref:semantic_kernel.connectors.ai.open_ai.str | None>>

The encoding of the environment settings file. (Optional)

Default value: None
instruction_role
<xref:<xref:semantic_kernel.connectors.ai.open_ai.str | None>>

The role to use for 'instruction' messages, for example,

Default value: None

Methods

from_dict

Initialize an Open AI service from a dictionary of settings.

from_dict

Initialize an Open AI service from a dictionary of settings.

from_dict(settings: dict[str, Any]) -> OpenAIChatCompletion

Parameters

Name Description
settings
Required

A dictionary of settings for the service.