openaivec 0.10.0__py3-none-any.whl → 1.0.10__py3-none-any.whl

openaivec/task/customer_support/inquiry_summary.py

@@ -6,31 +6,31 @@ and management reporting.
 
 Example:
     Basic usage with BatchResponses:
-    
+
     ```python
     from openai import OpenAI
-    from openaivec.responses import BatchResponses
+    from openaivec import BatchResponses
     from openaivec.task import customer_support
-    
+
     client = OpenAI()
     summarizer = BatchResponses.of_task(
         client=client,
-        model_name="gpt-4o-mini",
+        model_name="gpt-4.1-mini",
         task=customer_support.INQUIRY_SUMMARY
     )
-    
+
     inquiries = [
-        '''Hi there, I've been having trouble with my account for the past week. 
-        Every time I try to log in, it says my password is incorrect, but I'm sure 
-        it's right. I tried resetting it twice but the email never arrives. 
+        '''Hi there, I've been having trouble with my account for the past week.
+        Every time I try to log in, it says my password is incorrect, but I'm sure
+        it's right. I tried resetting it twice but the email never arrives.
         I'm getting really frustrated because I need to access my files for work tomorrow.''',
-        
-        '''I love your product! It's been incredibly helpful for my team. 
-        However, I was wondering if there's any way to get more storage space? 
+
+        '''I love your product! It's been incredibly helpful for my team.
+        However, I was wondering if there's any way to get more storage space?
         We're running out and would like to upgrade our plan.'''
     ]
     summaries = summarizer.parse(inquiries)
-    
+
     for summary in summaries:
         print(f"Summary: {summary.summary}")
         print(f"Issue: {summary.main_issue}")
@@ -39,30 +39,31 @@ Example:
     ```
 
     With pandas integration:
-    
+
     ```python
     import pandas as pd
     from openaivec import pandas_ext  # Required for .ai accessor
     from openaivec.task import customer_support
-    
+
     df = pd.DataFrame({"inquiry": [long_inquiry_text]})
     df["summary"] = df["inquiry"].ai.task(customer_support.INQUIRY_SUMMARY)
-    
+
     # Extract summary components
     extracted_df = df.ai.extract("summary")
     print(extracted_df[["inquiry", "summary_main_issue", "summary_resolution_status"]])
     ```
 
 Attributes:
-    INQUIRY_SUMMARY (PreparedTask): A prepared task instance 
-        configured for inquiry summarization with temperature=0.0 and 
+    INQUIRY_SUMMARY (PreparedTask): A prepared task instance
+        configured for inquiry summarization with temperature=0.0 and
         top_p=1.0 for deterministic output.
 """
 
-from typing import List, Literal
+from typing import Literal
+
 from pydantic import BaseModel, Field
 
-from ..model import PreparedTask
+from openaivec._model import PreparedTask
 
 __all__ = ["inquiry_summary"]
 
@@ -70,13 +71,15 @@ __all__ = ["inquiry_summary"]
 class InquirySummary(BaseModel):
     summary: str = Field(description="Concise summary of the customer inquiry (2-3 sentences)")
     main_issue: str = Field(description="Primary problem or request being addressed")
-    secondary_issues: List[str] = Field(description="Additional issues mentioned in the inquiry")
+    secondary_issues: list[str] = Field(description="Additional issues mentioned in the inquiry")
     customer_background: str = Field(description="Relevant customer context or history mentioned")
-    actions_taken: List[str] = Field(description="Steps the customer has already attempted")
+    actions_taken: list[str] = Field(description="Steps the customer has already attempted")
     timeline: str = Field(description="Timeline of events or when the issue started")
     impact_description: str = Field(description="How the issue affects the customer")
-    resolution_status: Literal["not_started", "in_progress", "needs_escalation", "resolved"] = Field(description="Current status (not_started, in_progress, needs_escalation, resolved)")
-    key_details: List[str] = Field(description="Important technical details, error messages, or specifics")
+    resolution_status: Literal["not_started", "in_progress", "needs_escalation", "resolved"] = Field(
+        description="Current status (not_started, in_progress, needs_escalation, resolved)"
+    )
+    key_details: list[str] = Field(description="Important technical details, error messages, or specifics")
     follow_up_needed: bool = Field(description="Whether follow-up communication is required")
     summary_confidence: float = Field(description="Confidence in summary accuracy (0.0-1.0)")
 
@@ -84,34 +87,31 @@ class InquirySummary(BaseModel):
 def inquiry_summary(
     summary_length: str = "concise",
     business_context: str = "general customer support",
-    temperature: float = 0.0,
-    top_p: float = 1.0
 ) -> PreparedTask:
     """Create a configurable inquiry summary task.
