Docs /Templates/ sinapsis-openai

OpenAIChatWrapper

sinapsis-openaiOpenAIdynamicopenaiprompttext

Python template · sinapsis_openai.templates.openai_chat

Overview

OpenAIChatCompletion is a specialized template that wraps the 'OpenAI.chat.completions.create' method. The template is built upon the common functionality provided by OpenAIBase to transform input data packets into appropriately formatted message lists, send the chat request to the OpenAI API, and parse the resulting responses into new text packets. This template requires configuration of both the API parameters (via the openai_init attribute) and the chat-specific settings (for example, the ChatModel to be used).

The class attribute 'WrapperEntry' is defined using a nested WrapperEntryConfig. This setup enables dynamic template generation by first wrapping the base OpenAI client and then, in a nested manner, wrapping the specific OpenAI API call (chat.completions.create). In this way, only the desired method parameters (excluding those such as messages, audio, and model) are exposed for configuration.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-openai==1.0.0
uv pip install sinapsis-openai==1.0.0
uv add sinapsis-openai==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

modelRequired
The chat model to be used for the completion. openai_init api_key typing.Union[str, typing.Callable[[], str], NoneType]: default: None admin_api_key str | None: default: None workload_identity typing.Any: default: None… Read full field description

The chat model to be used for the completion. openai_init api_key typing.Union[str, typing.Callable[[], str], NoneType]: default: None admin_api_key str | None: default: None workload_identity typing.Any: default: None organization str | None: default: None project str | None: default: None webhook_secret str | None: default: None provider typing.Any: default: None base_url typing.Any: default: None websocket_base_url typing.Any: default: None timeout typing.Any: default: NOT_GIVEN max_retries <class 'int'>: default: 2 default_headers typing.Optional[typing.Mapping[str, str]]: default: None default_query typing.Optional[typing.Mapping[str, object]]: default: None http_client typing.Any: default: None _strict_response_validation <class 'bool'>: default: False _enforce_credentials <class 'bool'>: default: Truecreate frequency_penalty typing.Any: default: <openai.Omit object at 0x74f9db285a90> function_call typing.Any: default: <openai.Omit object at 0x74f9db285a90> functions typing.Any: default: <openai.Omit object at 0x74f9db285a90> logit_bias typing.Any: default: <openai.Omit object at 0x74f9db285a90> logprobs typing.Any: default: <openai.Omit object at 0x74f9db285a90> max_completion_tokens typing.Any: default: <openai.Omit object at 0x74f9db285a90> max_tokens typing.Any: default: <openai.Omit object at 0x74f9db285a90> metadata typing.Any: default: <openai.Omit object at 0x74f9db285a90> modalities typing.Any: default: <openai.Omit object at 0x74f9db285a90> moderation typing.Any: default: <openai.Omit object at 0x74f9db285a90> n typing.Any: default: <openai.Omit object at 0x74f9db285a90> parallel_tool_calls typing.Any: default: <openai.Omit object at 0x74f9db285a90> prediction typing.Any: default: <openai.Omit object at 0x74f9db285a90> presence_penalty typing.Any: default: <openai.Omit object at 0x74f9db285a90> prompt_cache_key typing.Any: default: <openai.Omit object at 0x74f9db285a90> prompt_cache_options typing.Any: default: <openai.Omit object at 0x74f9db285a90> prompt_cache_retention typing.Any: default: <openai.Omit object at 0x74f9db285a90> reasoning_effort typing.Any: default: <openai.Omit object at 0x74f9db285a90> response_format typing.Any: default: <openai.Omit object at 0x74f9db285a90> safety_identifier typing.Any: default: <openai.Omit object at 0x74f9db285a90> seed typing.Any: default: <openai.Omit object at 0x74f9db285a90> service_tier typing.Any: default: <openai.Omit object at 0x74f9db285a90> stop typing.Any: default: <openai.Omit object at 0x74f9db285a90> store typing.Any: default: <openai.Omit object at 0x74f9db285a90> stream typing.Any: default: <openai.Omit object at 0x74f9db285a90> stream_options typing.Any: default: <openai.Omit object at 0x74f9db285a90> temperature typing.Any: default: <openai.Omit object at 0x74f9db285a90> tool_choice typing.Any: default: <openai.Omit object at 0x74f9db285a90> tools typing.Any: default: <openai.Omit object at 0x74f9db285a90> top_logprobs typing.Any: default: <openai.Omit object at 0x74f9db285a90> top_p typing.Any: default: <openai.Omit object at 0x74f9db285a90> user typing.Any: default: <openai.Omit object at 0x74f9db285a90> verbosity typing.Any: default: <openai.Omit object at 0x74f9db285a90> web_search_options typing.Any: default: <openai.Omit object at 0x74f9db285a90> extra_headers typing.Any: default: None extra_query typing.Any: default: None extra_body typing.Any: default: None timeout typing.Any: default: NOT_GIVEN

