antfly-sdk 0.0.2.dev2__py3-none-any.whl

antfly/client_generated/models/tavily_search_config.py

@@ -0,0 +1,195 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.tavily_search_config_search_depth import TavilySearchConfigSearchDepth
+from ..models.web_search_provider import WebSearchProvider
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="TavilySearchConfig")
+
+
+@_attrs_define
+class TavilySearchConfig:
+    """Configuration for Tavily AI Search API.
+
+    Tavily is optimized for RAG and AI applications, providing
+    pre-processed results with summaries and relevance scoring.
+
+    **Setup:**
+    1. Sign up at https://tavily.com
+    2. Get API key from dashboard
+
+    **Docs:** https://docs.tavily.com
+
+        Attributes:
+            provider (WebSearchProvider): The web search provider to use.
+
+                - **google**: Google Custom Search API (requires CSE setup)
+                - **bing**: Microsoft Bing Web Search API
+                - **serper**: Serper.dev Google Search API (simpler setup)
+                - **tavily**: Tavily AI Search API (optimized for RAG)
+                - **brave**: Brave Search API
+                - **duckduckgo**: DuckDuckGo Instant Answer API (limited, no API key)
+            max_results (int | Unset): Maximum number of search results to return Default: 5.
+            timeout_ms (int | Unset): Request timeout in milliseconds Default: 10000.
+            safe_search (bool | Unset): Enable safe search filtering Default: True.
+            language (str | Unset): Preferred language for results (e.g., 'en', 'es', 'fr') Example: en.
+            region (str | Unset): Preferred region for results (e.g., 'us', 'uk', 'de') Example: us.
+            api_key (str | Unset): Tavily API key (or set TAVILY_API_KEY env var)
+            search_depth (TavilySearchConfigSearchDepth | Unset): Search depth:
+                - basic: Fast search with standard results
+                - advanced: Deeper search with more comprehensive results
+                 Default: TavilySearchConfigSearchDepth.BASIC.
+            include_answer (bool | Unset): Include AI-generated answer summary Default: True.
+            include_raw_content (bool | Unset): Include raw HTML content of pages Default: False.
+            include_domains (list[str] | Unset): Only include results from these domains
+            exclude_domains (list[str] | Unset): Exclude results from these domains
+    """
+
+    provider: WebSearchProvider
+    max_results: int | Unset = 5
+    timeout_ms: int | Unset = 10000
+    safe_search: bool | Unset = True
+    language: str | Unset = UNSET
+    region: str | Unset = UNSET
+    api_key: str | Unset = UNSET
+    search_depth: TavilySearchConfigSearchDepth | Unset = TavilySearchConfigSearchDepth.BASIC
+    include_answer: bool | Unset = True
+    include_raw_content: bool | Unset = False
+    include_domains: list[str] | Unset = UNSET
+    exclude_domains: list[str] | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        provider = self.provider.value
+
+        max_results = self.max_results
+
+        timeout_ms = self.timeout_ms
+
+        safe_search = self.safe_search
+
+        language = self.language
+
+        region = self.region
+
+        api_key = self.api_key
+
+        search_depth: str | Unset = UNSET
+        if not isinstance(self.search_depth, Unset):
+            search_depth = self.search_depth.value
+
+        include_answer = self.include_answer
+
+        include_raw_content = self.include_raw_content
+
+        include_domains: list[str] | Unset = UNSET
+        if not isinstance(self.include_domains, Unset):
+            include_domains = self.include_domains
+
+        exclude_domains: list[str] | Unset = UNSET
+        if not isinstance(self.exclude_domains, Unset):
+            exclude_domains = self.exclude_domains
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "provider": provider,
+            }
+        )
+        if max_results is not UNSET:
+            field_dict["max_results"] = max_results
+        if timeout_ms is not UNSET:
+            field_dict["timeout_ms"] = timeout_ms
+        if safe_search is not UNSET:
+            field_dict["safe_search"] = safe_search
+        if language is not UNSET:
+            field_dict["language"] = language
+        if region is not UNSET:
+            field_dict["region"] = region
+        if api_key is not UNSET:
+            field_dict["api_key"] = api_key
+        if search_depth is not UNSET:
+            field_dict["search_depth"] = search_depth
+        if include_answer is not UNSET:
+            field_dict["include_answer"] = include_answer
+        if include_raw_content is not UNSET:
+            field_dict["include_raw_content"] = include_raw_content
+        if include_domains is not UNSET:
+            field_dict["include_domains"] = include_domains
+        if exclude_domains is not UNSET:
+            field_dict["exclude_domains"] = exclude_domains
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        provider = WebSearchProvider(d.pop("provider"))
+
+        max_results = d.pop("max_results", UNSET)
+
+        timeout_ms = d.pop("timeout_ms", UNSET)
+
+        safe_search = d.pop("safe_search", UNSET)
+
+        language = d.pop("language", UNSET)
+
+        region = d.pop("region", UNSET)
+
+        api_key = d.pop("api_key", UNSET)
+
+        _search_depth = d.pop("search_depth", UNSET)
+        search_depth: TavilySearchConfigSearchDepth | Unset
+        if isinstance(_search_depth, Unset):
+            search_depth = UNSET
+        else:
+            search_depth = TavilySearchConfigSearchDepth(_search_depth)
+
+        include_answer = d.pop("include_answer", UNSET)
+
+        include_raw_content = d.pop("include_raw_content", UNSET)
+
+        include_domains = cast(list[str], d.pop("include_domains", UNSET))
+
+        exclude_domains = cast(list[str], d.pop("exclude_domains", UNSET))
+
+        tavily_search_config = cls(
+            provider=provider,
+            max_results=max_results,
+            timeout_ms=timeout_ms,
+            safe_search=safe_search,
+            language=language,
+            region=region,
+            api_key=api_key,
+            search_depth=search_depth,
+            include_answer=include_answer,
+            include_raw_content=include_raw_content,
+            include_domains=include_domains,
+            exclude_domains=exclude_domains,
+        )
+
+        tavily_search_config.additional_properties = d
+        return tavily_search_config
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

