airweave-sdk 0.8.65__py3-none-any.whl → 0.8.66__py3-none-any.whl

airweave/types/delivery_attempt.py

@@ -0,0 +1,61 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class DeliveryAttempt(UniversalBaseModel):
+    """
+    A delivery attempt for a webhook message.
+
+    Each time Airweave attempts to deliver a message to your webhook endpoint,
+    a delivery attempt is recorded. Failed attempts are automatically retried
+    with exponential backoff.
+    """
+
+    id: str = pydantic.Field()
+    """
+    Unique identifier for this delivery attempt
+    """
+
+    message_id: str = pydantic.Field()
+    """
+    The event message that was being delivered
+    """
+
+    endpoint_id: str = pydantic.Field()
+    """
+    The subscription endpoint this was delivered to
+    """
+
+    response: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The response body returned by your webhook endpoint (truncated to 1KB)
+    """
+
+    response_status_code: int = pydantic.Field()
+    """
+    HTTP status code returned by your webhook endpoint. 2xx codes indicate success; other codes trigger retries.
+    """
+
+    status: str = pydantic.Field()
+    """
+    Delivery status: `success` (2xx response), `pending` (awaiting delivery), or `failed` (non-2xx response or timeout)
+    """
+
+    timestamp: dt.datetime = pydantic.Field()
+    """
+    When this delivery attempt occurred (ISO 8601 format, UTC)
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

airweave/types/event_message.py

@@ -0,0 +1,55 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .sync_event_payload import SyncEventPayload
+
+
+class EventMessage(UniversalBaseModel):
+    """
+    An event message that was sent (or attempted) to webhook subscribers.
+
+    The payload contains the actual event data matching the webhook delivery format.
+    """
+
+    id: str = pydantic.Field()
+    """
+    Unique identifier for this message (UUID format)
+    """
+
+    event_type: str = pydantic.Field()
+    """
+    The type of event (e.g., 'sync.completed', 'sync.failed')
+    """
+
+    payload: SyncEventPayload = pydantic.Field()
+    """
+    The event payload data, matching what is delivered to webhooks
+    """
+
+    timestamp: dt.datetime = pydantic.Field()
+    """
+    When this message was created (ISO 8601 format, UTC)
+    """
+
+    channels: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Channels this message was sent to (typically matches the event type)
+    """
+
+    tags: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Tags associated with this message for filtering
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

airweave/types/event_message_with_attempts.py

@@ -0,0 +1,59 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .delivery_attempt import DeliveryAttempt
+from .sync_event_payload import SyncEventPayload
+
+
+class EventMessageWithAttempts(UniversalBaseModel):
+    """
+    An event message with delivery attempts.
+    """
+
+    id: str = pydantic.Field()
+    """
+    Unique identifier for this message (UUID format)
+    """
+
+    event_type: str = pydantic.Field()
+    """
+    The type of event (e.g., 'sync.completed', 'sync.failed')
+    """
+
+    payload: SyncEventPayload = pydantic.Field()
+    """
+    The event payload data, matching what is delivered to webhooks
+    """
+
+    timestamp: dt.datetime = pydantic.Field()
+    """
+    When this message was created (ISO 8601 format, UTC)
+    """
+
+    channels: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Channels this message was sent to (typically matches the event type)
+    """
+
+    tags: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Tags associated with this message for filtering
+    """
+
+    delivery_attempts: typing.Optional[typing.List[DeliveryAttempt]] = pydantic.Field(default=None)
+    """
+    Delivery attempts for this message.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

airweave/types/{enable_endpoint_request.py → not_found_error_response.py}

@@ -1,18 +1,20 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
 import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class EnableEndpointRequest(UniversalBaseModel):
+class NotFoundErrorResponse(UniversalBaseModel):
     """
-    Request model for enabling an endpoint with optional recovery.
+    Response returned when a resource is not found (HTTP 404).
     """
 
-    recover_since: typing.Optional[dt.datetime] = None
+    detail: str = pydantic.Field()
+    """
+    Error message describing what was not found
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

airweave/types/{subscription_with_attempts_out.py → rate_limit_error_response.py}

@@ -4,17 +4,20 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .endpoint_out import EndpointOut
-from .message_attempt_out import MessageAttemptOut
 
 
-class SubscriptionWithAttemptsOut(UniversalBaseModel):
+class RateLimitErrorResponse(UniversalBaseModel):
     """
-    Response model for a subscription with its message attempts.
+    Response returned when rate limit is exceeded (HTTP 429).
+
+    The API enforces rate limits to ensure fair usage. When exceeded,
+    wait for the duration specified in the Retry-After header before retrying.
     """
 
-    endpoint: EndpointOut
-    message_attempts: typing.List[MessageAttemptOut]
+    detail: str = pydantic.Field()
+    """
+    Error message explaining the rate limit
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

airweave/types/recovery_task.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class RecoveryTask(UniversalBaseModel):
+    """
+    Information about a message recovery task.
+
+    When you trigger a recovery of failed messages, this object is returned
+    to track the recovery progress. The status indicates whether the recovery
+    is still in progress or has completed.
+    """
+
+    id: str = pydantic.Field()
+    """
+    Unique identifier for this recovery task (Svix internal ID)
+    """
+
+    status: str = pydantic.Field()
+    """
+    Recovery task status: 'running' or 'completed'
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

airweave/types/search_request.py

@@ -9,32 +9,35 @@ from .retrieval_strategy import RetrievalStrategy
 
 class SearchRequest(UniversalBaseModel):
     """
-    Search request schema.
+    Search request for querying a collection.
+
+    Provides fine-grained control over the search pipeline including retrieval strategy,
+    filtering, and AI-powered features like query expansion and answer generation.
     """
 
     query: str = pydantic.Field()
     """
-    The search query text
+    The search query text (required, max 2048 tokens)
     """
 
     retrieval_strategy: typing.Optional[RetrievalStrategy] = pydantic.Field(default=None)
     """
-    The retrieval strategy to use
+    Search strategy: 'hybrid' (default), 'neural' (semantic only), or 'keyword' (BM25 only)
     """
 
     filter: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
     """
-    Filter for metadata-based filtering
+    Structured filter for metadata-based filtering (Qdrant filter format)
     """
 
     offset: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Number of results to skip
+    Number of results to skip for pagination (default: 0)
     """
 
     limit: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Maximum number of results to return
+    Maximum number of results to return (default: 1000)
     """
 
     temporal_relevance: typing.Optional[float] = pydantic.Field(default=None)
@@ -44,22 +47,22 @@ class SearchRequest(UniversalBaseModel):
 
     expand_query: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Generate a few query variations to improve recall
+    Generate query variations to improve recall (default: true)
     """
 
     interpret_filters: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Extract structured filters from natural-language query
+    Extract structured filters from natural language (e.g., 'from last week' becomes a date filter)
     """
 
     rerank: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Reorder the top candidate results for improved relevance. Max number of results that can be reranked is capped to around 1000.
+    LLM-based reranking for improved relevance (default: true)
     """
 
     generate_answer: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Generate a natural-language answer to the query
+    Generate an AI answer based on search results (default: true)
     """
 
     if IS_PYDANTIC_V2:

airweave/types/search_response.py

@@ -8,17 +8,20 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 class SearchResponse(UniversalBaseModel):
     """
-    Comprehensive search response containing results and metadata.
+    Search response containing results and optional AI-generated completion.
+
+    Each result includes the matched entity's content, metadata, relevance score,
+    and source information.
     """
 
     results: typing.List[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field()
     """
-    Array of search result objects containing the found documents, records, or data entities.
+    Array of search result objects containing the found documents, records, or data entities. Each result includes entity_id, source_name, md_content, metadata, score, breadcrumbs, and url.
     """
 
     completion: typing.Optional[str] = pydantic.Field(default=None)
     """
-    This provides natural language answers to your query based on the content found across your connected data sources when generate_answer is true.
+    AI-generated natural language answer to your query based on the search results. Only included when generate_answer is true in the request.
     """
 
     if IS_PYDANTIC_V2:

airweave/types/source_connection.py

@@ -14,30 +14,85 @@ from .sync_details import SyncDetails
 
 class SourceConnection(UniversalBaseModel):
     """
-    Complete source connection details.
-    """
-
-    id: str
-    name: str
-    description: typing.Optional[str] = None
-    short_name: str
-    readable_collection_id: str
-    status: SourceConnectionStatus
-    created_at: dt.datetime
-    modified_at: dt.datetime
-    auth: AuthenticationDetails
-    config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    schedule: typing.Optional[ScheduleDetails] = None
-    sync: typing.Optional[SyncDetails] = None
+    Complete source connection details including auth, config, sync status, and entities.
+
+    This schema provides full information about a source connection, suitable for
+    detail views and monitoring sync progress.
+    """
+
+    id: str = pydantic.Field()
+    """
+    Unique identifier of the source connection
+    """
+
+    name: str = pydantic.Field()
+    """
+    Display name of the connection
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Optional description of the connection's purpose
+    """
+
+    short_name: str = pydantic.Field()
+    """
+    Source type identifier
+    """
+
+    readable_collection_id: str = pydantic.Field()
+    """
+    Collection this connection belongs to
+    """
+
+    status: SourceConnectionStatus = pydantic.Field()
+    """
+    Current operational status of the connection
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    When the connection was created (ISO 8601)
+    """
+
+    modified_at: dt.datetime = pydantic.Field()
+    """
+    When the connection was last modified (ISO 8601)
+    """
+
+    auth: AuthenticationDetails = pydantic.Field()
+    """
+    Authentication status and details
+    """
+
+    config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Source-specific configuration values
+    """
+
+    schedule: typing.Optional[ScheduleDetails] = pydantic.Field(default=None)
+    """
+    Sync schedule configuration
+    """
+
+    sync: typing.Optional[SyncDetails] = pydantic.Field(default=None)
+    """
+    Sync execution history and statistics
+    """
+
     sync_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    ID of the associated sync
+    ID of the associated sync (internal use)
+    """
+
+    entities: typing.Optional[EntitySummary] = pydantic.Field(default=None)
+    """
+    Summary of synced entities by type
     """
 
-    entities: typing.Optional[EntitySummary] = None
     federated_search: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Whether this source uses federated search
+    Whether this source uses federated (real-time) search instead of syncing
     """
 
     if IS_PYDANTIC_V2:

airweave/types/source_connection_job.py

@@ -10,21 +10,71 @@ from .sync_job_status import SyncJobStatus
 
 class SourceConnectionJob(UniversalBaseModel):
     """
-    Individual sync job for a source connection.
-    """
-
-    id: str
-    source_connection_id: str
-    status: SyncJobStatus
-    started_at: typing.Optional[dt.datetime] = None
-    completed_at: typing.Optional[dt.datetime] = None
-    duration_seconds: typing.Optional[float] = None
-    entities_inserted: typing.Optional[int] = None
-    entities_updated: typing.Optional[int] = None
-    entities_deleted: typing.Optional[int] = None
-    entities_failed: typing.Optional[int] = None
-    error: typing.Optional[str] = None
-    error_details: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    A sync job representing a single synchronization run.
+
+    Sync jobs track the execution of data synchronization from a source connection.
+    Each job includes timing information, entity counts, and error details if applicable.
+    """
+
+    id: str = pydantic.Field()
+    """
+    Unique identifier of the sync job
+    """
+
+    source_connection_id: str = pydantic.Field()
+    """
+    ID of the source connection this job belongs to
+    """
+
+    status: SyncJobStatus = pydantic.Field()
+    """
+    Current status: PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, or CANCELLING
+    """
+
+    started_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    When the job started execution (ISO 8601)
+    """
+
+    completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    When the job finished (ISO 8601). Null if still running.
+    """
+
+    duration_seconds: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total execution time in seconds. Null if still running.
+    """
+
+    entities_inserted: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of new entities created during this sync
+    """
+
+    entities_updated: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of existing entities updated during this sync
+    """
+
+    entities_deleted: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of entities removed during this sync
+    """
+
+    entities_failed: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of entities that failed to process
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message if the job failed
+    """
+
+    error_details: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Additional error context for debugging
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

airweave/types/source_connection_list_item.py

@@ -11,20 +11,55 @@ from .source_connection_status import SourceConnectionStatus
 
 class SourceConnectionListItem(UniversalBaseModel):
     """
-    Clean source connection for list views.
+    Lightweight source connection representation for list views.
+
+    Contains essential fields for display and navigation. For full details
+    including sync history and configuration, use the GET /{id} endpoint.
+    """
+
+    id: str = pydantic.Field()
+    """
+    Unique identifier of the source connection
+    """
+
+    name: str = pydantic.Field()
+    """
+    Display name of the connection
+    """
+
+    short_name: str = pydantic.Field()
+    """
+    Source type identifier
+    """
+
+    readable_collection_id: str = pydantic.Field()
+    """
+    Collection this connection belongs to
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    When the connection was created (ISO 8601)
+    """
+
+    modified_at: dt.datetime = pydantic.Field()
+    """
+    When the connection was last modified (ISO 8601)
+    """
+
+    is_authenticated: bool = pydantic.Field()
+    """
+    Whether the connection has valid credentials
+    """
+
+    entity_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of entities synced from this connection
     """
 
-    id: str
-    name: str
-    short_name: str
-    readable_collection_id: str
-    created_at: dt.datetime
-    modified_at: dt.datetime
-    is_authenticated: bool
-    entity_count: typing.Optional[int] = None
     federated_search: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Whether this source uses federated search
+    Whether this source uses federated (real-time) search instead of syncing
     """
 
     auth_method: AuthenticationMethod = pydantic.Field()