interfaze 1.0.1__tar.gz

interfaze-1.0.1/.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: Install (all extras)
+        run: uv sync --all-extras
+      - name: Lint (ruff)
+        run: uv run ruff check src tests scripts
+      - name: Type check (mypy --strict)
+        if: matrix.python-version == '3.12'
+        run: uv run mypy
+      - name: Unit tests
+        run: uv run pytest -q
+
+  test-core-py39:
+    name: test (py3.9, core only)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.9"
+          enable-cache: true
+      # langchain-openai is gated python_version>='3.10', so it's skipped on 3.9 and its tests no-op.
+      - name: Install (dev extras; langchain skipped on 3.9)
+        run: uv sync --extra dev
+      - name: Lint (ruff)
+        run: uv run ruff check src tests scripts
+      - name: Unit tests
+        run: uv run pytest -q
+
+  secret-scan:
+    name: secret scan (gitleaks)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Scan working tree for leaked tokens/secrets
+        run: |
+          curl -sSfL "https://github.com/gitleaks/gitleaks/releases/download/v8.21.2/gitleaks_8.21.2_linux_x64.tar.gz" | tar -xz gitleaks
+          ./gitleaks dir . --redact --no-banner

interfaze-1.0.1/.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - name: Build sdist + wheel
+        run: uv build
+      - name: Verify metadata
+        run: uvx twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  testpypi:
+    needs: build
+    if: github.event.release.prerelease == true
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/interfaze
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  pypi:
+    needs: build
+    if: github.event.release.prerelease == false
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/interfaze
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

interfaze-1.0.1/.github/workflows/qa-live.yml

@@ -0,0 +1,29 @@
+name: Live QA
+
+# Live e2e against the real API; gated on the INTERFAZE_API_KEY secret (never on PRs).
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 6 * * 1" # weekly, Monday 06:00 UTC
+
+concurrency:
+  group: live-qa
+  cancel-in-progress: true
+
+jobs:
+  live-qa:
+    name: live QA (multimodal + token usage + tasks)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+          enable-cache: true
+      - name: Install
+        run: uv sync
+      - name: Run live QA
+        env:
+          INTERFAZE_API_KEY: ${{ secrets.INTERFAZE_API_KEY }}
+        run: uv run python scripts/qa_live.py

interfaze-1.0.1/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

interfaze-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JigsawStack
+
+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.

