openaivec 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

openaivec/_model.py

@@ -1,4 +1,4 @@
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from typing import Generic, TypeVar
 
 __all__ = [
@@ -12,19 +12,14 @@ ResponseFormat = TypeVar("ResponseFormat")
 class PreparedTask(Generic[ResponseFormat]):
     """A data class representing a complete task configuration for OpenAI API calls.
 
-    This class encapsulates all the necessary parameters for executing a task,
-    including the instructions to be sent to the model, the expected response
-    format using Pydantic models, and API parameters for controlling
-    the model's output behavior.
+    This class encapsulates the instructions and expected response format for
+    executing a task against the OpenAI Responses API.
 
     Attributes:
         instructions (str): The prompt or instructions to send to the OpenAI model.
             This should contain clear, specific directions for the task.
         response_format (type[ResponseFormat]): A Pydantic model class or str type that defines the expected
             structure of the response. Can be either a BaseModel subclass or str.
-        api_kwargs (dict[str, int | float | str | bool]): Additional OpenAI API parameters
-            such as temperature, top_p, frequency_penalty, presence_penalty, seed, etc.
-            Defaults to an empty dict.
 
     Example:
         Creating a custom task:
@@ -40,7 +35,6 @@ class PreparedTask(Generic[ResponseFormat]):
         custom_task = PreparedTask(
             instructions="Translate the following text to French:",
             response_format=TranslationResponse,
-            api_kwargs={"temperature": 0.1, "top_p": 0.9}
         )
         ```
 
@@ -51,7 +45,6 @@ class PreparedTask(Generic[ResponseFormat]):
 
     instructions: str
     response_format: type[ResponseFormat]
-    api_kwargs: dict[str, int | float | str | bool] = field(default_factory=dict)
 
 
 @dataclass(frozen=True)

openaivec/_responses.py

@@ -202,7 +202,12 @@ class BatchResponses(Generic[ResponseFormat]):
 
     @classmethod
     def of_task(
-        cls, client: OpenAI, model_name: str, task: PreparedTask[ResponseFormat], batch_size: int | None = None
+        cls,
+        client: OpenAI,
+        model_name: str,
+        task: PreparedTask[ResponseFormat],
+        batch_size: int | None = None,
+        **api_kwargs,
     ) -> "BatchResponses":
         """Factory from a PreparedTask.
 
@@ -212,6 +217,7 @@ class BatchResponses(Generic[ResponseFormat]):
             task (PreparedTask): Prepared task with instructions and response format.
             batch_size (int | None, optional): Max unique prompts per API call. Defaults to None
                 (automatic batch size optimization). Set to a positive integer for fixed batch size.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Returns:
             BatchResponses: Configured instance backed by a batching proxy.
@@ -222,7 +228,7 @@ class BatchResponses(Generic[ResponseFormat]):
             system_message=task.instructions,
             response_format=task.response_format,
             cache=BatchingMapProxy(batch_size=batch_size),
-            api_kwargs=task.api_kwargs,
+            api_kwargs=api_kwargs,
         )
 
     def __post_init__(self):
@@ -403,6 +409,7 @@ class AsyncBatchResponses(Generic[ResponseFormat]):
         task: PreparedTask[ResponseFormat],
         batch_size: int | None = None,
         max_concurrency: int = 8,
+        **api_kwargs,
     ) -> "AsyncBatchResponses":
         """Factory from a PreparedTask.
 
@@ -413,6 +420,7 @@ class AsyncBatchResponses(Generic[ResponseFormat]):
             batch_size (int | None, optional): Max unique prompts per API call. Defaults to None
                 (automatic batch size optimization). Set to a positive integer for fixed batch size.
             max_concurrency (int, optional): Max concurrent API calls. Defaults to 8.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Returns:
             AsyncBatchResponses: Configured instance backed by an async batching proxy.
@@ -423,7 +431,7 @@ class AsyncBatchResponses(Generic[ResponseFormat]):
             system_message=task.instructions,
             response_format=task.response_format,
             cache=AsyncBatchingMapProxy(batch_size=batch_size, max_concurrency=max_concurrency),
-            api_kwargs=task.api_kwargs,
+            api_kwargs=api_kwargs,
         )
 
     def __post_init__(self):

openaivec/_schema/infer.py

@@ -156,7 +156,6 @@ class SchemaInferenceOutput(BaseModel):
         return PreparedTask(
             instructions=self.inference_prompt,
             response_format=self.model,
-            api_kwargs={"top_p": None, "temperature": None},
         )
 
     def build_model(self) -> type[BaseModel]:

openaivec/pandas_ext.py

@@ -378,12 +378,13 @@ class OpenAIVecSeriesAccessor:
         self,
         task: PreparedTask[ResponseFormat],
         cache: BatchingMapProxy[str, ResponseFormat],
+        **api_kwargs,
     ) -> pd.Series:
         """Execute a prepared task on every Series element using a provided cache.
 
-        This mirrors ``responses_with_cache`` but uses the task's stored instructions,
-        response format, and API parameters. A supplied ``BatchingMapProxy`` enables
-        cross‑operation deduplicated reuse and external batch size / progress control.
+        This mirrors ``responses_with_cache`` but uses the task's stored instructions
+        and response format. A supplied ``BatchingMapProxy`` enables cross‑operation
+        deduplicated reuse and external batch size / progress control.
 
         Example:
             ```python
@@ -393,12 +394,13 @@ class OpenAIVecSeriesAccessor:
             ```
 
         Args:
-            task (PreparedTask): Prepared task (instructions + response_format + sampling params).
+            task (PreparedTask): Prepared task (instructions + response_format).
             cache (BatchingMapProxy[str, ResponseFormat]): Pre‑configured cache instance.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Note:
-            The task's stored API parameters are used. Core routing keys (``model``, system
-            instructions, user input) are managed internally and cannot be overridden.
+            Core routing keys (``model``, system instructions, user input) are managed
+            internally and cannot be overridden.
 
         Returns:
             pandas.Series: Task results aligned with the original Series index.
