Share via

OpenAISettings Class

OpenAI model settings.

The settings are first loaded from environment variables with the prefix '>>OPENAI_<<'. If the environment variables are not found, the settings can be loaded from a .env file with the encoding 'utf-8'. If the settings are not found in the .env file, the settings are ignored; however, validation will fail alerting that the settings are missing.

Optional settings for prefix '>>OPENAI_<<' are:

  • org_id: str | None - This is usually optional unless your account belongs to multiple organizations.

    (Env var OPENAI_ORG_ID)

  • chat_model_id: str | None - The OpenAI chat model ID to use, for example, gpt-3.5-turbo or gpt-4.

    (Env var OPENAI_CHAT_MODEL_ID)

  • text_model_id: str | None - The OpenAI text model ID to use, for example, gpt-3.5-turbo-instruct.

    (Env var OPENAI_TEXT_MODEL_ID)

  • embedding_model_id: str | None - The OpenAI embedding model ID to use, for example, text-embedding-ada-002.

    (Env var OPENAI_EMBEDDING_MODEL_ID)

  • text_to_image_model_id: str | None - The OpenAI text to image model ID to use, for example, dall-e-3.

    (Env var OPENAI_TEXT_TO_IMAGE_MODEL_ID)

  • audio_to_text_model_id: str | None - The OpenAI audio to text model ID to use, for example, whisper-1.

    (Env var OPENAI_AUDIO_TO_TEXT_MODEL_ID)

  • text_to_audio_model_id: str | None - The OpenAI text to audio model ID to use, for example, jukebox-1.

    (Env var OPENAI_TEXT_TO_AUDIO_MODEL_ID)

  • env_file_path: str | None - if provided, the .env settings are read from this file path location

Constructor

OpenAISettings(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: DotenvType | None = PosixPath('.'), _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_implicit_flags: bool | None = None, _secrets_dir: PathType | None = None, *, env_file_path: str | None = None, env_file_encoding: str = 'utf-8', api_key: SecretStr | None = None, org_id: str | None = None, chat_model_id: str | None = None, text_model_id: str | None = None, embedding_model_id: str | None = None, text_to_image_model_id: str | None = None, audio_to_text_model_id: str | None = None, text_to_audio_model_id: str | None = None)

Parameters

Name Description
_case_sensitive
Default value: None
_nested_model_default_partial_update
Default value: None
_env_prefix
Default value: None
_env_file
Default value: .
_env_file_encoding
Default value: None
_env_ignore_empty
Default value: None
_env_nested_delimiter
Default value: None
_env_parse_none_str
Default value: None
_env_parse_enums
Default value: None
_cli_prog_name
Default value: None
_cli_parse_args
Default value: None
_cli_settings_source
Default value: None
_cli_parse_none_str
Default value: None
_cli_hide_none_type
Default value: None
_cli_avoid_json
Default value: None
_cli_enforce_required
Default value: None
_cli_use_class_docs_for_groups
Default value: None
_cli_exit_on_error
Default value: None
_cli_prefix
Default value: None
_cli_implicit_flags
Default value: None
_secrets_dir
Default value: None

Keyword-Only Parameters

Name Description
env_file_path
Required
env_file_encoding
Default value: utf-8
api_key
Required
org_id
Required
chat_model_id
Required
text_model_id
Required
embedding_model_id
Required
text_to_image_model_id
Required
audio_to_text_model_id
Required
text_to_audio_model_id
Required

Attributes

api_key 

api_key: SecretStr | None

audio_to_text_model_id 

audio_to_text_model_id: str | None

chat_model_id 

chat_model_id: str | None

embedding_model_id 

embedding_model_id: str | None

env_file_encoding 

env_file_encoding: str

env_file_path 

env_file_path: str | None

env_prefix 

env_prefix: ClassVar[str] = 'OPENAI_'

org_id 

org_id: str | None

text_model_id 

text_model_id: str | None

text_to_audio_model_id 

text_to_audio_model_id: str | None

text_to_image_model_id 

text_to_image_model_id: str | None