interfaze-1.0.1/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: interfaze
+Version: 1.0.1
+Summary: Official Interfaze SDK.
+Project-URL: Homepage, https://interfaze.ai
+Project-URL: Repository, https://github.com/InterfazeAI/interfaze-python
+Author: Interfaze
+License: MIT
+License-File: LICENSE
+Keywords: ai,interfaze,ocr,openai,sdk,speech-to-text,web-search
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: openai<3,>=2
+Provides-Extra: dev
+Requires-Dist: langchain-openai>=1.3.5; (python_version >= '3.10') and extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pydantic>=2; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: langchain
+Requires-Dist: langchain-openai>=1.3.5; (python_version >= '3.10') and extra == 'langchain'
+Description-Content-Type: text/markdown
+
+# interfaze-python
+
+The official [Interfaze](https://interfaze.ai) SDK for Python.
+
+- **Familiar chat surface** - `chat.completions`, streaming, tools, and structured output.
+- **Typed Interfaze extras** - `precontext` (internal tool output), `reasoning`, and `vcache` (semantic-cache hit) on every response.
+- **One-line task helpers** - OCR, web search, scraping, speech-to-text, translation, object/GUI detection, forecasting.
+- **Multimodal inputs** - images, PDFs, audio, video, and CSV, by URL or base64.
+- **Sync and async**, fully typed.
+
+## Learn more
+
+- [interfaze.ai](https://interfaze.ai) - dashboard and API keys.
+- [TypeScript / JavaScript SDK](https://github.com/InterfazeAI/interfaze-js).
+
+## Capabilities
+
+| Category         | Capabilities                                                |
+| ---------------- | ----------------------------------------------------------- |
+| **Chat & text**  | Chat completions, structured output, tools, reasoning       |
+| **Vision & OCR** | `tasks.ocr` - text and structured data from images and PDFs |
+| **Web**          | `tasks.web_search`, `tasks.scrape`                          |
+| **Audio**        | `tasks.transcribe` - speech-to-text                         |
+| **Detection**    | `tasks.object_detection`, `tasks.gui_detection`              |
+| **Translation**  | `tasks.translate`                                           |
+| **Forecasting**  | `tasks.forecast` - time-series prediction                   |
+
+## Install
+
+```bash
+pip install interfaze
+```
+
+## Setup
+
+Get an API key from the [Interfaze dashboard](https://interfaze.ai), then:
+
+```python
+from interfaze import Interfaze
+
+interfaze = Interfaze(api_key="sk_...")  # or set INTERFAZE_API_KEY and call Interfaze()
+```
+
+Async is identical via `AsyncInterfaze` (every call becomes `await`-able).
+
+## Usage
+
+Chat completion:
+
+```python
+res = interfaze.chat.completions.create(
+    messages=[{"role": "user", "content": "Write a haiku about deterministic AI."}],
+)
+print(res.choices[0].message.content)
+print("cache hit:", res.vcache)          # typed Interfaze extra
+```
+
+Task helpers - each returns the extracted result directly (a `dict`/`list`/`str`, not a completion):
+
+```python
+interfaze.tasks.ocr("https://example.com/receipt.jpg")
+interfaze.tasks.web_search("latest AI agent news")
+interfaze.tasks.transcribe("https://example.com/audio.wav")
+interfaze.tasks.scrape("https://example.com/product")
+interfaze.tasks.translate("Hello", to="French")
+interfaze.tasks.object_detection("https://example.com/photo.jpg")
+interfaze.tasks.gui_detection("https://example.com/screenshot.png")
+interfaze.tasks.forecast("https://example.com/series.csv", periods=30)
+```
+
+Structured output:
+
+```python
+from interfaze import response_format
+
+res = interfaze.chat.completions.create(
+    messages=[{"role": "user", "content": "Weather in Tokyo?"}],
+    response_format=response_format({
+        "type": "object",
+        "properties": {"city": {"type": "string"}, "temp_c": {"type": "number"}},
+        "required": ["city", "temp_c"],
+    }),
+)
+```
+
+Streaming - `.stream()` yields typed events, with the inline `<think>`/`<precontext>` side-channels
+stripped from the content events:
+
+```python
+stream = interfaze.chat.completions.stream(
+    messages=[{"role": "user", "content": "Tell me a story."}],
+)
+for event in stream:
+    if event.type == "content.delta":
+        print(event.delta, end="")
+final = stream.get_final_completion()
+```
+
+> `stream.text_deltas()` yields clean visible text only; `create(stream=True)` returns the raw
+> chunk iterator (side-channel tags not stripped).
+
+## Inputs
+
+```python
+from interfaze import inputs
+
+inputs.image("https://…/a.png")             # image_url part
+inputs.file("https://…/doc.pdf")            # file part (pdf/csv/xml/json/text/video…)
+inputs.audio("https://…/a.wav")             # input_audio part
+inputs.data_url(raw_bytes, "image/png")     # base64 data URI
+inputs.from_path("./doc.pdf")               # read a local file
+```
+
+URLs and base64 both work; `image/gif` and `image/avif` are rejected client-side.
+
+## Interfaze extras
+
+- `res.precontext` - raw outputs of any internal tools that ran (OCR/web/scrape/STT/forecast/…).
+- `res.reasoning` - reasoning text (with `reasoning_effort="high"` and no schema).
+- `res.vcache` - whether the semantic cache was hit.
+- `reasoning_effort` also accepts `"on"`/`"off"`/`"auto"`.
+- Guardrails: `create(guard=["S1", "S12_IMAGE"], …)`.
+- Control options: `Interfaze(show_additional_info=..., bypass_moe=..., bypass_cache=..., admin_key=...)`.
+
+## LangChain
+
+`pip install interfaze[langchain]` adds a chat model pointed at Interfaze that keeps the extras a stock `ChatOpenAI` drops:
+
+```python
+from interfaze.langchain import ChatInterfaze
+
+llm = ChatInterfaze()  # reads INTERFAZE_API_KEY
+res = llm.invoke("Summarize the latest AI news")
+print(res.response_metadata.get("precontext"), res.response_metadata.get("vcache"))
+```
+
+`precontext`/`reasoning`/`vcache` land on `response_metadata`, `{"type": "video", ...}` content blocks are accepted, and inline side-channel tags are stripped.
+
+## License
+
+MIT

interfaze-1.0.1/README.md

@@ -0,0 +1,141 @@
+# interfaze-python
+
+The official [Interfaze](https://interfaze.ai) SDK for Python.
+
+- **Familiar chat surface** - `chat.completions`, streaming, tools, and structured output.
+- **Typed Interfaze extras** - `precontext` (internal tool output), `reasoning`, and `vcache` (semantic-cache hit) on every response.
+- **One-line task helpers** - OCR, web search, scraping, speech-to-text, translation, object/GUI detection, forecasting.
+- **Multimodal inputs** - images, PDFs, audio, video, and CSV, by URL or base64.
+- **Sync and async**, fully typed.
+
+## Learn more
+
+- [interfaze.ai](https://interfaze.ai) - dashboard and API keys.
+- [TypeScript / JavaScript SDK](https://github.com/InterfazeAI/interfaze-js).
+
+## Capabilities
+
+| Category         | Capabilities                                                |
+| ---------------- | ----------------------------------------------------------- |
+| **Chat & text**  | Chat completions, structured output, tools, reasoning       |
+| **Vision & OCR** | `tasks.ocr` - text and structured data from images and PDFs |
+| **Web**          | `tasks.web_search`, `tasks.scrape`                          |
+| **Audio**        | `tasks.transcribe` - speech-to-text                         |
+| **Detection**    | `tasks.object_detection`, `tasks.gui_detection`              |
+| **Translation**  | `tasks.translate`                                           |
+| **Forecasting**  | `tasks.forecast` - time-series prediction                   |
+
+## Install
+
+```bash
+pip install interfaze
+```
+
+## Setup
+
+Get an API key from the [Interfaze dashboard](https://interfaze.ai), then:
+
+```python
+from interfaze import Interfaze
+
+interfaze = Interfaze(api_key="sk_...")  # or set INTERFAZE_API_KEY and call Interfaze()
+```
+
+Async is identical via `AsyncInterfaze` (every call becomes `await`-able).
+
+## Usage
+
+Chat completion:
+
+```python
+res = interfaze.chat.completions.create(
+    messages=[{"role": "user", "content": "Write a haiku about deterministic AI."}],
+)
+print(res.choices[0].message.content)
+print("cache hit:", res.vcache)          # typed Interfaze extra
+```
+
+Task helpers - each returns the extracted result directly (a `dict`/`list`/`str`, not a completion):
+
+```python
+interfaze.tasks.ocr("https://example.com/receipt.jpg")
+interfaze.tasks.web_search("latest AI agent news")
+interfaze.tasks.transcribe("https://example.com/audio.wav")
+interfaze.tasks.scrape("https://example.com/product")
+interfaze.tasks.translate("Hello", to="French")
+interfaze.tasks.object_detection("https://example.com/photo.jpg")
+interfaze.tasks.gui_detection("https://example.com/screenshot.png")
+interfaze.tasks.forecast("https://example.com/series.csv", periods=30)
+```
+
+Structured output:
+
+```python
+from interfaze import response_format
+
+res = interfaze.chat.completions.create(
+    messages=[{"role": "user", "content": "Weather in Tokyo?"}],
+    response_format=response_format({
+        "type": "object",
+        "properties": {"city": {"type": "string"}, "temp_c": {"type": "number"}},
+        "required": ["city", "temp_c"],
+    }),
+)
+```
+
+Streaming - `.stream()` yields typed events, with the inline `<think>`/`<precontext>` side-channels
+stripped from the content events:
+
+```python
+stream = interfaze.chat.completions.stream(
+    messages=[{"role": "user", "content": "Tell me a story."}],
+)
+for event in stream:
+    if event.type == "content.delta":
+        print(event.delta, end="")
+final = stream.get_final_completion()
+```
+
+> `stream.text_deltas()` yields clean visible text only; `create(stream=True)` returns the raw
+> chunk iterator (side-channel tags not stripped).
+
+## Inputs
+
+```python
+from interfaze import inputs
+
+inputs.image("https://…/a.png")             # image_url part
+inputs.file("https://…/doc.pdf")            # file part (pdf/csv/xml/json/text/video…)
+inputs.audio("https://…/a.wav")             # input_audio part
+inputs.data_url(raw_bytes, "image/png")     # base64 data URI
+inputs.from_path("./doc.pdf")               # read a local file
+```
+
+URLs and base64 both work; `image/gif` and `image/avif` are rejected client-side.
+
+## Interfaze extras
+
+- `res.precontext` - raw outputs of any internal tools that ran (OCR/web/scrape/STT/forecast/…).
+- `res.reasoning` - reasoning text (with `reasoning_effort="high"` and no schema).
+- `res.vcache` - whether the semantic cache was hit.
+- `reasoning_effort` also accepts `"on"`/`"off"`/`"auto"`.
+- Guardrails: `create(guard=["S1", "S12_IMAGE"], …)`.
+- Control options: `Interfaze(show_additional_info=..., bypass_moe=..., bypass_cache=..., admin_key=...)`.
+
+## LangChain
+
+`pip install interfaze[langchain]` adds a chat model pointed at Interfaze that keeps the extras a stock `ChatOpenAI` drops:
+
+```python
+from interfaze.langchain import ChatInterfaze
+
+llm = ChatInterfaze()  # reads INTERFAZE_API_KEY
+res = llm.invoke("Summarize the latest AI news")
+print(res.response_metadata.get("precontext"), res.response_metadata.get("vcache"))
+```
+
+`precontext`/`reasoning`/`vcache` land on `response_metadata`, `{"type": "video", ...}` content blocks are accepted, and inline side-channel tags are stripped.
+
+## License
+
+MIT