@@ -409,7 +411,7 @@ class OpenAIVecSeriesAccessor:
             system_message=task.instructions,
             response_format=task.response_format,
             cache=cache,
-            api_kwargs=task.api_kwargs,
+            api_kwargs=api_kwargs,
         )
         return pd.Series(client.parse(self._obj.tolist()), index=self._obj.index, name=self._obj.name)
 
@@ -418,6 +420,7 @@ class OpenAIVecSeriesAccessor:
         task: PreparedTask,
         batch_size: int | None = None,
         show_progress: bool = True,
+        **api_kwargs,
     ) -> pd.Series:
         """Execute a prepared task on every Series element.
 
@@ -443,16 +446,16 @@ class OpenAIVecSeriesAccessor:
 
         Args:
             task (PreparedTask): A pre-configured task containing instructions,
-                response format, and other parameters for processing the inputs.
+                response format for processing the inputs.
             batch_size (int | None, optional): Number of prompts grouped into a single
                 request to optimize API usage. Defaults to ``None`` (automatic batch size
                 optimization based on execution time). Set to a positive integer for fixed batch size.
             show_progress (bool, optional): Show progress bar in Jupyter notebooks. Defaults to ``True``.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Note:
-            The task's stored API parameters are used. Core batching / routing keys
-            (``model``, ``instructions`` / system message, user ``input``) are managed by the
-            library and cannot be overridden.
+            Core batching / routing keys (``model``, ``instructions`` / system message,
+            user ``input``) are managed by the library and cannot be overridden.
 
         Returns:
             pandas.Series: Series whose values are instances of the task's response format.
@@ -460,6 +463,7 @@ class OpenAIVecSeriesAccessor:
         return self.task_with_cache(
             task=task,
             cache=BatchingMapProxy(batch_size=batch_size, show_progress=show_progress),
+            **api_kwargs,
         )
 
     def parse_with_cache(
@@ -818,15 +822,17 @@ class OpenAIVecDataFrameAccessor:
         self,
         task: PreparedTask[ResponseFormat],
         cache: BatchingMapProxy[str, ResponseFormat],
+        **api_kwargs,
     ) -> pd.Series:
         """Execute a prepared task on each DataFrame row after serializing it to JSON using a provided cache.
 
         Args:
-            task (PreparedTask): Prepared task (instructions + response_format + sampling params).
+            task (PreparedTask): Prepared task (instructions + response_format).
             cache (BatchingMapProxy[str, ResponseFormat]): Pre‑configured cache instance.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Note:
-            The task's stored API parameters are used. Core routing keys are managed internally.
+            Core routing keys are managed internally.
 
         Returns:
             pandas.Series: Task results aligned with the DataFrame's original index.
@@ -834,6 +840,7 @@ class OpenAIVecDataFrameAccessor:
         return _df_rows_to_json_series(self._obj).ai.task_with_cache(
             task=task,
             cache=cache,
+            **api_kwargs,
         )
 
     def task(
@@ -841,6 +848,7 @@ class OpenAIVecDataFrameAccessor:
         task: PreparedTask,
         batch_size: int | None = None,
         show_progress: bool = True,
+        **api_kwargs,
     ) -> pd.Series:
         """Execute a prepared task on each DataFrame row after serializing it to JSON.
 
@@ -870,16 +878,16 @@ class OpenAIVecDataFrameAccessor:
 
         Args:
             task (PreparedTask): A pre-configured task containing instructions,
-                response format, and other parameters for processing the inputs.
+                response format for processing the inputs.
             batch_size (int | None, optional): Number of requests sent in one batch
                 to optimize API usage. Defaults to ``None`` (automatic batch size
                 optimization based on execution time). Set to a positive integer for fixed batch size.
             show_progress (bool, optional): Show progress bar in Jupyter notebooks. Defaults to ``True``.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Note:
-            The task's stored API parameters are used. Core batching / routing
-            keys (``model``, ``instructions`` / system message, user ``input``) are managed by the
-            library and cannot be overridden.
+            Core batching / routing keys (``model``, ``instructions`` / system message, user ``input``)
+            are managed by the library and cannot be overridden.
 
         Returns:
             pandas.Series: Series whose values are instances of the task's
@@ -889,6 +897,7 @@ class OpenAIVecDataFrameAccessor:
             task=task,
             batch_size=batch_size,
             show_progress=show_progress,
+            **api_kwargs,
         )
 
     def parse_with_cache(
@@ -1406,6 +1415,7 @@ class AsyncOpenAIVecSeriesAccessor:
         self,
         task: PreparedTask[ResponseFormat],
         cache: AsyncBatchingMapProxy[str, ResponseFormat],
+        **api_kwargs,
     ) -> pd.Series:
         """Execute a prepared task on every Series element using a provided cache (asynchronously).
 
@@ -1416,10 +1426,11 @@ class AsyncOpenAIVecSeriesAccessor:
 
         Args:
             task (PreparedTask): A pre-configured task containing instructions,