typing.Literal['gpt-5.6-sol', 'gpt-5.6-terra', 'gpt-5.6-luna', 'gpt-5.5', 'gpt-5.4', 'gpt-5.4-mini', 'gpt-5.4-nano', 'gpt-5.4-mini-2026-03-17', 'gpt-5.4-nano-2026-03-17', 'gpt-5.3-chat-latest', 'gpt-5.2', 'gpt-5.2-2025-12-11', 'gpt-5.2-chat-latest', 'gpt-5.2-pro', 'gpt-5.2-pro-2025-12-11', 'gpt-5.1', 'gpt-5.1-2025-11-13', 'gpt-5.1-codex', 'gpt-5.1-mini', 'gpt-5.1-chat-latest', 'gpt-5', 'gpt-5-mini', 'gpt-5-nano', 'gpt-5-2025-08-07', 'gpt-5-mini-2025-08-07', 'gpt-5-nano-2025-08-07', 'gpt-5-chat-latest', 'gpt-4.1', 'gpt-4.1-mini', 'gpt-4.1-nano', 'gpt-4.1-2025-04-14', 'gpt-4.1-mini-2025-04-14', 'gpt-4.1-nano-2025-04-14', 'o4-mini', 'o4-mini-2025-04-16', 'o3', 'o3-2025-04-16', 'o3-mini', 'o3-mini-2025-01-31', 'o1', 'o1-2024-12-17', 'o1-preview', 'o1-preview-2024-09-12', 'o1-mini', 'o1-mini-2024-09-12', 'gpt-4o', 'gpt-4o-2024-11-20', 'gpt-4o-2024-08-06', 'gpt-4o-2024-05-13', 'gpt-4o-audio-preview', 'gpt-4o-audio-preview-2024-10-01', 'gpt-4o-audio-preview-2024-12-17', 'gpt-4o-audio-preview-2025-06-03', 'gpt-4o-mini-audio-preview', 'gpt-4o-mini-audio-preview-2024-12-17', 'gpt-4o-search-preview', 'gpt-4o-mini-search-preview', 'gpt-4o-search-preview-2025-03-11', 'gpt-4o-mini-search-preview-2025-03-11', 'chatgpt-4o-latest', 'codex-mini-latest', 'gpt-4o-mini', 'gpt-4o-mini-2024-07-18', 'gpt-4-turbo', 'gpt-4-turbo-2024-04-09', 'gpt-4-0125-preview', 'gpt-4-turbo-preview', 'gpt-4-1106-preview', 'gpt-4-vision-preview', 'gpt-4', 'gpt-4-0314', 'gpt-4-0613', 'gpt-4-32k', 'gpt-4-32k-0314', 'gpt-4-32k-0613', 'gpt-3.5-turbo', 'gpt-3.5-turbo-16k', 'gpt-3.5-turbo-0301', 'gpt-3.5-turbo-0613', 'gpt-3.5-turbo-1106', 'gpt-3.5-turbo-0125', 'gpt-3.5-turbo-16k-0613']
Required
Default: null
createRequired
createAttributes
Required
Default: null
n
Any
Optional
Default: null
seed
Any
Optional
Default: null
stop
Any
Optional
Default: null
user
Any
Optional
Default: null
store
Any
Optional
Default: null
tools
Any
Optional
Default: null
top_p
Any
Optional
Default: null
stream
Any
Optional
Default: null
timeout
Any
Optional
Default: null
logprobs
Any
Optional
Default: null
metadata
Any
Optional
Default: null
functions
Any
Optional
Default: null
verbosity
Any
Optional
Default: null
extra_body
Any
Optional
Default: null
logit_bias
Any
Optional
Default: null
max_tokens
Any
Optional
Default: null
modalities
Any
Optional
Default: null
moderation
Any
Optional
Default: null
prediction
Any
Optional
Default: null
extra_query
Any
Optional
Default: null
temperature
Any
Optional
Default: null
tool_choice
Any
Optional
Default: null
service_tier
Any
Optional
Default: null
top_logprobs
Any
Optional
Default: null
extra_headers
Any
Optional
Default: null
function_call
Any
Optional
Default: null
stream_options
Any
Optional
Default: null
response_format
Any
Optional
Default: null
presence_penalty
Any
Optional
Default: null
prompt_cache_key
Any
Optional
Default: null
reasoning_effort
Any
Optional
Default: null
frequency_penalty
Any
Optional
Default: null
safety_identifier
Any
Optional
Default: null
web_search_options
Any
Optional
Default: null
parallel_tool_calls
Any
Optional
Default: null
prompt_cache_options
Any
Optional
Default: null
max_completion_tokens
Any
Optional
Default: null
prompt_cache_retention
Any
Optional
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
openai_initRequired
__init__Attributes
Required
Default: null
api_key
typing.Union[str, typing.Callable[[], str], NoneType]
Optional
Default: null
project
str | None
Optional
Default: null
timeout
Any
Optional
Default: null
base_url
Any
Optional
Default: null
provider
Any
Optional
Default: null
http_client
Any
Optional
Default: null
max_retries
int
Optional
Default: 2
organization
str | None
Optional
Default: null
admin_api_key
str | None
Optional
Default: null
default_query
typing.Optional[typing.Mapping[str, object]]
Optional
Default: null
webhook_secret
str | None
Optional
Default: null
default_headers
typing.Optional[typing.Mapping[str, str]]
Optional
Default: null
workload_identity
Any
Optional
Default: null
websocket_base_url
Any
Optional
Default: null

Configuration example

Example from the Python docstring:

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: OpenAIChatWrapper
  class_name: OpenAIChatWrapper
  template_input: InputTemplate
  attributes:
    model: gpt-4o
    openai_init:
      api_key: openai_api_key
      max_retries: 2
    create:
      max_tokens: 1000
      top_p: 3
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "OpenAIChatWrapper"
    class_name: "OpenAIChatWrapper"
    attributes:
      model: "<required>"
      create:
        n: null
        seed: null
        stop: null
        user: null
        store: null
        tools: null
        top_p: null
        stream: null
        timeout: null
        logprobs: null
        metadata: null
        functions: null
        verbosity: null
        extra_body: null
        logit_bias: null
        max_tokens: null
        modalities: null
        moderation: null
        prediction: null
        extra_query: null
        temperature: null
        tool_choice: null
        service_tier: null
        top_logprobs: null
        extra_headers: null
        function_call: null
        stream_options: null
        response_format: null
        presence_penalty: null
        prompt_cache_key: null
        reasoning_effort: null
        frequency_penalty: null
        safety_identifier: null
        web_search_options: null
        parallel_tool_calls: null
        prompt_cache_options: null
        max_completion_tokens: null
        prompt_cache_retention: null
      openai_init:
        api_key: null
        project: null
        timeout: null
        base_url: null
        provider: null
        http_client: null
        max_retries: 2
        organization: null
        admin_api_key: null
        default_query: null
        webhook_secret: null
        default_headers: null
        workload_identity: null
        websocket_base_url: null

Inheritance

Immediate parent: sinapsis_openai.templates.openai_chat.OpenAIChatCompletion

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere