Skip to content

OpenAIConfig

autogen.beta.config.openai.config.OpenAIConfig dataclass #

OpenAIConfig(model, api_key=None, base_url=None, temperature=omit, top_p=omit, streaming=False, max_tokens=omit, max_completion_tokens=omit, websocket_base_url=None, organization=None, project=None, timeout=not_given, max_retries=DEFAULT_MAX_RETRIES, default_headers=None, default_query=None, http_client=None, frequency_penalty=omit, presence_penalty=omit, seed=omit, stop=omit, n=omit, user=omit, logprobs=omit, top_logprobs=omit, tool_choice=omit, parallel_tool_calls=omit, reasoning_effort=omit, logit_bias=omit, metadata=omit, modalities=omit, prediction=omit, prompt_cache_key=omit, safety_identifier=omit, service_tier=omit, store=omit, verbosity=omit, web_search_options=omit, extra_body=None)

Bases: ModelConfig

model instance-attribute #

model

api_key class-attribute instance-attribute #

api_key = None

base_url class-attribute instance-attribute #

base_url = None

temperature class-attribute instance-attribute #

temperature = omit

top_p class-attribute instance-attribute #

top_p = omit

streaming class-attribute instance-attribute #

streaming = False

max_tokens class-attribute instance-attribute #

max_tokens = omit

max_completion_tokens class-attribute instance-attribute #

max_completion_tokens = omit

websocket_base_url class-attribute instance-attribute #

websocket_base_url = None

organization class-attribute instance-attribute #

organization = None

project class-attribute instance-attribute #

project = None

timeout class-attribute instance-attribute #

timeout = not_given

max_retries class-attribute instance-attribute #

max_retries = DEFAULT_MAX_RETRIES

default_headers class-attribute instance-attribute #

default_headers = None

default_query class-attribute instance-attribute #

default_query = None

http_client class-attribute instance-attribute #

http_client = None

frequency_penalty class-attribute instance-attribute #

frequency_penalty = omit

presence_penalty class-attribute instance-attribute #

presence_penalty = omit

seed class-attribute instance-attribute #

seed = omit

stop class-attribute instance-attribute #

stop = omit

n class-attribute instance-attribute #

n = omit

user class-attribute instance-attribute #

user = omit

logprobs class-attribute instance-attribute #

logprobs = omit

top_logprobs class-attribute instance-attribute #

top_logprobs = omit

tool_choice class-attribute instance-attribute #

tool_choice = omit

parallel_tool_calls class-attribute instance-attribute #

parallel_tool_calls = omit

reasoning_effort class-attribute instance-attribute #

reasoning_effort = omit

logit_bias class-attribute instance-attribute #

logit_bias = omit

metadata class-attribute instance-attribute #

metadata = omit

modalities class-attribute instance-attribute #

modalities = omit

prediction class-attribute instance-attribute #

prediction = omit

prompt_cache_key class-attribute instance-attribute #

prompt_cache_key = omit

safety_identifier class-attribute instance-attribute #

safety_identifier = omit

service_tier class-attribute instance-attribute #

service_tier = omit

store class-attribute instance-attribute #

store = omit

verbosity class-attribute instance-attribute #

verbosity = omit

web_search_options class-attribute instance-attribute #

web_search_options = omit

extra_body class-attribute instance-attribute #

extra_body = None

copy #

copy(**overrides)
Source code in autogen/beta/config/openai/config.py
def copy(self, /, **overrides: Unpack[OpenAIConfigOverrides]) -> "OpenAIConfig":
    return replace(self, **overrides)

create #

create()
Source code in autogen/beta/config/openai/config.py
def create(self) -> OpenAIClient:
    options = CreateOptions(
        model=self.model,
        stream=self.streaming,
        reasoning_effort=self.reasoning_effort,
        temperature=self.temperature,
        top_p=self.top_p,
        max_tokens=self.max_tokens,
        max_completion_tokens=self.max_completion_tokens,
        frequency_penalty=self.frequency_penalty,
        presence_penalty=self.presence_penalty,
        seed=self.seed,
        stop=self.stop,
        n=self.n,
        user=self.user,
        logprobs=self.logprobs,
        top_logprobs=self.top_logprobs,
        tool_choice=self.tool_choice,
        parallel_tool_calls=self.parallel_tool_calls,
        logit_bias=self.logit_bias,
        metadata=self.metadata,
        modalities=self.modalities,
        prediction=self.prediction,
        prompt_cache_key=self.prompt_cache_key,
        safety_identifier=self.safety_identifier,
        service_tier=self.service_tier,
        store=self.store,
        verbosity=self.verbosity,
        web_search_options=self.web_search_options,
        stream_options={"include_usage": True} if self.streaming else omit,
        extra_body=self.extra_body,
    )

    return OpenAIClient(
        api_key=self.api_key,
        organization=self.organization,
        project=self.project,
        base_url=self.base_url,
        websocket_base_url=self.websocket_base_url,
        timeout=self.timeout,
        max_retries=self.max_retries,
        default_headers=self.default_headers,
        default_query=self.default_query,
        http_client=self.http_client,
        create_options=options,
    )

create_files_client #

create_files_client()
Source code in autogen/beta/config/openai/config.py
def create_files_client(self) -> OpenAIFilesClient:
    return OpenAIFilesClient(self)