channel3-sdk 0.2.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

{channel3_sdk-0.2.1.dist-info → channel3_sdk-1.0.0.dist-info}/METADATA

@@ -1,25 +1,29 @@
 Metadata-Version: 2.1
 Name: channel3-sdk
-Version: 0.2.1
-Summary: The official Python SDK for Channel3 AI Shopping API
-Home-page: https://github.com/channel3/sdk-python
+Version: 1.0.0
+Summary: The official Python SDK for Channel3
+Home-page: https://github.com/channel3-ai/sdk-python
 License: MIT
 Keywords: ai,shopping,ecommerce,search,api
 Author: Channel3
 Author-email: alex@trychannel3.com
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: aiohttp (>=3.9.0,<4.0.0)
-Requires-Dist: pydantic (>=2.5.0,<3.0.0)
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Dist: attrs (>=22.2.0)
+Requires-Dist: httpx (>=0.23.0,<0.29.0)
+Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
-Project-URL: Repository, https://github.com/channel3/sdk-python
+Project-URL: Repository, https://github.com/channel3-ai/sdk-python
 Description-Content-Type: text/markdown
 
 # Channel3 Python SDK
@@ -63,10 +67,7 @@ if product_detail.key_features:
 
 # Get all brands
 brands = client.get_brands()
-for brand in brands:
-    print(f"Brand: {brand.name}")
-    if brand.description:
-        print(f"Description: {brand.description}")
+print(f"Found {len(brands.items)} brands")
 
 # Get specific brand details
 brand = client.get_brand("brand_123")
@@ -82,23 +83,23 @@ from channel3_sdk import AsyncChannel3Client
 async def main():
     # Initialize the async client
     client = AsyncChannel3Client(api_key="your_api_key_here")
-    
+
     # Search for products
     products = await client.search(query="running shoes")
-    
+
     for product in products:
         print(f"Product: {product.title}")
         print(f"Score: {product.score}")
         print(f"Price: {product.price.currency} {product.price.price}")
-    
+
     # Get detailed product information
     if products:
         product_detail = await client.get_product(products[0].id)
         print(f"Availability: {product_detail.availability}")
-    
+
     # Get brands
     brands = await client.get_brands()
-    print(f"Found {len(brands)} brands")
+    print(f"Found {len(brands.items)} brands")
 
 # Run the async function
 asyncio.run(main())
@@ -150,11 +151,39 @@ products = client.search(
 )
 ```
 
+### Search configuration and context
+
+You can control how search behaves using `SearchConfig`, and add optional `context` to guide results.
+
+```python
+from channel3_sdk import SearchConfig
+
+config = SearchConfig(enrich_query=True, semantic_search=False)
+
+products = client.search(
+    query="running shoes",
+    limit=5,
+    config=config,              # or a dict: {"enrich_query": True, "semantic_search": False}
+    context="Marathon training on road surfaces"
+)
+```
+
+Async usage is identical:
+
+```python
+products = await async_client.search(
+    query="hiking boots",
+    config={"enrich_query": False, "semantic_search": True},
+    context="Waterproof boots for alpine conditions"
+)
+```
+
 ### Brand Management
 
 ```python
 # Get all brands with pagination
 brands = client.get_brands(page=1, size=50)
+print(brands.pagination.total_count)
 
 # Search for specific brands
 nike_brands = client.get_brands(query="nike")
@@ -170,26 +199,31 @@ print(f"Logo: {brand_detail.logo_url}")
 ### Client Classes
 
 #### `Channel3Client`
+
 Synchronous client for the Channel3 API.
 
 **Methods:**
-- `search(query=None, image_url=None, base64_image=None, filters=None, limit=20)` → `List[Product]`
+
+- `search(query=None, image_url=None, base64_image=None, filters=None, limit=20, config=None, context=None)` → `List[Product]`
 - `get_product(product_id)` → `ProductDetail`
-- `get_brands(query=None, page=1, size=100)` → `List[Brand]`
+- `get_brands(query=None, page=1, size=100)` → `PaginatedResponseBrand`
 - `get_brand(brand_id)` → `Brand`
 
