claix-ai 1.0.0__tar.gz

claix_ai-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+dist/
+build/
+.venv/
+venv/
+*.whl
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.DS_Store

claix_ai-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Claix / ANAYA CARBALLO GAEL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

claix_ai-1.0.0/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.5
+Name: claix-ai
+Version: 1.0.0
+Summary: Official Python SDK for the Claix document intelligence API (OpenAPI 1.8.2). Typed extraction, document memory, knowledge spaces, and agent-framework tools.
+Project-URL: Homepage, https://www.claix.dev
+Project-URL: Documentation, https://www.claix.dev/documentation
+Project-URL: OpenAPI, https://www.claix.dev/openapi.yaml
+Project-URL: Source, https://github.com/Gaelproodoos/claix-interfaz
+Author-email: Claix <info@claix.dev>
+License: MIT License
+        
+        Copyright (c) 2026 Claix / ANAYA CARBALLO GAEL
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: a2a,ai-agents,claix,crewai,document-intelligence,excel-to-json,langchain,langgraph,llamaindex,pdf-to-json
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.6.0
+Provides-Extra: all
+Requires-Dist: crewai>=0.1.0; extra == 'all'
+Requires-Dist: langchain-core>=0.3.0; extra == 'all'
+Requires-Dist: llama-index-core>=0.10.0; extra == 'all'
+Provides-Extra: crewai
+Requires-Dist: crewai>=0.1.0; extra == 'crewai'
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.3.0; extra == 'langchain'
+Provides-Extra: llamaindex
+Requires-Dist: llama-index-core>=0.10.0; extra == 'llamaindex'
+Description-Content-Type: text/markdown
+
+# Claix Python SDK
+
+[![PyPI](https://img.shields.io/pypi/v/claix-ai.svg)](https://pypi.org/project/claix-ai/)
+[![Python](https://img.shields.io/pypi/pyversions/claix-ai.svg)](https://pypi.org/project/claix-ai/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+Official typed Python client for the [Claix](https://www.claix.dev) document intelligence API (**OpenAPI 1.8.2**).
+
+Extract PDFs, Excel, Word, images, and text into schema-validated JSON. Query persisted documents and knowledge spaces. Drop the same client into **LangChain / LangGraph**, **CrewAI**, and **LlamaIndex**.
+
+- Docs: https://www.claix.dev/documentation
+- OpenAPI: https://www.claix.dev/openapi.yaml
+- Agent Card: https://claix.dev/.well-known/agent.json
+
+## Install
+
+```bash
+pip install claix-ai
+pip install 'claix-ai[langchain]'
+pip install 'claix-ai[crewai]'
+pip install 'claix-ai[llamaindex]'
+pip install 'claix-ai[all]'
+```
+
+Requires **Python ≥ 3.10**. Set `CLAIX_API_KEY` or pass `api_key=` to the client.
+
+## Quickstart
+
+```python
+from claix import ClaixClient
+
+client = ClaixClient()  # reads CLAIX_API_KEY
+result = client.extract.pdf("invoice.pdf", schema_id="3c7a9f21-4b8e-4d1a-9c6f-2e0d8a5b7c4f")
+print(result.data)
+```
+
+Async:
+
+```python
+from claix import AsyncClaixClient
+
+async with AsyncClaixClient() as client:
+    doc = await client.extract.pdf("invoice.pdf", schema_id="...")
+    answers = await client.context.ask(doc.document_id, ["What is the total?"])
+```
+
+## Extraction, context, and spaces
+
+```python
+from claix import ClaixClient
+
+client = ClaixClient(api_key="ck_...")
+
+# Standard extraction → POST https://claix.dev/api/pdf-json
+extracted = client.extract.pdf("scan.pdf", schema_id="...", space_id=None, is_agent_mode=False)
+
+# Agent Mode → POST https://claix.dev/agent/pdf-json
+agented = client.extract.pdf("contract.pdf", schema_id="...", is_agent_mode=True)
+print(agented.agent_data)
+
+space = client.spaces.create("Vendors 2026")
+client.extract.excel("ledger.xlsx", schema_id="...", space_id=space.space.space_id)
+
+# Cross-document Q&A — ia_response is list[str | None] (native null when missing)
+qa = client.spaces.ask(space.space.space_id, ["Which vendor billed the most?"])
+print(qa.user_ask, qa.ia_response)
+```
+
+## LangGraph (ReAct)
+
+```python
+from claix import ClaixClient
+from claix.integrations.langchain import (
+    ClaixDocumentContextTool,
+    ClaixExtractTool,
+    ClaixSpaceContextTool,
+)
+from langgraph.prebuilt import create_react_agent
+
+client = ClaixClient()
+tools = [
+    ClaixExtractTool(client=client),
+    ClaixDocumentContextTool(client=client),
+    ClaixSpaceContextTool(client=client),
+]
+agent = create_react_agent("openai:gpt-4.1", tools)
+agent.invoke({
+    "messages": [{
+        "role": "user",
+        "content": "Extract invoice.pdf with schema 3c7a9f21-4b8e-4d1a-9c6f-2e0d8a5b7c4f, "
+                   "then ask the document_id for the VAT total.",
+    }]
+})
+```
+
+`create_react_agent` builds a StateGraph that loops until the model stops calling tools. `ClaixSpaceContextTool` is the right primitive for multi-file nodes (compare, sum, reconcile under a `space_id`).
+
+## CrewAI
+
+```python
+from crewai import Agent, Crew, Task
+from claix import ClaixClient
+from claix.integrations.crewai import ClaixDocumentTool, ClaixKnowledgeSpaceTool
+
+client = ClaixClient()
+analyst = Agent(
+    role="Document auditor",
+    goal="Extract contracts and reconcile them against invoices",
+    backstory="You never guess missing fields; you trust Claix nulls.",
+    tools=[ClaixDocumentTool(client=client), ClaixKnowledgeSpaceTool(client=client)],
+)
+task = Task(
+    description="Extract contracts/ and invoices/ into space {space_id}, then list discrepancies.",
+    expected_output="A JSON list of mismatches. Use null when a field is absent.",
+    agent=analyst,
+)
+Crew(agents=[analyst], tasks=[task]).kickoff()
+```
+
+## LlamaIndex
+
+```python
+from claix import ClaixClient
+from claix.integrations.llamaindex import ClaixToolSpec
+
+spec = ClaixToolSpec(client=ClaixClient())
+tools = spec.to_tool_list()  # extract_document, ask_document, ask_knowledge_space
+```
+
+## SDK map (OpenAPI 1.8.2)
+
+| SDK method | HTTP |
+| --- | --- |
+| `client.extract.pdf(file, schema_id, space_id=None, is_agent_mode=False)` | `POST /api/pdf-json` or `POST /agent/pdf-json` |
+| `client.extract.excel(...)` | `POST /api/excel-json` or `POST /agent/excel-json` |
+| `client.extract.document(...)` | `POST /api/doc-json` or `POST /agent/doc-json` |
+| `client.extract.image(...)` | `POST /api/img-json` or `POST /agent/img-json` |
+| `client.extract.text(content, schema_id, ...)` | `POST /api/txt-json` or `POST /agent/txt-json` |
+| `client.extract.json_to_excel(schema_id=..., data=...)` | `POST /api/json-excel` (binary `.xlsx`) |
+| `client.context.get(document_id)` | `GET https://claix.dev/get-document/{document_id}` |
+| `client.context.ask(document_id, questions)` | `POST https://claix.dev/document-context/{document_id}` (max 5 × 400 chars) |
+| `client.context.delete(document_id)` | `DELETE https://claix.dev/delete-document/{document_id}` |
+| `client.spaces.create(name)` | `POST https://claix.dev/create-space` |
+| `client.spaces.ask(space_id, questions)` | `POST https://claix.dev/space-context/{space_id}` |
+| `client.spaces.delete(space_id)` | `DELETE https://claix.dev/delete-space/{space_id}` |
+| `client.schemas.list()` | `GET /api/schemas` |
+| `client.schemas.create(name, type, schema_definition, ...)` | `POST /api/create-schema` |
+| `client.schemas.delete(schema_id)` | `POST /api/delete-schema` |
+
+Auth header: `x-api-key` (Bearer is also accepted by the API). Default timeout 120s, with retries on 429/502/503/504 and transport errors.
+
+`WindowContextSuccessResponse.ia_response` and `SpaceContextSuccessResponse.ia_response` are typed as `list[str | None]` so orchestrators can branch on deterministic `null`.
+
+## Errors
+
+`ClaixAuthenticationError` (401), `ClaixNotFoundError` (404), `ClaixValidationError` (400/413/422), `ClaixRateLimitError` (429), `ClaixTimeoutError`, `ClaixConnectionError`, `ClaixAPIError` (5xx). All subclass `ClaixError` and expose `status_code` plus the `{error, detalle}` payload.
+
+## License
+
+MIT

claix_ai-1.0.0/README.md

@@ -0,0 +1,160 @@
+# Claix Python SDK
+
+[![PyPI](https://img.shields.io/pypi/v/claix-ai.svg)](https://pypi.org/project/claix-ai/)
+[![Python](https://img.shields.io/pypi/pyversions/claix-ai.svg)](https://pypi.org/project/claix-ai/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+Official typed Python client for the [Claix](https://www.claix.dev) document intelligence API (**OpenAPI 1.8.2**).
+
+Extract PDFs, Excel, Word, images, and text into schema-validated JSON. Query persisted documents and knowledge spaces. Drop the same client into **LangChain / LangGraph**, **CrewAI**, and **LlamaIndex**.
+
+- Docs: https://www.claix.dev/documentation
+- OpenAPI: https://www.claix.dev/openapi.yaml
+- Agent Card: https://claix.dev/.well-known/agent.json
+
+## Install
+
+```bash
+pip install claix-ai
+pip install 'claix-ai[langchain]'
+pip install 'claix-ai[crewai]'
+pip install 'claix-ai[llamaindex]'
+pip install 'claix-ai[all]'
+```
+
+Requires **Python ≥ 3.10**. Set `CLAIX_API_KEY` or pass `api_key=` to the client.
+
+## Quickstart
+
+```python
+from claix import ClaixClient
+
+client = ClaixClient()  # reads CLAIX_API_KEY
+result = client.extract.pdf("invoice.pdf", schema_id="3c7a9f21-4b8e-4d1a-9c6f-2e0d8a5b7c4f")
+print(result.data)
+```
+
+Async:
+
+```python
+from claix import AsyncClaixClient
+
+async with AsyncClaixClient() as client:
+    doc = await client.extract.pdf("invoice.pdf", schema_id="...")
+    answers = await client.context.ask(doc.document_id, ["What is the total?"])
+```
+
+## Extraction, context, and spaces
+
+```python
+from claix import ClaixClient
+
+client = ClaixClient(api_key="ck_...")
+
+# Standard extraction → POST https://claix.dev/api/pdf-json
+extracted = client.extract.pdf("scan.pdf", schema_id="...", space_id=None, is_agent_mode=False)
+
+# Agent Mode → POST https://claix.dev/agent/pdf-json
+agented = client.extract.pdf("contract.pdf", schema_id="...", is_agent_mode=True)
+print(agented.agent_data)
+
+space = client.spaces.create("Vendors 2026")
+client.extract.excel("ledger.xlsx", schema_id="...", space_id=space.space.space_id)
+
+# Cross-document Q&A — ia_response is list[str | None] (native null when missing)
+qa = client.spaces.ask(space.space.space_id, ["Which vendor billed the most?"])
+print(qa.user_ask, qa.ia_response)
+```
+
+## LangGraph (ReAct)
+
+```python
+from claix import ClaixClient
+from claix.integrations.langchain import (
+    ClaixDocumentContextTool,
+    ClaixExtractTool,
+    ClaixSpaceContextTool,
+)
+from langgraph.prebuilt import create_react_agent
+
+client = ClaixClient()
+tools = [
+    ClaixExtractTool(client=client),
+    ClaixDocumentContextTool(client=client),
+    ClaixSpaceContextTool(client=client),
+]
+agent = create_react_agent("openai:gpt-4.1", tools)
+agent.invoke({
+    "messages": [{
+        "role": "user",
+        "content": "Extract invoice.pdf with schema 3c7a9f21-4b8e-4d1a-9c6f-2e0d8a5b7c4f, "
+                   "then ask the document_id for the VAT total.",
+    }]
+})
+```
+
+`create_react_agent` builds a StateGraph that loops until the model stops calling tools. `ClaixSpaceContextTool` is the right primitive for multi-file nodes (compare, sum, reconcile under a `space_id`).
+
+## CrewAI
+
+```python
+from crewai import Agent, Crew, Task
+from claix import ClaixClient
+from claix.integrations.crewai import ClaixDocumentTool, ClaixKnowledgeSpaceTool
+
+client = ClaixClient()
+analyst = Agent(
+    role="Document auditor",
+    goal="Extract contracts and reconcile them against invoices",
+    backstory="You never guess missing fields; you trust Claix nulls.",
+    tools=[ClaixDocumentTool(client=client), ClaixKnowledgeSpaceTool(client=client)],
+)
+task = Task(
+    description="Extract contracts/ and invoices/ into space {space_id}, then list discrepancies.",
+    expected_output="A JSON list of mismatches. Use null when a field is absent.",
+    agent=analyst,
+)
+Crew(agents=[analyst], tasks=[task]).kickoff()
+```
+
+## LlamaIndex
+
+```python
+from claix import ClaixClient
+from claix.integrations.llamaindex import ClaixToolSpec
+
+spec = ClaixToolSpec(client=ClaixClient())
+tools = spec.to_tool_list()  # extract_document, ask_document, ask_knowledge_space
+```
+
+## SDK map (OpenAPI 1.8.2)
+
+| SDK method | HTTP |
+| --- | --- |
+| `client.extract.pdf(file, schema_id, space_id=None, is_agent_mode=False)` | `POST /api/pdf-json` or `POST /agent/pdf-json` |
+| `client.extract.excel(...)` | `POST /api/excel-json` or `POST /agent/excel-json` |
+| `client.extract.document(...)` | `POST /api/doc-json` or `POST /agent/doc-json` |
+| `client.extract.image(...)` | `POST /api/img-json` or `POST /agent/img-json` |
+| `client.extract.text(content, schema_id, ...)` | `POST /api/txt-json` or `POST /agent/txt-json` |
+| `client.extract.json_to_excel(schema_id=..., data=...)` | `POST /api/json-excel` (binary `.xlsx`) |
+| `client.context.get(document_id)` | `GET https://claix.dev/get-document/{document_id}` |
+| `client.context.ask(document_id, questions)` | `POST https://claix.dev/document-context/{document_id}` (max 5 × 400 chars) |
+| `client.context.delete(document_id)` | `DELETE https://claix.dev/delete-document/{document_id}` |
+| `client.spaces.create(name)` | `POST https://claix.dev/create-space` |
+| `client.spaces.ask(space_id, questions)` | `POST https://claix.dev/space-context/{space_id}` |
+| `client.spaces.delete(space_id)` | `DELETE https://claix.dev/delete-space/{space_id}` |
+| `client.schemas.list()` | `GET /api/schemas` |
+| `client.schemas.create(name, type, schema_definition, ...)` | `POST /api/create-schema` |
+| `client.schemas.delete(schema_id)` | `POST /api/delete-schema` |
+
+Auth header: `x-api-key` (Bearer is also accepted by the API). Default timeout 120s, with retries on 429/502/503/504 and transport errors.
+
+`WindowContextSuccessResponse.ia_response` and `SpaceContextSuccessResponse.ia_response` are typed as `list[str | None]` so orchestrators can branch on deterministic `null`.
+
+## Errors
+
+`ClaixAuthenticationError` (401), `ClaixNotFoundError` (404), `ClaixValidationError` (400/413/422), `ClaixRateLimitError` (429), `ClaixTimeoutError`, `ClaixConnectionError`, `ClaixAPIError` (5xx). All subclass `ClaixError` and expose `status_code` plus the `{error, detalle}` payload.
+
+## License
+
+MIT

claix_ai-1.0.0/claix/__init__.py

@@ -0,0 +1,70 @@
+"""Official Claix Python SDK (OpenAPI 1.8.2)."""
+
+from __future__ import annotations
+
+from claix.client import AsyncClaixClient, ClaixClient
+from claix.exceptions import (
+    ClaixAPIError,
+    ClaixAuthenticationError,
+    ClaixConnectionError,
+    ClaixError,
+    ClaixNotFoundError,
+    ClaixRateLimitError,
+    ClaixTimeoutError,
+    ClaixValidationError,
+)
+from claix.models import (
+    AgentDocJsonSuccessResponse,
+    AgentExcelJsonSuccessResponse,
+    AgentImgJsonSuccessResponse,
+    AgentPdfJsonSuccessResponse,
+    CreateSchemaResponse,
+    CreateSpaceSuccessResponse,
+    DeleteDocumentSuccessResponse,
+    DeleteSchemaResponse,
+    DeleteSpaceSuccessResponse,
+    DocJsonSuccessResponse,
+    ErrorResponse,
+    ExcelJsonSuccessResponse,
+    GetDocumentSuccessResponse,
+    ImgJsonSuccessResponse,
+    PdfJsonSuccessResponse,
+    SchemaItem,
+    SchemasListResponse,
+    SpaceContextSuccessResponse,
+    WindowContextSuccessResponse,
+)
+
+__all__ = [
+    "AsyncClaixClient",
+    "ClaixAPIError",
+    "ClaixAuthenticationError",
+    "ClaixClient",
+    "ClaixConnectionError",
+    "ClaixError",
+    "ClaixNotFoundError",
+    "ClaixRateLimitError",
+    "ClaixTimeoutError",
+    "ClaixValidationError",
+    "AgentDocJsonSuccessResponse",
+    "AgentExcelJsonSuccessResponse",
+    "AgentImgJsonSuccessResponse",
+    "AgentPdfJsonSuccessResponse",
+    "CreateSchemaResponse",
+    "CreateSpaceSuccessResponse",
+    "DeleteDocumentSuccessResponse",
+    "DeleteSchemaResponse",
+    "DeleteSpaceSuccessResponse",
+    "DocJsonSuccessResponse",
+    "ErrorResponse",
+    "ExcelJsonSuccessResponse",
+    "GetDocumentSuccessResponse",
+    "ImgJsonSuccessResponse",
+    "PdfJsonSuccessResponse",
+    "SchemaItem",
+    "SchemasListResponse",
+    "SpaceContextSuccessResponse",
+    "WindowContextSuccessResponse",
+]
+
+__version__ = "1.0.0"