Skip to main content

Async client for SVO semantic chunker microservice.

Project description

svo-client

Async Python client for the SVO semantic chunker. Canonical API: SvoChunkerClient (adapter / JsonRpcClient only).

Install

pip install -e .
# or: pip install svo-client

Quick start

import asyncio
from svo_client import SvoChunkerClient

async def main():
    async with SvoChunkerClient(
        protocol="mtls",
        host="127.0.0.1",
        port=8009,
        cert="mtls_certificates/client/svo-chunker.crt",
        key="mtls_certificates/client/svo-chunker.key",
        ca="mtls_certificates/ca/ca.crt",
        check_hostname=False,
    ) as client:
        chunks = await client.chunk(
            text="Your text.",
            chunk_type="Comment",
            aggregation_mode="paragraph",
            respect_structural_blocks=True,
            language="en",
        )
        print(len(chunks))

asyncio.run(main())

Current Chunker Parameters

  • chunk_type="Comment" is passed as RPC field type="Comment" for comments, docstrings, or other pre-extracted blocks. The server owns the Comment keep-block policy.
  • aggregation_mode is optional. Supported values are "sentence", "none", and "paragraph". When omitted, the client does not send the field.
  • respect_structural_blocks is optional. Use True or False to send respect_structural_blocks; omit it to preserve the server default.
from svo_client import build_file_chunk_params
from svo_client.file_processor import file_chunk_from_local_path

chunks = await client.chunk(
    text="# module comment",
    chunk_type="Comment",
    aggregation_mode="paragraph",
    respect_structural_blocks=True,
)

batch = await client.chunk_batch(
    ["first paragraph", "second paragraph"],
    aggregation_mode="paragraph",
    respect_structural_blocks=False,
)

params = build_file_chunk_params(
    filename="comments.py",
    file_content_base64=encoded,
    chunk_type="Comment",
    aggregation_mode="paragraph",
    respect_structural_blocks=True,
)
result = await client.file_chunk(params)

result = await file_chunk_from_local_path(
    client,
    "comments.py",
    chunk_type="Comment",
    aggregation_mode="paragraph",
    respect_structural_blocks=True,
)

CLI: svo-client or python -m svo_client — thin wrapper; local file chunking orchestration is file_chunk_from_local_path in svo_client.file_processor. Text chunking: chunk (default) and chunk text; file chunking: chunk file or file-chunk (alias); ws prints inbound WebSocket JSON lines to stdout. --help lists all flags. RPC discovery: svo-chunker (list / help / run).

svo-client chunk text -i sample.txt -o out.json --format json --chunk-type Comment
svo-client file-chunk -i sample.md -o out.jsonl --aggregation-mode paragraph --respect-structural-blocks
svo-client file-chunk -i comments.py --no-download --chunk-type Comment --no-respect-structural-blocks

Configuration precedence (CLISVO_CHUNKER_CLIENT_*JSON), --config, and CLI details (ws, --quiet-status, file-chunk status on stderr): svo_client/README.md.

Tests

.venv/bin/python -m pytest tests/ -q

Live integration (chunker on 127.0.0.1:8009): port must be listening or free for managed spawn; see tests/conftest.py.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

svo_client-3.3.2.tar.gz (70.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

svo_client-3.3.2-py3-none-any.whl (92.7 kB view details)

Uploaded Python 3

File details

Details for the file svo_client-3.3.2.tar.gz.

File metadata

  • Download URL: svo_client-3.3.2.tar.gz
  • Upload date:
  • Size: 70.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for svo_client-3.3.2.tar.gz
Algorithm Hash digest
SHA256 e92250887b1ccd117c13b8b328f6bc3cb684d72f69a624ae5db6664b6526b723
MD5 76b6384af3b70b733e2fd2ba5fae9e38
BLAKE2b-256 764200f2b360447c13abbb97bc307b708466ff8172eb3e45fb0f0beecc953e1c

See more details on using hashes here.

File details

Details for the file svo_client-3.3.2-py3-none-any.whl.

File metadata

  • Download URL: svo_client-3.3.2-py3-none-any.whl
  • Upload date:
  • Size: 92.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for svo_client-3.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5e93de941304d3dac6b146d5ee28c7b3054e8c0a178ad779c559a539f428e25d
MD5 dae64b49bfa5839a8718417a2bfe20ef
BLAKE2b-256 528ab45620864e3e060eead48caedccedf63f181dac0ed5b027f61851e8cf1fd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page