-#### `AsyncChannel3Client` 
+#### `AsyncChannel3Client`
+
 Asynchronous client for the Channel3 API.
 
 **Methods:**
-- `async search(query=None, image_url=None, base64_image=None, filters=None, limit=20)` → `List[Product]`
+
+- `async search(query=None, image_url=None, base64_image=None, filters=None, limit=20, config=None, context=None)` → `List[Product]`
 - `async get_product(product_id)` → `ProductDetail`
-- `async get_brands(query=None, page=1, size=100)` → `List[Brand]`
+- `async get_brands(query=None, page=1, size=100)` → `PaginatedResponseBrand`
 - `async get_brand(brand_id)` → `Brand`
 
 ### Models
 
 #### `Product`
+
 - `id: str` - Unique product identifier
 - `score: float` - Search relevance score
 - `title: str` - Product title
@@ -201,6 +235,7 @@ Asynchronous client for the Channel3 API.
 - `variants: List[Variant]` - Product variants
 
 #### `ProductDetail`
+
 - `title: str` - Product title
 - `description: Optional[str]` - Product description
 - `brand_id: Optional[str]` - Brand identifier
@@ -212,34 +247,57 @@ Asynchronous client for the Channel3 API.
 - `variants: List[Variant]` - Product variants
 
 #### `Brand`
+
 - `id: str` - Unique brand identifier
 - `name: str` - Brand name
 - `logo_url: Optional[str]` - Brand logo URL
 - `description: Optional[str]` - Brand description
 
 #### `Variant`
+
 - `product_id: str` - Associated product identifier
 - `title: str` - Variant title
 - `image_url: str` - Variant image URL
 
 #### `SearchFilters`
+
 - `brand_ids: Optional[List[str]]` - Brand ID filters
 - `gender: Optional[Literal["male", "female", "unisex"]]` - Gender filter
 - `price: Optional[SearchFilterPrice]` - Price range filter
 - `availability: Optional[List[AvailabilityStatus]]` - Availability filters
 
 #### `SearchFilterPrice`
+
 - `min_price: Optional[float]` - Minimum price
 - `max_price: Optional[float]` - Maximum price
 
+#### `SearchConfig`
+
+- `enrich_query: bool = True` — enable query rewriting/enrichment
+- `semantic_search: bool = True` — enable semantic ranking
+
 #### `Price`
+
 - `price: float` - Current price
 - `compare_at_price: Optional[float]` - Original price (if discounted)
 - `currency: str` - Currency code
 
 #### `AvailabilityStatus`
+
 Enum with values: `IN_STOCK`, `OUT_OF_STOCK`, `PRE_ORDER`, `LIMITED_AVAILABILITY`, `BACK_ORDER`, `DISCONTINUED`, `SOLD_OUT`, `UNKNOWN`
 
+#### `PaginatedResponseBrand`
+
+- `items: List[Brand]` — page of brands
+- `pagination: PaginationMeta` — pagination info
+
+#### `PaginationMeta`
+
+- `current_page: int`
+- `page_size: int`
+- `total_count: int`
+- `total_pages: int`
+
 ## Error Handling
 
 The SDK provides specific exception types for different error conditions:
@@ -273,10 +331,9 @@ except Channel3ConnectionError:
 
 ## Requirements
 
-- Python 3.8+
+- Python 3.9+
 - requests
-- aiohttp
-- pydantic
+- httpx
 
 ## License
 

channel3_sdk-1.0.0.dist-info/RECORD