antfly/client_generated/models/tavily_search_config_search_depth.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class TavilySearchConfigSearchDepth(str, Enum):
+    ADVANCED = "advanced"
+    BASIC = "basic"
+
+    def __str__(self) -> str:
+        return str(self.value)

antfly/client_generated/models/template_field_mapping.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.antfly_type_2 import AntflyType2
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="TemplateFieldMapping")
+
+
+@_attrs_define
+class TemplateFieldMapping:
+    """Field mapping to apply when a dynamic template matches
+
+    Attributes:
+        type_ (AntflyType2 | Unset): Field type annotations for schema fields
+        analyzer (str | Unset): Analyzer name (e.g., "standard", "keyword", "en", "html_analyzer").
+            Used for text fields to control tokenization and normalization.
+        index (bool | Unset): Whether to index the field (default true) Default: True.
+        store (bool | Unset): Whether to store the field value (default false) Default: False.
+        include_in_all (bool | Unset): Whether to include in the _all field for cross-field search Default: False.
+        doc_values (bool | Unset): Whether to enable doc values for sorting/faceting Default: False.
+    """
+
+    type_: AntflyType2 | Unset = UNSET
+    analyzer: str | Unset = UNSET
+    index: bool | Unset = True
+    store: bool | Unset = False
+    include_in_all: bool | Unset = False
+    doc_values: bool | Unset = False
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        type_: str | Unset = UNSET
+        if not isinstance(self.type_, Unset):
+            type_ = self.type_.value
+
+        analyzer = self.analyzer
+
+        index = self.index
+
+        store = self.store
+
+        include_in_all = self.include_in_all
+
+        doc_values = self.doc_values
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if type_ is not UNSET:
+            field_dict["type"] = type_
+        if analyzer is not UNSET:
+            field_dict["analyzer"] = analyzer
+        if index is not UNSET:
+            field_dict["index"] = index
+        if store is not UNSET:
+            field_dict["store"] = store
+        if include_in_all is not UNSET:
+            field_dict["include_in_all"] = include_in_all
+        if doc_values is not UNSET:
+            field_dict["doc_values"] = doc_values
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        _type_ = d.pop("type", UNSET)
+        type_: AntflyType2 | Unset
+        if isinstance(_type_, Unset):
+            type_ = UNSET
+        else:
+            type_ = AntflyType2(_type_)
+
+        analyzer = d.pop("analyzer", UNSET)
+
+        index = d.pop("index", UNSET)
+
+        store = d.pop("store", UNSET)
+
+        include_in_all = d.pop("include_in_all", UNSET)
+
+        doc_values = d.pop("doc_values", UNSET)
+
+        template_field_mapping = cls(
+            type_=type_,
+            analyzer=analyzer,
+            index=index,
+            store=store,
+            include_in_all=include_in_all,
+            doc_values=doc_values,
+        )
+
+        template_field_mapping.additional_properties = d
+        return template_field_mapping
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

antfly/client_generated/models/term_query.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="TermQuery")
+
+
+@_attrs_define
+class TermQuery:
+    """
+    Attributes:
+        term (str):
+        field (str | Unset):
+        boost (float | None | Unset): A floating-point number used to decrease or increase the relevance scores of a
+            query.
+    """
+
+    term: str
+    field: str | Unset = UNSET
+    boost: float | None | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        term = self.term
+
+        field = self.field
+
+        boost: float | None | Unset
+        if isinstance(self.boost, Unset):
+            boost = UNSET
+        else:
+            boost = self.boost
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "term": term,
+            }
+        )
+        if field is not UNSET:
+            field_dict["field"] = field
+        if boost is not UNSET:
+            field_dict["boost"] = boost
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        term = d.pop("term")
+
+        field = d.pop("field", UNSET)
+
+        def _parse_boost(data: object) -> float | None | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(float | None | Unset, data)
+
+        boost = _parse_boost(d.pop("boost", UNSET))
+
+        term_query = cls(
+            term=term,
+            field=field,
+            boost=boost,
+        )
+
+        term_query.additional_properties = d
+        return term_query
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