-                response format, and other parameters for processing the inputs.
+                response format for processing the inputs.
             cache (AsyncBatchingMapProxy[str, ResponseFormat]): Pre-configured cache
                 instance for managing API call batching and deduplication.
                 Set cache.batch_size=None to enable automatic batch size optimization.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Example:
             ```python
@@ -1456,7 +1467,7 @@ class AsyncOpenAIVecSeriesAccessor:
             system_message=task.instructions,
             response_format=task.response_format,
             cache=cache,
-            api_kwargs=task.api_kwargs,
+            api_kwargs=api_kwargs,
         )
         results = await client.parse(self._obj.tolist())
 
@@ -1468,6 +1479,7 @@ class AsyncOpenAIVecSeriesAccessor:
         batch_size: int | None = None,
         max_concurrency: int = 8,
         show_progress: bool = True,
+        **api_kwargs,
     ) -> pd.Series:
         """Execute a prepared task on every Series element (asynchronously).
 
@@ -1494,13 +1506,14 @@ class AsyncOpenAIVecSeriesAccessor:
 
         Args:
             task (PreparedTask): A pre-configured task containing instructions,
-                response format, and other parameters for processing the inputs.
+                response format for processing the inputs.
             batch_size (int | None, optional): Number of prompts grouped into a single
                 request to optimize API usage. Defaults to ``None`` (automatic batch size
                 optimization based on execution time). Set to a positive integer for fixed batch size.
             max_concurrency (int, optional): Maximum number of concurrent
                 requests. Defaults to 8.
             show_progress (bool, optional): Show progress bar in Jupyter notebooks. Defaults to ``True``.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Note:
             The task's stored API parameters are used. Core batching / routing
@@ -1519,6 +1532,7 @@ class AsyncOpenAIVecSeriesAccessor:
             cache=AsyncBatchingMapProxy(
                 batch_size=batch_size, max_concurrency=max_concurrency, show_progress=show_progress
             ),
+            **api_kwargs,
         )
 
     async def parse_with_cache(
@@ -1752,17 +1766,19 @@ class AsyncOpenAIVecDataFrameAccessor:
         self,
         task: PreparedTask[ResponseFormat],
         cache: AsyncBatchingMapProxy[str, ResponseFormat],
+        **api_kwargs,
     ) -> pd.Series:
         """Execute a prepared task on each DataFrame row using a provided cache (asynchronously).
 
         After serializing each row to JSON, this method executes the prepared task.
 
         Args:
-            task (PreparedTask): Prepared task (instructions + response_format + sampling params).
+            task (PreparedTask): Prepared task (instructions + response_format).
             cache (AsyncBatchingMapProxy[str, ResponseFormat]): Pre‑configured async cache instance.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Note:
-            The task's stored API parameters are used. Core routing keys are managed internally.
+            Core routing keys are managed internally.
 
         Returns:
             pandas.Series: Task results aligned with the DataFrame's original index.
@@ -1773,6 +1789,7 @@ class AsyncOpenAIVecDataFrameAccessor:
         return await _df_rows_to_json_series(self._obj).aio.task_with_cache(
             task=task,
             cache=cache,
+            **api_kwargs,
         )
 
     async def task(
@@ -1781,6 +1798,7 @@ class AsyncOpenAIVecDataFrameAccessor:
         batch_size: int | None = None,
         max_concurrency: int = 8,
         show_progress: bool = True,
+        **api_kwargs,
     ) -> pd.Series:
         """Execute a prepared task on each DataFrame row after serializing it to JSON (asynchronously).
 
@@ -1811,18 +1829,18 @@ class AsyncOpenAIVecDataFrameAccessor:
 
         Args:
             task (PreparedTask): A pre-configured task containing instructions,
-                response format, and other parameters for processing the inputs.
+                response format for processing the inputs.
             batch_size (int | None, optional): Number of requests sent in one batch
                 to optimize API usage. Defaults to ``None`` (automatic batch size
                 optimization based on execution time). Set to a positive integer for fixed batch size.
             max_concurrency (int, optional): Maximum number of concurrent
                 requests. Defaults to 8.
             show_progress (bool, optional): Show progress bar in Jupyter notebooks. Defaults to ``True``.
+            **api_kwargs: Additional OpenAI API parameters forwarded to the Responses API.
 
         Note:
-            The task's stored API parameters are used. Core batching / routing
-            keys (``model``, ``instructions`` / system message, user ``input``) are managed by the
-            library and cannot be overridden.
+            Core batching / routing keys (``model``, ``instructions`` / system message, user ``input``)
+            are managed by the library and cannot be overridden.
 
         Returns:
             pandas.Series: Series whose values are instances of the task's
@@ -1837,6 +1855,7 @@ class AsyncOpenAIVecDataFrameAccessor:
             batch_size=batch_size,
             max_concurrency=max_concurrency,
             show_progress=show_progress,
+            **api_kwargs,
         )
 
     async def parse_with_cache(

openaivec/spark.py

@@ -503,8 +503,8 @@ def task_udf(
     datasets with overlapping content.
 
     Args:
-        task (PreparedTask): A predefined task configuration containing instructions,
-            response format, and API parameters.
+        task (PreparedTask): A predefined task configuration containing instructions
+            and response format.
         model_name (str | None): For Azure OpenAI, use your deployment name (e.g., "my-gpt4-deployment").
             For OpenAI, use the model name (e.g., "gpt-4.1-mini"). Defaults to configured model in DI container
             via ResponsesModelName if not provided.
@@ -522,7 +522,7 @@ def task_udf(
         Arbitrary OpenAI Responses API parameters (e.g. ``temperature``, ``top_p``,
         ``frequency_penalty``, ``presence_penalty``, ``seed``, ``max_output_tokens``, etc.)
         are forwarded verbatim to the underlying API calls. These parameters are applied to
-        all API requests made by the UDF and override any parameters set in the task configuration.
+        all API requests made by the UDF.
 
     Returns:
         UserDefinedFunction: A Spark pandas UDF configured to execute the specified task
@@ -543,16 +543,13 @@ def task_udf(
         **Automatic Caching**: Duplicate inputs within each partition are cached,
         reducing API calls and costs significantly on datasets with repeated content.
     """
-    # Merge task's api_kwargs with caller's api_kwargs (caller takes precedence)
-    merged_kwargs = {**task.api_kwargs, **api_kwargs}
-
     return responses_udf(
         instructions=task.instructions,
         response_format=task.response_format,
         model_name=model_name,
         batch_size=batch_size,
         max_concurrency=max_concurrency,
-        **merged_kwargs,
+        **api_kwargs,
     )
 
 

openaivec/task/customer_support/customer_sentiment.py

@@ -95,12 +95,11 @@ class CustomerSentiment(BaseModel):
     )
 
 
-def customer_sentiment(business_context: str = "general customer support", **api_kwargs) -> PreparedTask:
+def customer_sentiment(business_context: str = "general customer support") -> PreparedTask:
     """Create a configurable customer sentiment analysis task.
 
     Args:
         business_context (str): Business context for sentiment analysis.
-        **api_kwargs: Additional OpenAI API parameters (temperature, top_p, etc.).
 
     Returns:
         PreparedTask configured for customer sentiment analysis.
@@ -166,8 +165,8 @@ values like "positive" for sentiment.
 
 Provide comprehensive sentiment analysis with business context and recommended response strategy."""
 
-    return PreparedTask(instructions=instructions, response_format=CustomerSentiment, api_kwargs=api_kwargs)
+    return PreparedTask(instructions=instructions, response_format=CustomerSentiment)
 
 
 # Backward compatibility - default configuration
-CUSTOMER_SENTIMENT = customer_sentiment(temperature=0.0, top_p=1.0)
+CUSTOMER_SENTIMENT = customer_sentiment()

openaivec/task/customer_support/inquiry_classification.py

@@ -119,7 +119,6 @@ def inquiry_classification(
     priority_rules: Dict[str, str] | None = None,
     business_context: str = "general customer support",
     custom_keywords: Dict[str, list[str]] | None = None,
-    **api_kwargs,
 ) -> PreparedTask:
     """Create a configurable inquiry classification task.
 
@@ -132,8 +131,6 @@ def inquiry_classification(
             Default uses standard priority indicators.
         business_context (str): Description of the business context to help with classification.
         custom_keywords (dict[str, list[str]] | None): Dictionary mapping categories to relevant keywords.
-        **api_kwargs: Additional keyword arguments to pass to the OpenAI API,
-            such as temperature, top_p, etc.
 
     Returns:
         PreparedTask configured for inquiry classification.
@@ -253,8 +250,8 @@ language where appropriate, but priority must use English values like "high".
 
 Provide accurate classification with detailed reasoning."""
 
-    return PreparedTask(instructions=instructions, response_format=InquiryClassification, api_kwargs=api_kwargs)
+    return PreparedTask(instructions=instructions, response_format=InquiryClassification)
 
 
 # Backward compatibility - default configuration
-INQUIRY_CLASSIFICATION = inquiry_classification(temperature=0.0, top_p=1.0)
+INQUIRY_CLASSIFICATION = inquiry_classification()

openaivec/task/customer_support/inquiry_summary.py

@@ -87,15 +87,12 @@ class InquirySummary(BaseModel):
 def inquiry_summary(
     summary_length: str = "concise",
     business_context: str = "general customer support",
-    **api_kwargs,
 ) -> PreparedTask:
     """Create a configurable inquiry summary task.
 
     Args:
         summary_length (str): Length of summary (concise, detailed, bullet_points).
         business_context (str): Business context for summary.
-        **api_kwargs: Additional keyword arguments to pass to the OpenAI API,
-            such as temperature, top_p, etc.
 
     Returns:
         PreparedTask configured for inquiry summarization.
@@ -162,8 +159,8 @@ input is in German, provide all summary content in German, but use English value
 
 Provide accurate, actionable summary that enables efficient support resolution."""
 
-    return PreparedTask(instructions=instructions, response_format=InquirySummary, api_kwargs=api_kwargs)
+    return PreparedTask(instructions=instructions, response_format=InquirySummary)
 
 
 # Backward compatibility - default configuration
-INQUIRY_SUMMARY = inquiry_summary(temperature=0.0, top_p=1.0)
+INQUIRY_SUMMARY = inquiry_summary()

openaivec/task/customer_support/intent_analysis.py

@@ -52,9 +52,9 @@ Example:
     ```
 
 Attributes:
