Skip to main content

Типизированный async-клиент Agentum Cloud (/v1): загрузка документов, поиск и RAG-вопросы по вашим файлам.

Project description

agentum-cloud-sdk

Типизированный async-клиент для Agentum Cloud — облака ваших документов с поиском и ответами на естественном языке (RAG). Загружаете файлы (PDF, DOCX, изображения, аудио), а затем ищете по ним и задаёте вопросы — ИИ отвечает с ссылками на источники.

Тонкая обёртка над httpx поверх REST /v1. Полные type hints, py.typed.

Установка

pip install agentum-cloud-sdk

Обновление до свежей версии: pip install -U agentum-cloud-sdk.

Требуется Python 3.13+.

Токен

  1. Войдите в приложение cloud.agentums.ru (через Яндекс).
  2. Настройки → API-токены → Создать — скопируйте токен ak_… (показывается один раз).

Токен привязан к вашему аккаунту и подписке. Держите его в секрете (как пароль); если скомпрометирован — отзовите в настройках и создайте новый.

Быстрый старт

import asyncio
from agentum_cloud import AgentumClient


async def main() -> None:
    async with AgentumClient(
        base_url="https://api.cloud.agentums.ru",
        api_key="ak_ваш_токен",
    ) as cloud:
        # Загрузить документ
        with open("contract.pdf", "rb") as f:
            obj = await cloud.upload("contract.pdf", f.read())

        # Дождаться, пока документ проиндексируется
        await cloud.wait_until_ready(obj.id)

        # Спросить — ответ с цитатами из ваших файлов
        answer = await cloud.ask("Какой срок действия договора?")
        print(answer.answer)
        if answer.primary:  # закреплённый главный файл под запрос («найди X» → вот он)
            print(f"  главный файл: {answer.primary.filename}")
        for c in answer.citations:
            print(f"  источник: {c.filename}")


asyncio.run(main())

Что умеет

Метод Назначение
upload(filename, data) загрузить документ/изображение/аудио
wait_until_ready(object_id) дождаться окончания индексации
list_objects(...) / get_object(id) список / детали файла (заголовок, summary, теги)
get_summary(id) карточка содержания (метаданные обогащения)
get_content(id) временная ссылка на оригинал (presigned URL)
search(q) гибридный поиск (вектор + полнотекст + имя/расширение) по вашим файлам
ask(query) ответ ИИ по вашим документам + цитаты и закреплённый файл (primary)
translate(id, target_lang) перевести документ → новый объект
transcribe(filename, data) расшифровка аудио в текст
get_usage(days=...) расход (₽) и разбивка по статьям
get_usage_history(days=...) дневной ряд расхода (₽ + токены + вызовы) для графика
list_collections() / create_collection(...) / move_object(...) папки и раскладка файлов
delete_object(id) удалить файл

Все методы — корутины; клиент — async-context-manager (async with).

Заметки

  • Данные изолированы по аккаунту: токен видит только файлы вашего аккаунта. Файлы, загруженные через Telegram-бота, доступны здесь же после привязки бота к аккаунту.
  • Базовый URL прода — https://api.cloud.agentums.ru.

Лицензия

MIT — см. LICENSE.

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

agentum_cloud_sdk-0.1.122.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

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

agentum_cloud_sdk-0.1.122-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file agentum_cloud_sdk-0.1.122.tar.gz.

File metadata

  • Download URL: agentum_cloud_sdk-0.1.122.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for agentum_cloud_sdk-0.1.122.tar.gz
Algorithm Hash digest
SHA256 882f54fb64a36cd81c5b4cb0596fa9381f6c9ff5f546c4e77b66f07318f9abf6
MD5 396d1712effb4e5e099ff8f63b1a62d8
BLAKE2b-256 eac1bae66511866752a5ee441d9b792be32b12571b1fa99585f47332feef89e9

See more details on using hashes here.

File details

Details for the file agentum_cloud_sdk-0.1.122-py3-none-any.whl.

File metadata

File hashes

Hashes for agentum_cloud_sdk-0.1.122-py3-none-any.whl
Algorithm Hash digest
SHA256 1c3cbe893c342497f79f4ee463051d706714d4413e37634a795999e5468799f6
MD5 c7ce4338e7f0cbd7243f5f2114468eb5
BLAKE2b-256 184ef1b752adbf121e807e402d45290fa4610f55cb1e353e5c6261ff593c2108

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