-    
+
     Args:
-        summary_length: Length of summary (concise, detailed, bullet_points).
-        business_context: Business context for summary.
-        temperature: Sampling temperature (0.0-1.0).
-        top_p: Nucleus sampling parameter (0.0-1.0).
-        
+        summary_length (str): Length of summary (concise, detailed, bullet_points).
+        business_context (str): Business context for summary.
+
     Returns:
         PreparedTask configured for inquiry summarization.
     """
-    
+
     length_instructions = {
         "concise": "Write a concise 2-3 sentence summary that captures the essence of the inquiry",
         "detailed": "Write a detailed 4-6 sentence summary that includes comprehensive context",
-        "bullet_points": "Create a bullet-point summary with key facts and actions"
+        "bullet_points": "Create a bullet-point summary with key facts and actions",
     }
-    
-    instructions = f"""Create a comprehensive summary of the customer inquiry that captures all essential information for support agents and management.
+
+    instructions = f"""Create a comprehensive summary of the customer inquiry that captures all
+essential information for support agents and management.
 
 Business Context: {business_context}
-Summary Style: {length_instructions.get(summary_length, length_instructions['concise'])}
+Summary Style: {length_instructions.get(summary_length, length_instructions["concise"])}
 
 Summary Guidelines:
-1. {length_instructions.get(summary_length, length_instructions['concise'])}
+1. {length_instructions.get(summary_length, length_instructions["concise"])}
 2. Identify the primary issue or request clearly
 3. Note any secondary issues that may need attention
 4. Extract relevant customer background or context
@@ -151,17 +151,16 @@ Focus on:
 - Clear distinction between symptoms and root causes
 - Relevant background without unnecessary details
 
-IMPORTANT: Provide summary responses in the same language as the input text, except for the predefined categorical field (resolution_status) which must use the exact English values specified above (not_started, in_progress, needs_escalation, resolved). For example, if the input is in German, provide all summary content in German, but use English values like "in_progress" for resolution_status.
+IMPORTANT: Provide summary responses in the same language as the input text, except for the
+predefined categorical field (resolution_status) which must use the exact English values
+specified above (not_started, in_progress, needs_escalation, resolved). For example, if the
+input is in German, provide all summary content in German, but use English values like
+"in_progress" for resolution_status.
 
 Provide accurate, actionable summary that enables efficient support resolution."""
 
-    return PreparedTask(
-        instructions=instructions,
-        response_format=InquirySummary,
-        temperature=temperature,
-        top_p=top_p
-    )
+    return PreparedTask(instructions=instructions, response_format=InquirySummary)
 
 
 # Backward compatibility - default configuration
-INQUIRY_SUMMARY = inquiry_summary()
+INQUIRY_SUMMARY = inquiry_summary()

openaivec/task/customer_support/intent_analysis.py

@@ -5,26 +5,26 @@ what the customer is trying to achieve and how to best assist them.
 
 Example:
     Basic usage with BatchResponses:
-    
+
     ```python
     from openai import OpenAI
-    from openaivec.responses import BatchResponses
+    from openaivec import BatchResponses
     from openaivec.task import customer_support
-    
+
     client = OpenAI()
     analyzer = BatchResponses.of_task(
         client=client,
-        model_name="gpt-4o-mini",
+        model_name="gpt-4.1-mini",
         task=customer_support.INTENT_ANALYSIS
     )
-    
+
     inquiries = [
         "I want to upgrade my plan to get more storage",
         "How do I delete my account? I'm not satisfied with the service",
         "Can you walk me through setting up the mobile app?"
     ]
     intents = analyzer.parse(inquiries)
-    
+
     for intent in intents:
         print(f"Primary Intent: {intent.primary_intent}")
         print(f"Action Required: {intent.action_required}")
@@ -33,67 +33,83 @@ Example:
     ```
 
     With pandas integration:
-    
+
     ```python
     import pandas as pd
     from openaivec import pandas_ext  # Required for .ai accessor
     from openaivec.task import customer_support
-    
+
     df = pd.DataFrame({"inquiry": [
         "I want to upgrade my plan to get more storage",
         "How do I delete my account? I'm not satisfied with the service",
         "Can you walk me through setting up the mobile app?"
     ]})
     df["intent"] = df["inquiry"].ai.task(customer_support.INTENT_ANALYSIS)
-    
+
     # Extract intent components
     extracted_df = df.ai.extract("intent")
     print(extracted_df[["inquiry", "intent_primary_intent", "intent_action_required", "intent_success_likelihood"]])
     ```
 
 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 List, Literal
+from typing import Literal
+
 from pydantic import BaseModel, Field
 
-from ..model import PreparedTask
+from openaivec._model import PreparedTask
 
 __all__ = ["intent_analysis"]
 
 
 class IntentAnalysis(BaseModel):
-    primary_intent: Literal["get_help", "make_purchase", "cancel_service", "get_refund", "report_issue", "seek_information", "request_feature", "provide_feedback"] = Field(description="Primary customer intent (get_help, make_purchase, cancel_service, get_refund, report_issue, seek_information, request_feature, provide_feedback)")
-    secondary_intents: List[str] = Field(description="Additional intents if multiple goals are present")
-    action_required: Literal["provide_information", "troubleshoot", "process_request", "escalate", "redirect", "schedule_callback"] = Field(description="Required action (provide_information, troubleshoot, process_request, escalate, redirect, schedule_callback)")
+    primary_intent: Literal[
+        "get_help",
+        "make_purchase",
+        "cancel_service",
+        "get_refund",
+        "report_issue",
+        "seek_information",
+        "request_feature",
+        "provide_feedback",
+    ] = Field(
+        description="Primary customer intent (get_help, make_purchase, cancel_service, "
+        "get_refund, report_issue, seek_information, request_feature, provide_feedback)"
+    )
+    secondary_intents: list[str] = Field(description="Additional intents if multiple goals are present")
+    action_required: Literal[
+        "provide_information", "troubleshoot", "process_request", "escalate", "redirect", "schedule_callback"
+    ] = Field(
+        description="Required action (provide_information, troubleshoot, process_request, "
+        "escalate, redirect, schedule_callback)"
+    )
     intent_confidence: float = Field(description="Confidence in intent detection (0.0-1.0)")
-    success_likelihood: Literal["very_high", "high", "medium", "low", "very_low"] = Field(description="Likelihood of successful resolution (very_high, high, medium, low, very_low)")
+    success_likelihood: Literal["very_high", "high", "medium", "low", "very_low"] = Field(
+        description="Likelihood of successful resolution (very_high, high, medium, low, very_low)"
+    )
     customer_goal: str = Field(description="What the customer ultimately wants to achieve")
-    implicit_needs: List[str] = Field(description="Unstated needs or concerns that may need addressing")
-    blocking_factors: List[str] = Field(description="Potential obstacles to achieving customer goal")
-    next_steps: List[str] = Field(description="Recommended next steps to address customer intent")
-    resolution_complexity: Literal["simple", "moderate", "complex", "very_complex"] = Field(description="Complexity of resolution (simple, moderate, complex, very_complex)")
+    implicit_needs: list[str] = Field(description="Unstated needs or concerns that may need addressing")
+    blocking_factors: list[str] = Field(description="Potential obstacles to achieving customer goal")
+    next_steps: list[str] = Field(description="Recommended next steps to address customer intent")
+    resolution_complexity: Literal["simple", "moderate", "complex", "very_complex"] = Field(
+        description="Complexity of resolution (simple, moderate, complex, very_complex)"
+    )
 
 
-def intent_analysis(
-    business_context: str = "general customer support",
-    temperature: float = 0.0,
-    top_p: float = 1.0
-) -> PreparedTask:
+def intent_analysis(business_context: str = "general customer support") -> PreparedTask:
     """Create a configurable intent analysis task.
-    
+
     Args:
-        business_context: Business context for intent analysis.
-        temperature: Sampling temperature (0.0-1.0).
-        top_p: Nucleus sampling parameter (0.0-1.0).
-        
+        business_context (str): Business context for intent analysis.
+
     Returns:
         PreparedTask configured for intent analysis.
     """