@@ -0,0 +1,38 @@
+channel3_sdk/__init__.py,sha256=mYmvZ2ahuAxzy_1gtroB8qpK_u_tuKoDCm5C_LHRwRg,1696
+channel3_sdk/_gen/.gitignore,sha256=SwZvl9qyKaHN9YjwaQrBsmpAclN11usf9Gohz1SFVg8,195
+channel3_sdk/_gen/README.md,sha256=d6VMPYuhTiK-WEKNRd-zbIG_uzYOVWkVvPBgDEPVwnc,4997
+channel3_sdk/_gen/fast_api_client/__init__.py,sha256=qUheje2C4lZ8b26EUHXHRJ3dWuzKiExv_JVOdVCFAek,150
+channel3_sdk/_gen/fast_api_client/api/__init__.py,sha256=zTSiG_ujSjAqWPyc435YXaX9XTlpMjiJWBbV-f-YtdA,45
+channel3_sdk/_gen/fast_api_client/api/channel3_api/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
+channel3_sdk/_gen/fast_api_client/api/channel3_api/get_brand_detail_v0_brands_brand_id_get.py,sha256=yNOOiKimIDQONHCH3i5KBnYa1LvEjD6THXjCyLgE-tU,4611
+channel3_sdk/_gen/fast_api_client/api/channel3_api/get_brands_v0_brands_get.py,sha256=KfCOw1595dAcV1IT9Vuddz1EKiaHOb2BBrVcmNsczL0,6075
+channel3_sdk/_gen/fast_api_client/api/channel3_api/get_product_detail_v0_products_product_id_get.py,sha256=8d3Z4CXdph42GcYSjqaVFqz54Ct2D8tqwZ8PXn66Xyo,4778
+channel3_sdk/_gen/fast_api_client/api/channel3_api/search_v0_search_post.py,sha256=TV2_222dJtv8nmVXxGGznB-maWlHZB96nxJAhxQz6T0,4944
+channel3_sdk/_gen/fast_api_client/api/default/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
+channel3_sdk/_gen/fast_api_client/api/default/root_get.py,sha256=83wq3kzLX9On8L2L8wldOgIf90e5fUsTT6dbC2bvfYM,2063
+channel3_sdk/_gen/fast_api_client/client.py,sha256=o_mdLqyBCQstu5tS1WZFwqIEbGwkvWQ7eQjuCJw_5VY,12419
+channel3_sdk/_gen/fast_api_client/errors.py,sha256=gO8GBmKqmSNgAg-E5oT-oOyxztvp7V_6XG7OUTT15q0,546
+channel3_sdk/_gen/fast_api_client/models/__init__.py,sha256=Yc0J6woL8dLhHW0VZbZuSV17-9DHR-qpk63sC6SiNVc,1059
+channel3_sdk/_gen/fast_api_client/models/availability_status.py,sha256=yC7hCgFwU_CcIfnS2UggdFdNWsoq0lvrdrR5n43tIto,361
+channel3_sdk/_gen/fast_api_client/models/brand.py,sha256=hEObzXznweXyzLjiSQl0pUBYquCrn09XKcFSKtjoQfk,2986
+channel3_sdk/_gen/fast_api_client/models/error_response.py,sha256=hGdOt8lakOZFh9YlOE53zEq9Ektv6cOQTIbqtRLg4TQ,1467
+channel3_sdk/_gen/fast_api_client/models/paginated_response_brand.py,sha256=TPd0tEzvE7TxE7DhpSsh5p4FpP1muHSYQezwZ9Yxcas,2330
+channel3_sdk/_gen/fast_api_client/models/pagination_meta.py,sha256=iF8W1dOyuDb4Y5Wa5HviYfXjPJkayK5R68JgNA7rwY4,2185
+channel3_sdk/_gen/fast_api_client/models/price.py,sha256=aol4R82ffjKvsrzch-P1iw5HwT0FcCqUmGvjb65lPmM,2617
+channel3_sdk/_gen/fast_api_client/models/product.py,sha256=XkKaBA89YOaMh9XSTEdBkvO8miQVED8nNquAO75bw1s,4485
+channel3_sdk/_gen/fast_api_client/models/product_detail.py,sha256=PybK6gS_yxmjIax7ryH6pha69T-iCNR8IjtWHn8cFVU,9850
+channel3_sdk/_gen/fast_api_client/models/product_detail_gender_type_0.py,sha256=iz4Yx9AiuvITYK5r1C_8hUY09GyVtJ7Saru7FdeDGLQ,191
+channel3_sdk/_gen/fast_api_client/models/search_config.py,sha256=nVjpdhESU7IJiCW4HCdq1hUGDVtrhXhFJqrjDgGHzlc,2031
+channel3_sdk/_gen/fast_api_client/models/search_filter_price.py,sha256=GFaLgoXXRkLpX39b3w0JpZRek026DQEp-UfRMaXmMXs,2864
+channel3_sdk/_gen/fast_api_client/models/search_filters.py,sha256=KjioDMmVINN2vR1iCEj7GH9ME6BfmI17a1jgiMyd8xU,6657
+channel3_sdk/_gen/fast_api_client/models/search_filters_gender_type_0.py,sha256=52XYojpfDdj_LV_9gQbsGWP_aANJ1-KiZOogxn4noms,191
+channel3_sdk/_gen/fast_api_client/models/search_request.py,sha256=oqQcXcH1Psp-Qwx8_MFhyPIB60gBMo-IpPnBp24DUmg,6156
+channel3_sdk/_gen/fast_api_client/models/variant.py,sha256=G3T1E5sBZmJb2hYeb9V3ACaUqVBhqX9gRvI_ooHFgVI,1820
+channel3_sdk/_gen/fast_api_client/py.typed,sha256=8ZJUsxZiuOy1oJeVhsTWQhTG_6pTVHVXk5hJL79ebTk,25
+channel3_sdk/_gen/fast_api_client/types.py,sha256=AX4orxQZQJat3vZrgjJ-TYb2sNBL8kNo9yqYDT-n8y8,1391
+channel3_sdk/_gen/pyproject.toml,sha256=m8NKk1ztXdKounkQTmYgzcML-jmumnMdLLielJAam0k,544
+channel3_sdk/client.py,sha256=5yJJiucJiTl-BV_zKaGch57OQSpIEJjWD5TPHaaapl4,13658
+channel3_sdk/exceptions.py,sha256=5HJgrhir4-_b4XKyWAB9qp-CjVZeigXSkyM9fbcB1IA,1044
+channel3_sdk-1.0.0.dist-info/METADATA,sha256=WGfNoiIoxP86MfoglDbOJofwBlLkzhcidBj91Bg1vL8,9028
+channel3_sdk-1.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+channel3_sdk-1.0.0.dist-info/RECORD,,