-    INTENT_ANALYSIS (PreparedTask): A prepared task instance
-        configured for intent analysis with temperature=0.0 and
-        top_p=1.0 for deterministic output.
+    INTENT_ANALYSIS (PreparedTask): A prepared task instance configured for intent
+        analysis. Provide ``temperature=0.0`` and ``top_p=1.0`` to your API calls
+        for deterministic output.
 """
 
 from typing import Literal
@@ -100,13 +100,11 @@ class IntentAnalysis(BaseModel):
     )
 
 
-def intent_analysis(business_context: str = "general customer support", **api_kwargs) -> PreparedTask:
+def intent_analysis(business_context: str = "general customer support") -> PreparedTask:
     """Create a configurable intent analysis task.
 
     Args:
         business_context (str): Business context for intent analysis.
-        **api_kwargs: Additional keyword arguments to pass to the OpenAI API,
-            such as temperature, top_p, etc.
 
     Returns:
         PreparedTask configured for intent analysis.
@@ -169,8 +167,8 @@ next_steps, and reasoning in Japanese, but use English values like "get_help" fo
 
 Provide comprehensive intent analysis with actionable recommendations."""
 
-    return PreparedTask(instructions=instructions, response_format=IntentAnalysis, api_kwargs=api_kwargs)
+    return PreparedTask(instructions=instructions, response_format=IntentAnalysis)
 
 
 # Backward compatibility - default configuration
-INTENT_ANALYSIS = intent_analysis(temperature=0.0, top_p=1.0)
+INTENT_ANALYSIS = intent_analysis()

openaivec/task/customer_support/response_suggestion.py

@@ -92,7 +92,6 @@ def response_suggestion(
     response_style: str = "professional",
     company_name: str = "our company",
     business_context: str = "general customer support",
-    **api_kwargs,
 ) -> PreparedTask:
     """Create a configurable response suggestion task.
 
