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-4.0.0.tar.gz (71.6 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-4.0.0-py3-none-any.whl (93.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: svo_client-4.0.0.tar.gz
  • Upload date:
  • Size: 71.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.13

File hashes

Hashes for svo_client-4.0.0.tar.gz
Algorithm Hash digest
SHA256 ae5077bef1aee4dea0f706742ca28c0071cf8c6d961efa6a94602e56e542a8c7
MD5 ef6157d23194a32b678f007f3c93e288
BLAKE2b-256 35c413a25c0bab5d05477a0415f0e6e64078936d5d5d31404ee1950dab5986a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: svo_client-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 93.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.13

File hashes

Hashes for svo_client-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5ab6f7d041682f18215c2278308ce25e1312a113692664a51a4757849f5eefc
MD5 b9b9bfc5fa53c1993818dfd7e76709b7
BLAKE2b-256 8c5868e0abf9b5b3452bac2c6b51f5686313e0fb2f4593f64b3aed1b2d6312c2

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