antfly/client_generated/models/term_range_query.py

@@ -0,0 +1,163 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="TermRangeQuery")
+
+
+@_attrs_define
+class TermRangeQuery:
+    """
+    Attributes:
+        min_ (None | str | Unset):
+        max_ (None | str | Unset):
+        inclusive_min (bool | None | Unset):
+        inclusive_max (bool | None | Unset):
+        field (str | Unset):
+        boost (float | None | Unset): A floating-point number used to decrease or increase the relevance scores of a
+            query.
+    """
+
+    min_: None | str | Unset = UNSET
+    max_: None | str | Unset = UNSET
+    inclusive_min: bool | None | Unset = UNSET
+    inclusive_max: bool | None | Unset = UNSET
+    field: str | Unset = UNSET
+    boost: float | None | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        min_: None | str | Unset
+        if isinstance(self.min_, Unset):
+            min_ = UNSET
+        else:
+            min_ = self.min_
+
+        max_: None | str | Unset
+        if isinstance(self.max_, Unset):
+            max_ = UNSET
+        else:
+            max_ = self.max_
+
+        inclusive_min: bool | None | Unset
+        if isinstance(self.inclusive_min, Unset):
+            inclusive_min = UNSET
+        else:
+            inclusive_min = self.inclusive_min
+
+        inclusive_max: bool | None | Unset
+        if isinstance(self.inclusive_max, Unset):
+            inclusive_max = UNSET
+        else:
+            inclusive_max = self.inclusive_max
+
+        field = self.field
+
+        boost: float | None | Unset
+        if isinstance(self.boost, Unset):
+            boost = UNSET
+        else:
+            boost = self.boost
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if min_ is not UNSET:
+            field_dict["min"] = min_
+        if max_ is not UNSET:
+            field_dict["max"] = max_
+        if inclusive_min is not UNSET:
+            field_dict["inclusive_min"] = inclusive_min
+        if inclusive_max is not UNSET:
+            field_dict["inclusive_max"] = inclusive_max
+        if field is not UNSET:
+            field_dict["field"] = field
+        if boost is not UNSET:
+            field_dict["boost"] = boost
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+
+        def _parse_min_(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        min_ = _parse_min_(d.pop("min", UNSET))
+
+        def _parse_max_(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        max_ = _parse_max_(d.pop("max", UNSET))
+
+        def _parse_inclusive_min(data: object) -> bool | None | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(bool | None | Unset, data)
+
+        inclusive_min = _parse_inclusive_min(d.pop("inclusive_min", UNSET))
+
+        def _parse_inclusive_max(data: object) -> bool | None | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(bool | None | Unset, data)
+
+        inclusive_max = _parse_inclusive_max(d.pop("inclusive_max", UNSET))
+
+        field = d.pop("field", UNSET)
+
+        def _parse_boost(data: object) -> float | None | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(float | None | Unset, data)
+
+        boost = _parse_boost(d.pop("boost", UNSET))
+
+        term_range_query = cls(
+            min_=min_,
+            max_=max_,
+            inclusive_min=inclusive_min,
+            inclusive_max=inclusive_max,
+            field=field,
+            boost=boost,
+        )
+
+        term_range_query.additional_properties = d
+        return term_range_query
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

antfly/client_generated/models/text_chunk_options.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="TextChunkOptions")
+
+
+@_attrs_define
+class TextChunkOptions:
+    r"""Options specific to text chunking.
+
+    Attributes:
+        target_tokens (int | Unset): Target number of tokens per chunk.
+        overlap_tokens (int | Unset): Number of tokens to overlap between consecutive chunks. Helps maintain context
+            across chunk boundaries. Only used by fixed-size chunkers.
+        separator (str | Unset): Separator string for splitting (e.g., '\n\n' for paragraphs). Only used by fixed-size
+            chunkers.
+    """
+
+    target_tokens: int | Unset = UNSET
+    overlap_tokens: int | Unset = UNSET
+    separator: str | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        target_tokens = self.target_tokens
+
+        overlap_tokens = self.overlap_tokens
+
+        separator = self.separator
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if target_tokens is not UNSET:
+            field_dict["target_tokens"] = target_tokens
+        if overlap_tokens is not UNSET:
+            field_dict["overlap_tokens"] = overlap_tokens
+        if separator is not UNSET:
+            field_dict["separator"] = separator
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        target_tokens = d.pop("target_tokens", UNSET)
+
+        overlap_tokens = d.pop("overlap_tokens", UNSET)
+
+        separator = d.pop("separator", UNSET)
+
+        text_chunk_options = cls(
+            target_tokens=target_tokens,
+            overlap_tokens=overlap_tokens,
+            separator=separator,
+        )
+
+        text_chunk_options.additional_properties = d
+        return text_chunk_options
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties