OpenAIChatWrapper
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 setInstallation
Install the published package using pip or uv.
pip install sinapsis-openai==1.0.0uv pip install sinapsis-openai==1.0.0uv add sinapsis-openai==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
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
Required
Default: null
Required
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Required
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: 2
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Configuration example
Example from the Python docstring:
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: 3Show schema-based configuration skeleton
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
sinapsis_openai.templates.openai_chat.OpenAIChatCompletionEnvironment variables
Environment definitions belong to their canonical Python modules.