@@ -100,8 +99,6 @@ def response_suggestion(
         response_style (str): Style of response (professional, friendly, empathetic, formal).
         company_name (str): Name of the company for personalization.
         business_context (str): Business context for responses.
-        **api_kwargs: Additional keyword arguments to pass to the OpenAI API,
-            such as temperature, top_p, etc.
 
     Returns:
         PreparedTask configured for response suggestions.
@@ -189,8 +186,8 @@ but use English values like "empathetic" for tone.
 Generate helpful, professional response that moves toward resolution while maintaining
 positive customer relationship."""
 
-    return PreparedTask(instructions=instructions, response_format=ResponseSuggestion, api_kwargs=api_kwargs)
+    return PreparedTask(instructions=instructions, response_format=ResponseSuggestion)
 
 
 # Backward compatibility - default configuration
-RESPONSE_SUGGESTION = response_suggestion(temperature=0.0, top_p=1.0)
+RESPONSE_SUGGESTION = response_suggestion()

openaivec/task/customer_support/urgency_analysis.py

@@ -135,7 +135,6 @@ def urgency_analysis(
     business_context: str = "general customer support",
     business_hours: str = "24/7 support",
     sla_rules: Dict[str, str] | None = None,
-    **api_kwargs,
 ) -> PreparedTask:
     """Create a configurable urgency analysis task.
 
@@ -148,8 +147,6 @@ def urgency_analysis(
         business_context (str): Description of the business context.
         business_hours (str): Description of business hours for response time calculation.
         sla_rules (dict[str, str] | None): Dictionary mapping customer tiers to SLA requirements.
-        **api_kwargs: Additional keyword arguments to pass to the OpenAI API,
-            such as temperature, top_p, etc.
 
     Returns:
         PreparedTask configured for urgency analysis.
@@ -286,8 +283,8 @@ urgency_level.
 
 Provide detailed analysis with clear reasoning for urgency level and response time recommendations."""
 
-    return PreparedTask(instructions=instructions, response_format=UrgencyAnalysis, api_kwargs=api_kwargs)
+    return PreparedTask(instructions=instructions, response_format=UrgencyAnalysis)
 
 
 # Backward compatibility - default configuration
-URGENCY_ANALYSIS = urgency_analysis(temperature=0.0, top_p=1.0)
+URGENCY_ANALYSIS = urgency_analysis()

openaivec/task/nlp/dependency_parsing.py

@@ -43,9 +43,9 @@ Example:
     ```
 
 Attributes:
-    DEPENDENCY_PARSING (PreparedTask): A prepared task instance
-        configured for dependency parsing with temperature=0.0 and
-        top_p=1.0 for deterministic output.
+    DEPENDENCY_PARSING (PreparedTask): A prepared task instance configured for dependency
+        parsing. Provide ``temperature=0.0`` and ``top_p=1.0`` when calling the API for
+        deterministic output.
 """
 
 from pydantic import BaseModel, Field
@@ -75,5 +75,4 @@ DEPENDENCY_PARSING = PreparedTask(
     "relations between words, determine the root word, and provide a tree representation of the "
     "syntactic structure.",
     response_format=DependencyParsing,
-    api_kwargs={"temperature": 0.0, "top_p": 1.0},
 )

openaivec/task/nlp/keyword_extraction.py

@@ -45,9 +45,9 @@ Example:
     ```
 
 Attributes:
-    KEYWORD_EXTRACTION (PreparedTask): A prepared task instance
-        configured for keyword extraction with temperature=0.0 and
-        top_p=1.0 for deterministic output.
+    KEYWORD_EXTRACTION (PreparedTask): A prepared task instance configured for keyword
+        extraction. Provide ``temperature=0.0`` and ``top_p=1.0`` when calling the API
+        for deterministic output.
 """
 
 from pydantic import BaseModel, Field
@@ -75,5 +75,4 @@ KEYWORD_EXTRACTION = PreparedTask(
     instructions="Extract important keywords and phrases from the following text. Rank them "
     "by importance, provide frequency counts, identify main topics, and generate a brief summary.",
     response_format=KeywordExtraction,
-    api_kwargs={"temperature": 0.0, "top_p": 1.0},
 )

openaivec/task/nlp/morphological_analysis.py

@@ -44,9 +44,9 @@ Example:
     ```
 
 Attributes:
-    MORPHOLOGICAL_ANALYSIS (PreparedTask): A prepared task instance
-        configured for morphological analysis with temperature=0.0 and
-        top_p=1.0 for deterministic output.
+    MORPHOLOGICAL_ANALYSIS (PreparedTask): A prepared task instance configured
+        for morphological analysis. Provide ``temperature=0.0`` and ``top_p=1.0`` to
+        API calls for deterministic output.
 """
 
 from pydantic import BaseModel, Field
@@ -70,5 +70,4 @@ MORPHOLOGICAL_ANALYSIS = PreparedTask(
     "identify part-of-speech tags, provide lemmatized forms, and extract morphological features "
     "for each token.",
     response_format=MorphologicalAnalysis,
-    api_kwargs={"temperature": 0.0, "top_p": 1.0},
 )

openaivec/task/nlp/named_entity_recognition.py

@@ -43,9 +43,9 @@ Example:
     ```
 
 Attributes:
-    NAMED_ENTITY_RECOGNITION (PreparedTask): A prepared task instance
-        configured for named entity recognition with temperature=0.0 and
-        top_p=1.0 for deterministic output.
+    NAMED_ENTITY_RECOGNITION (PreparedTask): A prepared task instance configured for named
+        entity recognition. Provide ``temperature=0.0`` and ``top_p=1.0`` to API calls for
+        deterministic output.
 """
 
 from pydantic import BaseModel, Field
@@ -78,5 +78,4 @@ NAMED_ENTITY_RECOGNITION = PreparedTask(
     "organizations, locations, dates, money, percentages, and other miscellaneous entities "
     "with their positions and confidence scores.",
     response_format=NamedEntityRecognition,
-    api_kwargs={"temperature": 0.0, "top_p": 1.0},
 )

openaivec/task/nlp/sentiment_analysis.py

@@ -43,9 +43,9 @@ Example:
     ```
 
 Attributes:
-    SENTIMENT_ANALYSIS (PreparedTask): A prepared task instance
-        configured for sentiment analysis with temperature=0.0 and
-        top_p=1.0 for deterministic output.
+    SENTIMENT_ANALYSIS (PreparedTask): A prepared task instance configured for sentiment
+        analysis. Provide ``temperature=0.0`` and ``top_p=1.0`` to API calls for
+        deterministic output.
 """
 
 from typing import Literal
@@ -78,5 +78,4 @@ SENTIMENT_ANALYSIS = PreparedTask(
     "English values specified (positive/negative/neutral for sentiment, and "
     "joy/sadness/anger/fear/surprise/disgust for emotions).",
     response_format=SentimentAnalysis,
-    api_kwargs={"temperature": 0.0, "top_p": 1.0},
 )

openaivec/task/nlp/translation.py

@@ -49,8 +49,8 @@ Example:
 
 Attributes:
     MULTILINGUAL_TRANSLATION (PreparedTask): A prepared task instance configured
-        for multilingual translation with temperature=0.0 and top_p=1.0 for
-        deterministic output.
+        for multilingual translation. Provide ``temperature=0.0`` and ``top_p=1.0``
+        to the calling API wrapper for deterministic output.
 
 Note:
     The translation covers 58 languages across major language families. All field
@@ -156,6 +156,4 @@ class TranslatedString(BaseModel):
 
 instructions = "Translate the following text into multiple languages. "
 
-MULTILINGUAL_TRANSLATION = PreparedTask(
-    instructions=instructions, response_format=TranslatedString, api_kwargs={"temperature": 0.0, "top_p": 1.0}
-)
+MULTILINGUAL_TRANSLATION = PreparedTask(instructions=instructions, response_format=TranslatedString)

openaivec/task/table/fillna.py

@@ -125,7 +125,7 @@ class FillNaResponse(BaseModel):
     )
 
 
-def fillna(df: pd.DataFrame, target_column_name: str, max_examples: int = 500, **api_kwargs) -> PreparedTask:
+def fillna(df: pd.DataFrame, target_column_name: str, max_examples: int = 500) -> PreparedTask:
     """Create a prepared task for filling missing values in a DataFrame column.
 
     Analyzes the provided DataFrame to understand data patterns and creates
@@ -141,8 +141,6 @@ def fillna(df: pd.DataFrame, target_column_name: str, max_examples: int = 500, *
         max_examples (int): Maximum number of example rows to use for few-shot
             learning. Defaults to 500. Higher values provide more context
             but increase token usage and processing time.
-        **api_kwargs: Additional keyword arguments to pass to the OpenAI API,
-            such as temperature, top_p, etc.
 
     Returns:
         PreparedTask configured for missing value imputation with:
@@ -182,7 +180,4 @@ def fillna(df: pd.DataFrame, target_column_name: str, max_examples: int = 500, *
     if df[target_column_name].notna().sum() == 0:
         raise ValueError(f"Column '{target_column_name}' contains no non-null values for training examples.")
     instructions = get_instructions(df, target_column_name, max_examples)
-    # Set default values for deterministic results if not provided
-    if not api_kwargs:
-        api_kwargs = {"temperature": 0.0, "top_p": 1.0}
-    return PreparedTask(instructions=instructions, response_format=FillNaResponse, api_kwargs=api_kwargs)
+    return PreparedTask(instructions=instructions, response_format=FillNaResponse)

{openaivec-1.0.3.dist-info → openaivec-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openaivec
-Version: 1.0.3
+Version: 1.0.5
 Summary: Generative mutation for tabular calculation
 Project-URL: Homepage, https://microsoft.github.io/openaivec/
 Project-URL: Repository, https://github.com/microsoft/openaivec
@@ -76,7 +76,7 @@ Simple task benchmark from [benchmark.ipynb](https://github.com/microsoft/openai
 
 Batching alone removes most HTTP overhead, and letting batching overlap with concurrency cuts total runtime to a few seconds while still yielding one output per input.
 
-![Benchmark comparison for simple task](https://private-user-images.githubusercontent.com/6128022/519474214-d1931e34-6f9e-4695-8042-88b771e002c3.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NjQyMDc5ODAsIm5iZiI6MTc2NDIwNzY4MCwicGF0aCI6Ii82MTI4MDIyLzUxOTQ3NDIxNC1kMTkzMWUzNC02ZjllLTQ2OTUtODA0Mi04OGI3NzFlMDAyYzMucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MTEyNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTExMjdUMDE0MTIwWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9Y2JhYmU2YjZhNDUxNDkxZDg5NGMxZGI1OTUzODgyYjQ4OTVhYzEzZjU3NmRkMjE1M2Y1ZDI3ZTdiNWI0M2VlMCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.yuxT4AbDIBNsRGCIxPMjpGiHFqLcQUCLg_DjpqH02Lw)
+<img alt="image" src="https://github.com/user-attachments/assets/8ace9bcd-bcae-4023-a37e-13082cd645e5" />
 
 ## Contents
 
@@ -215,8 +215,14 @@ text_df = pd.DataFrame({
 })
 
 results = text_df.assign(
-    sentiment=lambda df: df.text.ai.task(nlp.SENTIMENT_ANALYSIS),
-    intent=lambda df: df.text.ai.task(customer_support.INTENT_ANALYSIS),
+    sentiment=lambda df: df.text.ai.task(
+        nlp.SENTIMENT_ANALYSIS,
+        reasoning={"effort": "none"},
+    ),
+    intent=lambda df: df.text.ai.task(
+        customer_support.INTENT_ANALYSIS,
+        reasoning={"effort": "none"},
+    ),
 )
 
 # Extract structured results into separate columns

openaivec-1.0.5.dist-info/RECORD

@@ -0,0 +1,39 @@
+openaivec/__init__.py,sha256=0RsOGIt4TMgPdjppWiz89W1gb1X4qM-4nWqFFi-eK8w,555
+openaivec/_di.py,sha256=Cl1ZoNBlQsJL1bpzoMDl08uT9pZFVSlqOdLbS3_MwPE,11462
+openaivec/_embeddings.py,sha256=2JWFUZdHR1dvPdWPT4nVSZo0_TAz4gr8oLR3EhhtUyE,8200
+openaivec/_log.py,sha256=LHNs6AbJzM4weaRARZFroigxR6D148d7WSIMLk1IhbU,1439
+openaivec/_model.py,sha256=ICu9T2puXBMIkTOZdO7XStHMdSSHe4LmLVovsNfXb64,2744
+openaivec/_prompt.py,sha256=_fPATuWKaAdFD48Kuu0UQorlChA9mNZCDJx88bu_BuY,20626
+openaivec/_provider.py,sha256=8z8gPYY5-Z7rzDlj_NC6hR__DUqVAH7VLHJn6LalzRg,6158
+openaivec/_responses.py,sha256=82P_iO3uB0IBL0BZY51ncR02lGxoVzLDjCybTvliMR8,20661
+openaivec/_serialize.py,sha256=u2Om94Sc_QgJkTlW2BAGw8wd6gYDhc6IRqvS-qevFSs,8399
+openaivec/_util.py,sha256=XfueAycVCQvgRLS7wF7e306b53lebORvZOBzbQjy4vE,6438
+openaivec/pandas_ext.py,sha256=_y48qlG-npZsCCJJL1yev-yEU1YBZT83EiVl-lH0__o,87305
+openaivec/spark.py,sha256=XosDAcbzhnaIGyHBJ-p_ZBVJALroOXOFTjWWNRpSG3o,35022
+openaivec/_cache/__init__.py,sha256=IYUH5GKsJXuCX-k3XtT259rEz49EZm9KW2TIOTGW4uQ,314
+openaivec/_cache/optimize.py,sha256=3nS8VehbS7iGC1tPDDQh-iAgyKHbVYmMbCRBWM77U_U,3827
+openaivec/_cache/proxy.py,sha256=aVjH_hmJIIso6SetV_-Ct3VaOSG-n9Dpil7TttnbYkE,30556
+openaivec/_schema/__init__.py,sha256=XUj3Jv6ZVDjyYzSmH6Q5lmDj-hBMfUg_eBNeZACXR6Q,368
+openaivec/_schema/infer.py,sha256=VyvORgmpkcPa8pITClOJYjNzF4VzgSWe_n-9kFJVUjE,15644
+openaivec/_schema/spec.py,sha256=7ZaC59w2Edemnao57XeZVO4qmSOA-Kus6TchZC3Dd5o,14821
+openaivec/task/__init__.py,sha256=E82gfwhLOn1S8rgNZZAci3-H7bDXdGFM-cl1fpeN7_o,6154
+openaivec/task/customer_support/__init__.py,sha256=KWfGyXPdZyfGdRH17x7hPpJJ1N2EP9PPhZx0fvBAwSI,884
+openaivec/task/customer_support/customer_sentiment.py,sha256=ixSIPKZkqAtp4h2SaCDItNT4WNWSbuWVv4CQEY2insg,7375
+openaivec/task/customer_support/inquiry_classification.py,sha256=O94-4csaqJmbpSOYX0Dvay6N3hbAbLhrWDRS-BG5qTM,9401
+openaivec/task/customer_support/inquiry_summary.py,sha256=MqdrVsS5TmcArtU_G_C-ETse93-LxjsRBXTiizha6xU,6695
+openaivec/task/customer_support/intent_analysis.py,sha256=fFvjfebe3luvshr9E63TSoKf5zgFeU3l2lSLBLOVOGM,7311
+openaivec/task/customer_support/response_suggestion.py,sha256=Ewi0C_ytzKOZdQMRzkuXTuT8epFfeCekmh_c7F7vkqE,8105
+openaivec/task/customer_support/urgency_analysis.py,sha256=tqQ4JvZpT4DN_A3Wn7DkLl1iwnRgV83yIICipQB-AqI,11330
+openaivec/task/nlp/__init__.py,sha256=QoQ0egEK9IEh5hdrE07rZ_KCmC0gy_2FPrWJYRWiipY,512
+openaivec/task/nlp/dependency_parsing.py,sha256=ijDXFRNC9h9Tn7kaDS9ecijdLkanoP-WIqA-QrtUFwY,2803
+openaivec/task/nlp/keyword_extraction.py,sha256=TGcW-wXJwnUNT2p_tGyapyDCgzCPKGYLc2iNYq9dN8o,2790
+openaivec/task/nlp/morphological_analysis.py,sha256=7mfpLPKnE5WWFKRwhpfh1PuvT-LcbRH7jiuUCLBcpYU,2379
+openaivec/task/nlp/named_entity_recognition.py,sha256=iGvN8Z5iYynyOWgsBMxy_ztoivYKRsw-sBR8_SuwUcM,3015
+openaivec/task/nlp/sentiment_analysis.py,sha256=P1AFazqmlE9Dy0OShNOXcY8X5rvsGg7X6CRysdqXORI,3063
+openaivec/task/nlp/translation.py,sha256=IgTy0PQZVF_Q6qis60STim7Vd7rYPVTfTfwP_U1kAKk,6603
+openaivec/task/table/__init__.py,sha256=kJz15WDJXjyC7UIHKBvlTRhCf347PCDMH5T5fONV2sU,83
+openaivec/task/table/fillna.py,sha256=nMlXvlUvyWgM9DxJDeRX3M37jxlqg0MgRet1Ds3ni5Y,6571
+openaivec-1.0.5.dist-info/METADATA,sha256=-XGbwIIKWWdBrnLJxTM2RzUM_DFRmjoFXpY3l2nF8eo,13878
+openaivec-1.0.5.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+openaivec-1.0.5.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
+openaivec-1.0.5.dist-info/RECORD,,

openaivec-1.0.3.dist-info/RECORD

@@ -1,39 +0,0 @@
-openaivec/__init__.py,sha256=0RsOGIt4TMgPdjppWiz89W1gb1X4qM-4nWqFFi-eK8w,555
-openaivec/_di.py,sha256=Cl1ZoNBlQsJL1bpzoMDl08uT9pZFVSlqOdLbS3_MwPE,11462
-openaivec/_embeddings.py,sha256=2JWFUZdHR1dvPdWPT4nVSZo0_TAz4gr8oLR3EhhtUyE,8200
-openaivec/_log.py,sha256=LHNs6AbJzM4weaRARZFroigxR6D148d7WSIMLk1IhbU,1439
-openaivec/_model.py,sha256=71oiENUKwpY58ilj1LE7fDOAhs7PUSiZRiUHKUIuu7Y,3235
-openaivec/_prompt.py,sha256=_fPATuWKaAdFD48Kuu0UQorlChA9mNZCDJx88bu_BuY,20626
-openaivec/_provider.py,sha256=8z8gPYY5-Z7rzDlj_NC6hR__DUqVAH7VLHJn6LalzRg,6158
-openaivec/_responses.py,sha256=Lb37ajlFQoVVac_p9oVf3scUDS3AI1ro4tRlk_UBqVg,20412
-openaivec/_serialize.py,sha256=u2Om94Sc_QgJkTlW2BAGw8wd6gYDhc6IRqvS-qevFSs,8399
-openaivec/_util.py,sha256=XfueAycVCQvgRLS7wF7e306b53lebORvZOBzbQjy4vE,6438
-openaivec/pandas_ext.py,sha256=XEmB08FS6lFtk6V7zzM4XHnzPkLCZ08OFFlkX-f0Oko,86730
-openaivec/spark.py,sha256=OsEuwRRBzNs8Zv-hwDDsXR7A-dqZT651sdRmGkziTOo,35236
-openaivec/_cache/__init__.py,sha256=IYUH5GKsJXuCX-k3XtT259rEz49EZm9KW2TIOTGW4uQ,314
-openaivec/_cache/optimize.py,sha256=3nS8VehbS7iGC1tPDDQh-iAgyKHbVYmMbCRBWM77U_U,3827
-openaivec/_cache/proxy.py,sha256=aVjH_hmJIIso6SetV_-Ct3VaOSG-n9Dpil7TttnbYkE,30556
-openaivec/_schema/__init__.py,sha256=XUj3Jv6ZVDjyYzSmH6Q5lmDj-hBMfUg_eBNeZACXR6Q,368
-openaivec/_schema/infer.py,sha256=gcrpw0OVJMWdmUlzimP-C14cuCAAOnHQd8-bUNR220o,15705
-openaivec/_schema/spec.py,sha256=7ZaC59w2Edemnao57XeZVO4qmSOA-Kus6TchZC3Dd5o,14821
-openaivec/task/__init__.py,sha256=E82gfwhLOn1S8rgNZZAci3-H7bDXdGFM-cl1fpeN7_o,6154
-openaivec/task/customer_support/__init__.py,sha256=KWfGyXPdZyfGdRH17x7hPpJJ1N2EP9PPhZx0fvBAwSI,884
-openaivec/task/customer_support/customer_sentiment.py,sha256=6-qbJB21p0SKzV2vsesVIF-uUU_YB-QjNFUNfMLepBA,7521
-openaivec/task/customer_support/inquiry_classification.py,sha256=wORsEUL7dQ_0Mz8TWC16m6BtAD1KAvr9LqN4Fmji7LM,9591
-openaivec/task/customer_support/inquiry_summary.py,sha256=hrGLku5YjCt4PMXTrOSiCEnx_XOeKW4o_sv8Ocrxt0I,6885
-openaivec/task/customer_support/intent_analysis.py,sha256=lOW7MLH20PnXHq2Dqt7pQ6xmNbb1QK6A0MtXImlHA48,7467
-openaivec/task/customer_support/response_suggestion.py,sha256=MMbeQytm7E13HYW4eMMrLpudM85JFfaPj7l94_wNp_0,8295
-openaivec/task/customer_support/urgency_analysis.py,sha256=3JMxw0quJ8gnWL8hAlOKX49uiv30qtogRdKxtT9lebU,11520
-openaivec/task/nlp/__init__.py,sha256=QoQ0egEK9IEh5hdrE07rZ_KCmC0gy_2FPrWJYRWiipY,512
-openaivec/task/nlp/dependency_parsing.py,sha256=N9c-HMdSebee4hbeNeACqGQHaBd6uw4K_4STbfoz_Sw,2821
-openaivec/task/nlp/keyword_extraction.py,sha256=ghijuMQbtlIp7kJdwOnFmTfVzj3rnmJa-_Yc9uWLa1E,2808
-openaivec/task/nlp/morphological_analysis.py,sha256=StCteMdWd49QjsZg4FDlzOO5SxdRqMx-A4r3pnOvZz8,2405
-openaivec/task/nlp/named_entity_recognition.py,sha256=0k2qQLG6L7s9lvpxzwB8csL88jqUKlOlEn2MCJ-oEVE,3041
-openaivec/task/nlp/sentiment_analysis.py,sha256=1igoAhns-VgsDE8XI47Dw-zeOcR5wEY9IFIp9LPTC_E,3089
-openaivec/task/nlp/translation.py,sha256=TtV7F6bmKPqLi3_Ok7GoOqT_GKJiemotVq-YEbKd6IA,6617
-openaivec/task/table/__init__.py,sha256=kJz15WDJXjyC7UIHKBvlTRhCf347PCDMH5T5fONV2sU,83
-openaivec/task/table/fillna.py,sha256=4j27fWT5IzOhQqCPwLhomjBOAWPBslyIBbBMspjqtbw,6877
-openaivec-1.0.3.dist-info/METADATA,sha256=p07OFXtO0GMy4uiWIs-XooTcpJr-SnFIvd9-4x2W9-8,14484
-openaivec-1.0.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-openaivec-1.0.3.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
-openaivec-1.0.3.dist-info/RECORD,,