openaivec 0.14.0__tar.gz → 0.14.1__tar.gz

{openaivec-0.14.0 → openaivec-0.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openaivec
-Version: 0.14.0
+Version: 0.14.1
 Summary: Generative mutation for tabular calculation
 Project-URL: Homepage, https://microsoft.github.io/openaivec/
 Project-URL: Repository, https://github.com/microsoft/openaivec
@@ -98,7 +98,7 @@ survey_responses.assign(
 ).ai.extract("structured")  # Auto-expands to columns
 ```
 
-📓 **[See more examples →](https://microsoft.github.io/openaivec/examples/)**
+📓 **[See more examples →](https://microsoft.github.io/openaivec/examples/pandas/)**
 
 # Overview
 
@@ -746,7 +746,7 @@ uv run ruff check . --fix
 📓 **[Survey data transformation →](https://microsoft.github.io/openaivec/examples/survey_transformation/)** - Unstructured to structured data  
 📓 **[Asynchronous processing examples →](https://microsoft.github.io/openaivec/examples/aio/)** - High-performance async workflows  
 📓 **[Auto-generate FAQs from documents →](https://microsoft.github.io/openaivec/examples/generate_faq/)** - Create FAQs using AI  
-📓 **[All examples →](https://microsoft.github.io/openaivec/examples/)** - Complete collection of tutorials and use cases
+📓 **[All examples →](https://microsoft.github.io/openaivec/examples/pandas/)** - Complete collection of tutorials and use cases
 
 ## Community
 

{openaivec-0.14.0 → openaivec-0.14.1}/README.md

@@ -72,7 +72,7 @@ survey_responses.assign(
 ).ai.extract("structured")  # Auto-expands to columns
 ```
 
-📓 **[See more examples →](https://microsoft.github.io/openaivec/examples/)**
+📓 **[See more examples →](https://microsoft.github.io/openaivec/examples/pandas/)**
 
 # Overview
 
@@ -720,7 +720,7 @@ uv run ruff check . --fix
 📓 **[Survey data transformation →](https://microsoft.github.io/openaivec/examples/survey_transformation/)** - Unstructured to structured data  
 📓 **[Asynchronous processing examples →](https://microsoft.github.io/openaivec/examples/aio/)** - High-performance async workflows  
 📓 **[Auto-generate FAQs from documents →](https://microsoft.github.io/openaivec/examples/generate_faq/)** - Create FAQs using AI  
-📓 **[All examples →](https://microsoft.github.io/openaivec/examples/)** - Complete collection of tutorials and use cases
+📓 **[All examples →](https://microsoft.github.io/openaivec/examples/pandas/)** - Complete collection of tutorials and use cases
 
 ## Community
 

openaivec-0.14.1/docs/api/main.md

@@ -0,0 +1,19 @@
+# Main Package API
+
+The main `openaivec` package provides the core classes for AI-powered data processing.
+
+## Core Classes
+
+All core functionality is accessible through the main package imports:
+
+::: openaivec.BatchResponses
+
+::: openaivec.AsyncBatchResponses
+
+::: openaivec.BatchEmbeddings
+
+::: openaivec.AsyncBatchEmbeddings
+
+## Prompt Building
+
+::: openaivec.FewShotPromptBuilder

openaivec-0.14.1/docs/api/pandas_ext.md

@@ -0,0 +1,3 @@
+# Pandas Extension
+
+::: openaivec.pandas_ext

openaivec-0.14.1/docs/api/spark.md

@@ -0,0 +1,3 @@
+# Spark Extension
+
+::: openaivec.spark

openaivec-0.14.1/docs/api/task.md

@@ -0,0 +1,3 @@
+# Task Module
+
+::: openaivec.task

openaivec-0.14.1/docs/api/tasks/customer_support/customer_sentiment.md

@@ -0,0 +1,3 @@
+# Customer Sentiment Analysis
+
+::: openaivec.task.customer_support.customer_sentiment

openaivec-0.14.1/docs/api/tasks/customer_support/inquiry_classification.md

@@ -0,0 +1,3 @@
+# Inquiry Classification
+
+::: openaivec.task.customer_support.inquiry_classification

openaivec-0.14.1/docs/api/tasks/customer_support/inquiry_summary.md

@@ -0,0 +1,3 @@
+# Inquiry Summary
+
+::: openaivec.task.customer_support.inquiry_summary

openaivec-0.14.1/docs/api/tasks/customer_support/intent_analysis.md

@@ -0,0 +1,3 @@
+# Intent Analysis
+
+::: openaivec.task.customer_support.intent_analysis

openaivec-0.14.1/docs/api/tasks/customer_support/response_suggestion.md

@@ -0,0 +1,3 @@
+# Response Suggestion
+
+::: openaivec.task.customer_support.response_suggestion

openaivec-0.14.1/docs/api/tasks/customer_support/urgency_analysis.md

@@ -0,0 +1,3 @@
+# Urgency Analysis
+
+::: openaivec.task.customer_support.urgency_analysis

openaivec-0.14.1/docs/api/tasks/nlp/dependency_parsing.md

@@ -0,0 +1,3 @@
+# Dependency Parsing Task
+
+::: openaivec.task.nlp.dependency_parsing

openaivec-0.14.1/docs/api/tasks/nlp/keyword_extraction.md

@@ -0,0 +1,3 @@
+# Keyword Extraction Task
+
+::: openaivec.task.nlp.keyword_extraction

openaivec-0.14.1/docs/api/tasks/nlp/morphological_analysis.md

@@ -0,0 +1,3 @@
+# Morphological Analysis Task
+
+::: openaivec.task.nlp.morphological_analysis

openaivec-0.14.1/docs/api/tasks/nlp/named_entity_recognition.md

@@ -0,0 +1,3 @@
+# Named Entity Recognition Task
+
+::: openaivec.task.nlp.named_entity_recognition

openaivec-0.14.1/docs/api/tasks/nlp/sentiment_analysis.md

@@ -0,0 +1,3 @@
+# Sentiment Analysis Task
+
+::: openaivec.task.nlp.sentiment_analysis

openaivec-0.14.1/docs/api/tasks/nlp/translation.md

@@ -0,0 +1,3 @@
+# Translation Task
+
+::: openaivec.task.nlp.translation

{openaivec-0.14.0 → openaivec-0.14.1}/docs/index.md

@@ -67,12 +67,10 @@ Get started with these comprehensive examples:
 
 Detailed documentation for all components:
 
+🔗 **[Main Package](api/main.md)** - Core classes (BatchResponses, BatchEmbeddings, FewShotPromptBuilder)  
 🔗 **[pandas_ext](api/pandas_ext.md)** - Pandas Series and DataFrame extensions  
 🔗 **[spark](api/spark.md)** - Apache Spark UDF builders  
-🔗 **[responses](api/responses.md)** - Batch response processing  
-🔗 **[embeddings](api/embeddings.md)** - Batch embedding generation  
-🔗 **[prompt](api/prompt.md)** - Few-shot prompt building  
-🔗 **[util](api/util.md)** - Utility functions and helpers
+🔗 **[task](api/task.md)** - Pre-built task modules for NLP and customer support
 
 ## Quick Start
 

{openaivec-0.14.0 → openaivec-0.14.1}/mkdocs.yml

@@ -131,8 +131,25 @@ plugins:
         python:
           paths:
             - src
-          docstring_style: google
-          show_submodules: true
+          options:
+            docstring_style: google
+            show_submodules: true
+            show_source: true
+            show_root_heading: true
+            show_root_toc_entry: true
+            heading_level: 2
+            members_order: source
+            show_signature_annotations: true
+            separate_signature: true
+            show_bases: true
+            show_docstring_parameters: true
+            show_docstring_returns: true
+            show_docstring_examples: true
+            show_category_heading: true
+            group_by_category: true
+            show_if_no_docstring: false
+            inherited_members: false
+            merge_init_into_class: true
 
 markdown_extensions:
   - abbr

openaivec-0.14.0/docs/api/main.md

@@ -1,118 +0,0 @@
-# Main Package API
-
-The main `openaivec` package provides the core classes for AI-powered data processing.
-
-## Core Classes
-
-All core functionality is accessible through the main package imports:
-
-::: openaivec.BatchResponses
-    options:
-      members:
-        - of
-        - of_task
-        - parse
-
-::: openaivec.AsyncBatchResponses
-    options:
-      members:
-        - of
-        - of_task
-        - parse
-
-::: openaivec.BatchEmbeddings
-    options:
-      members:
-        - of
-        - create
-
-::: openaivec.AsyncBatchEmbeddings
-    options:
-      members:
-        - of
-        - create
-
-## Task Configuration
-
-::: openaivec.PreparedTask
-
-## Prompt Building
-
-::: openaivec.FewShotPromptBuilder
-    options:
-      members:
-        - purpose
-        - caution
-        - example
-        - improve
-        - build
-        - build_json
-        - get_object
-
-## Usage Examples
-
-### Basic Batch Processing
-
-```python
-from openaivec import BatchResponses
-from openai import OpenAI
-
-# Create batch client
-client = BatchResponses.of(
-    client=OpenAI(),
-    model_name="gpt-4.1-mini"
-)
-
-# Process multiple inputs
-results = client.parse([
-    "Translate 'hello' to French",
-    "What is 2+2?",
-    "Name three colors"
-])
-```
-
-### Structured Outputs with Tasks
-
-```python
-from openaivec import BatchResponses, PreparedTask
-from openai import OpenAI
-from pydantic import BaseModel
-
-class Sentiment(BaseModel):
-    sentiment: str
-    confidence: float
-
-task = PreparedTask(
-    instructions="Analyze sentiment",
-    response_format=Sentiment,
-    temperature=0.0
-)
-
-client = BatchResponses.of_task(
-    client=OpenAI(),
-    model_name="gpt-4.1-mini", 
-    task=task
-)
-
-results = client.parse([
-    "I love this product!",
-    "This is terrible quality"
-])
-```
-
-### Advanced Prompt Building
-
-```python
-from openaivec import FewShotPromptBuilder
-
-prompt = (
-    FewShotPromptBuilder()
-    .purpose("Classify animals by their habitat")
-    .caution("Consider both land and water animals")
-    .example("dolphin", "aquatic")
-    .example("eagle", "aerial") 
-    .example("bear", "terrestrial")
-    .improve()  # AI-powered improvement
-    .build()
-)
-```

openaivec-0.14.0/docs/api/pandas_ext.md

@@ -1,15 +0,0 @@
-# Pandas Extension
-
-::: openaivec.pandas_ext
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true

openaivec-0.14.0/docs/api/spark.md

@@ -1,15 +0,0 @@
-# Spark Extension
-
-::: openaivec.spark
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true

openaivec-0.14.0/docs/api/task.md

@@ -1,19 +0,0 @@
-# Task Module
-
-::: openaivec.task
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true
-      group_by_category: true
-      show_category_heading: true
-      show_symbol_type_heading: true
-      show_symbol_type_toc: true

openaivec-0.14.0/docs/api/tasks/customer_support/customer_sentiment.md

@@ -1,3 +0,0 @@
-# Customer Sentiment Analysis
-
-::: openaivec.task.customer_support.customer_sentiment

openaivec-0.14.0/docs/api/tasks/customer_support/inquiry_classification.md

@@ -1,3 +0,0 @@
-# Inquiry Classification
-
-::: openaivec.task.customer_support.inquiry_classification

openaivec-0.14.0/docs/api/tasks/customer_support/inquiry_summary.md

@@ -1,3 +0,0 @@
-# Inquiry Summary
-
-::: openaivec.task.customer_support.inquiry_summary

openaivec-0.14.0/docs/api/tasks/customer_support/intent_analysis.md

@@ -1,3 +0,0 @@
-# Intent Analysis
-
-::: openaivec.task.customer_support.intent_analysis

openaivec-0.14.0/docs/api/tasks/customer_support/response_suggestion.md

@@ -1,3 +0,0 @@
-# Response Suggestion
-
-::: openaivec.task.customer_support.response_suggestion

openaivec-0.14.0/docs/api/tasks/customer_support/urgency_analysis.md

@@ -1,3 +0,0 @@
-# Urgency Analysis
-
-::: openaivec.task.customer_support.urgency_analysis

openaivec-0.14.0/docs/api/tasks/nlp/dependency_parsing.md

@@ -1,15 +0,0 @@
-# Dependency Parsing Task
-
-::: openaivec.task.nlp.dependency_parsing
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true

openaivec-0.14.0/docs/api/tasks/nlp/keyword_extraction.md

@@ -1,15 +0,0 @@
-# Keyword Extraction Task
-
-::: openaivec.task.nlp.keyword_extraction
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true

openaivec-0.14.0/docs/api/tasks/nlp/morphological_analysis.md

@@ -1,15 +0,0 @@
-# Morphological Analysis Task
-
-::: openaivec.task.nlp.morphological_analysis
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true

openaivec-0.14.0/docs/api/tasks/nlp/named_entity_recognition.md

@@ -1,15 +0,0 @@
-# Named Entity Recognition Task
-
-::: openaivec.task.nlp.named_entity_recognition
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true

openaivec-0.14.0/docs/api/tasks/nlp/sentiment_analysis.md

@@ -1,15 +0,0 @@
-# Sentiment Analysis Task
-
-::: openaivec.task.nlp.sentiment_analysis
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true

openaivec-0.14.0/docs/api/tasks/nlp/translation.md

@@ -1,15 +0,0 @@
-# Translation Task
-
-::: openaivec.task.nlp.translation
-    options:
-      show_source: true
-      show_root_heading: true
-      show_root_toc_entry: true
-      heading_level: 2
-      members_order: source
-      show_signature_annotations: true
-      separate_signature: true
-      show_bases: true
-      show_docstring_parameters: true
-      show_docstring_returns: true
-      show_docstring_examples: true