{channel3_sdk-0.2.1.dist-info → channel3_sdk-1.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any

channel3_sdk/models.py

@@ -1,135 +0,0 @@
-"""Pydantic models for the Channel3 API."""
-
-from enum import Enum
-from typing import List, Optional, Literal
-from pydantic import BaseModel, Field
-
-
-class AvailabilityStatus(str, Enum):
-    """Availability status of a product."""
-
-    IN_STOCK = "InStock"
-    OUT_OF_STOCK = "OutOfStock"
-    PRE_ORDER = "PreOrder"
-    LIMITED_AVAILABILITY = "LimitedAvailability"
-    BACK_ORDER = "BackOrder"
-    DISCONTINUED = "Discontinued"
-    SOLD_OUT = "SoldOut"
-    UNKNOWN = "Unknown"
-
-
-class Price(BaseModel):
-    """Price information for a product."""
-
-    price: float = Field(
-        ..., description="The current price of the product, including any discounts."
-    )
-    compare_at_price: Optional[float] = Field(
-        None, description="The original price of the product before any discounts."
-    )
-    currency: str = Field(..., description="The currency code of the product.")
-
-
-class Brand(BaseModel):
-    """A brand."""
-
-    id: str = Field(..., description="Unique identifier for the brand")
-    name: str = Field(..., description="Name of the brand")
-    logo_url: Optional[str] = Field(None, description="Logo URL for the brand")
-    description: Optional[str] = Field(None, description="Description of the brand")
-
-
-class Variant(BaseModel):
-    """A product variant."""
-
-    product_id: str = Field(..., description="Unique identifier for the product")
-    title: str = Field(..., description="Title of the variant")
-    image_url: str = Field(..., description="Image URL for the variant")
-
-
-class Product(BaseModel):
-    """A product returned from search."""
-
-    id: str = Field(..., description="Unique identifier for the product")
-    url: str = Field(..., description="URL for the product")
-    score: float = Field(..., description="Relevance score for the search query")
-    title: str = Field(..., description="Product title")
-    description: Optional[str] = Field(None, description="Product description")
-    brand: Brand = Field(..., description="Brand of the product")
-    image_url: str = Field(..., description="Main product image URL")
-    price: Price = Field(..., description="Price information")
-    availability: AvailabilityStatus = Field(
-        ..., description="Product availability status"
-    )
-    variants: List[Variant] = Field(
-        default_factory=list, description="Product variants"
-    )
-
-
-class ProductDetail(BaseModel):
-    """Detailed information about a product."""
-
-    id: str = Field(..., description="Unique identifier for the product")
-    url: str = Field(..., description="URL for the product")
-    score: float = Field(..., description="Relevance score for the search query")
-    title: str = Field(..., description="Product title")
-    description: Optional[str] = Field(None, description="Product description")
-    brand_id: Optional[str] = Field(None, description="Unique identifier for the brand")
-    brand_name: Optional[str] = Field(None, description="Brand name of the product")
-    image_urls: Optional[List[str]] = Field(
-        None, description="List of product image URLs"
-    )
-    price: Price = Field(..., description="Price information")
-    availability: AvailabilityStatus = Field(
-        ..., description="Product availability status"
-    )
-    gender: Optional[Literal["unisex", "men", "women"]] = Field(
-        None, description="Gender of the product, if applicable"
-    )
-    materials: Optional[List[str]] = Field(
-        None, description="List of materials, if applicable"
-    )
-    key_features: Optional[List[str]] = Field(
-        None, description="List of key product features"
-    )
-    variants: List[Variant] = Field(
-        default_factory=list, description="Product variants"
-    )
-
-
-class SearchFilterPrice(BaseModel):
-    """Price filter for product search."""
-
-    min_price: Optional[float] = Field(None, description="Minimum price filter")
-    max_price: Optional[float] = Field(None, description="Maximum price filter")
-
-
-class SearchFilters(BaseModel):
-    """Search filters for product search."""
-
-    brand_ids: Optional[List[str]] = Field(
-        None, description="List of brand IDs to filter by"
-    )
-    gender: Optional[Literal["male", "female", "unisex"]] = Field(
-        None, description="Gender to filter by"
-    )
-    price: Optional[SearchFilterPrice] = Field(
-        None, description="Price range to filter by"
-    )
-    availability: Optional[List[AvailabilityStatus]] = Field(
-        None, description="Availability statuses to filter by"
-    )
-
-
-class SearchRequest(BaseModel):
-    """Request model for product search."""
-
-    query: Optional[str] = Field(None, description="Text search query")
-    image_url: Optional[str] = Field(None, description="URL of image for visual search")
-    base64_image: Optional[str] = Field(
-        None, description="Base64-encoded image for visual search"
-    )
-    limit: Optional[int] = Field(
-        default=20, description="Maximum number of results to return"
-    )
-    filters: Optional[SearchFilters] = Field(default=None, description="Search filters")

channel3_sdk-0.2.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-channel3_sdk/__init__.py,sha256=vMrsZwY59OoYmoPwEnZ0kuAuWFkOIERUaoy0lWpGIlc,976
-channel3_sdk/client.py,sha256=wNqM9d7M2eiWOZ0Xp9rJGjINUrsaHYXiBJktBfPD-18,20776
-channel3_sdk/exceptions.py,sha256=5HJgrhir4-_b4XKyWAB9qp-CjVZeigXSkyM9fbcB1IA,1044
-channel3_sdk/models.py,sha256=K9D2scDVQzrC1s74xJ9Orj6yFCGfqqKZ4AvDBSWWpi0,5030
-channel3_sdk-0.2.1.dist-info/METADATA,sha256=RWOkOFH9jZlGFdTS1PgvfRiovqbfjBAOEne3xsJR-Mo,7799
-channel3_sdk-0.2.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-channel3_sdk-0.2.1.dist-info/RECORD,,