-    
+
     instructions = f"""Analyze customer intent to understand their goals, needs, and how to best assist them.
 
 Business Context: {business_context}
@@ -143,17 +159,16 @@ Pay attention to:
 - Urgency indicators: Time pressure affects resolution approach
 - Previous interactions: References to prior support contacts
 
-IMPORTANT: Provide analysis responses in the same language as the input text, except for the predefined categorical fields (primary_intent, action_required, success_likelihood, resolution_complexity) which must use the exact English values specified above. For example, if the input is in Japanese, provide customer_goal, implicit_needs, blocking_factors, next_steps, and reasoning in Japanese, but use English values like "get_help" for primary_intent.
+IMPORTANT: Provide analysis responses in the same language as the input text, except for the
+predefined categorical fields (primary_intent, action_required, success_likelihood,
+resolution_complexity) which must use the exact English values specified above. For example,
+if the input is in Japanese, provide customer_goal, implicit_needs, blocking_factors,
+next_steps, and reasoning in Japanese, but use English values like "get_help" for primary_intent.
 
 Provide comprehensive intent analysis with actionable recommendations."""
 
-    return PreparedTask(
-        instructions=instructions,
-        response_format=IntentAnalysis,
-        temperature=temperature,
-        top_p=top_p
-    )
+    return PreparedTask(instructions=instructions, response_format=IntentAnalysis)
 
 
 # Backward compatibility - default configuration
-INTENT_ANALYSIS = intent_analysis()
+INTENT_ANALYSIS = intent_analysis()

openaivec/task/customer_support/response_suggestion.py

@@ -6,26 +6,26 @@ and professional communication.
 
 Example:
     Basic usage with BatchResponses:
-    
+
     ```python
     from openai import OpenAI
-    from openaivec.responses import BatchResponses
+    from openaivec import BatchResponses
     from openaivec.task import customer_support
-    
+
     client = OpenAI()
     responder = BatchResponses.of_task(
         client=client,
-        model_name="gpt-4o-mini",
+        model_name="gpt-4.1-mini",
         task=customer_support.RESPONSE_SUGGESTION
     )
-    
+
     inquiries = [
         "I can't access my account. I've tried resetting my password but the email never arrives.",
         "I'm really disappointed with your service. This is the third time I've had issues.",
         "Thank you for your help yesterday! The problem is now resolved."
     ]
     responses = responder.parse(inquiries)
-    
+
     for response in responses:
         print(f"Suggested Response: {response.suggested_response}")
         print(f"Tone: {response.tone}")
@@ -34,48 +34,57 @@ Example:
     ```
 
     With pandas integration:
-    
+
     ```python
     import pandas as pd
     from openaivec import pandas_ext  # Required for .ai accessor
     from openaivec.task import customer_support
-    
+
     df = pd.DataFrame({"inquiry": [
         "I can't access my account. I've tried resetting my password but the email never arrives.",
         "I'm really disappointed with your service. This is the third time I've had issues."
     ]})
     df["response"] = df["inquiry"].ai.task(customer_support.RESPONSE_SUGGESTION)
-    
+
     # Extract response components
     extracted_df = df.ai.extract("response")
     print(extracted_df[["inquiry", "response_suggested_response", "response_tone", "response_priority"]])
     ```
 
 Attributes:
-    RESPONSE_SUGGESTION (PreparedTask): A prepared task instance 
-        configured for response suggestion with temperature=0.0 and 
+    RESPONSE_SUGGESTION (PreparedTask): A prepared task instance
+        configured for response suggestion with temperature=0.0 and
         top_p=1.0 for deterministic output.
 """
 
-from typing import List, Literal
+from typing import Literal
+
 from pydantic import BaseModel, Field
 
-from ..model import PreparedTask
+from openaivec._model import PreparedTask
 
 __all__ = ["response_suggestion"]
 
 
 class ResponseSuggestion(BaseModel):
     suggested_response: str = Field(description="Professional response draft for the customer inquiry")
-    tone: Literal["empathetic", "professional", "friendly", "apologetic", "solution_focused"] = Field(description="Recommended tone (empathetic, professional, friendly, apologetic, solution_focused)")
-    priority: Literal["immediate", "high", "medium", "low"] = Field(description="Response priority (immediate, high, medium, low)")
-    response_type: Literal["acknowledgment", "solution", "escalation", "information_request", "closure"] = Field(description="Type of response (acknowledgment, solution, escalation, information_request, closure)")
-    key_points: List[str] = Field(description="Main points that must be addressed in the response")
+    tone: Literal["empathetic", "professional", "friendly", "apologetic", "solution_focused"] = Field(
+        description="Recommended tone (empathetic, professional, friendly, apologetic, solution_focused)"
+    )
+    priority: Literal["immediate", "high", "medium", "low"] = Field(
+        description="Response priority (immediate, high, medium, low)"
+    )
+    response_type: Literal["acknowledgment", "solution", "escalation", "information_request", "closure"] = Field(
+        description="Type of response (acknowledgment, solution, escalation, information_request, closure)"
+    )
+    key_points: list[str] = Field(description="Main points that must be addressed in the response")
     follow_up_required: bool = Field(description="Whether follow-up communication is needed")
     escalation_suggested: bool = Field(description="Whether escalation to management is recommended")
-    resources_needed: List[str] = Field(description="Additional resources or information required")
-    estimated_resolution_time: Literal["immediate", "hours", "days", "weeks"] = Field(description="Estimated time to resolution (immediate, hours, days, weeks)")
-    alternative_responses: List[str] = Field(description="Alternative response options for different scenarios")
+    resources_needed: list[str] = Field(description="Additional resources or information required")
+    estimated_resolution_time: Literal["immediate", "hours", "days", "weeks"] = Field(
+        description="Estimated time to resolution (immediate, hours, days, weeks)"
+    )
+    alternative_responses: list[str] = Field(description="Alternative response options for different scenarios")
     personalization_notes: str = Field(description="Suggestions for personalizing the response")
 
 
@@ -83,34 +92,31 @@ def response_suggestion(
     response_style: str = "professional",
     company_name: str = "our company",
     business_context: str = "general customer support",
-    temperature: float = 0.0,
-    top_p: float = 1.0
 ) -> PreparedTask:
     """Create a configurable response suggestion task.
-    
+
     Args:
-        response_style: Style of response (professional, friendly, empathetic, formal).
-        company_name: Name of the company for personalization.
-        business_context: Business context for responses.
-        temperature: Sampling temperature (0.0-1.0).
-        top_p: Nucleus sampling parameter (0.0-1.0).
-        
+        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.
+
     Returns:
         PreparedTask configured for response suggestions.
     """
-    
+
     style_instructions = {
         "professional": "Maintain professional tone with clear, direct communication",
         "friendly": "Use warm, approachable language while remaining professional",
         "empathetic": "Show understanding and compassion for customer concerns",
-        "formal": "Use formal business language appropriate for official communications"
+        "formal": "Use formal business language appropriate for official communications",
     }
-    
-    instructions = f"""Generate a professional, helpful response suggestion for the customer inquiry that addresses their needs effectively.
+
+    instructions = f"""Generate a professional, helpful response suggestion for the customer
+inquiry that addresses their needs effectively.
 
 Business Context: {business_context}
 Company Name: {company_name}
-Response Style: {style_instructions.get(response_style, style_instructions['professional'])}
+Response Style: {style_instructions.get(response_style, style_instructions["professional"])}
 
 Response Guidelines:
 1. Address the customer's main concern directly
@@ -171,17 +177,17 @@ Avoid:
 - Dismissing customer concerns
 - Lengthy responses that don't address the main issue
 
-IMPORTANT: Generate responses in the same language as the input text, except for the predefined categorical fields (tone, priority, response_type, estimated_resolution_time) which must use the exact English values specified above. For example, if the input is in Italian, provide suggested_response, key_points, alternative_responses, and personalization_notes in Italian, but use English values like "empathetic" for tone.
+IMPORTANT: Generate responses in the same language as the input text, except for the predefined
+categorical fields (tone, priority, response_type, estimated_resolution_time) which must use
+the exact English values specified above. For example, if the input is in Italian, provide
+suggested_response, key_points, alternative_responses, and personalization_notes in Italian,
+but use English values like "empathetic" for tone.
 
-Generate helpful, professional response that moves toward resolution while maintaining positive customer relationship."""
+Generate helpful, professional response that moves toward resolution while maintaining
+positive customer relationship."""
 
-    return PreparedTask(
-        instructions=instructions,
-        response_format=ResponseSuggestion,
-        temperature=temperature,
-        top_p=top_p
-    )
+    return PreparedTask(instructions=instructions, response_format=ResponseSuggestion)
 
 
 # Backward compatibility - default configuration
-RESPONSE_SUGGESTION = response_suggestion()
+RESPONSE_SUGGESTION = response_suggestion()