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.164.tar.gz (11.6 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.164-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agentum_cloud_sdk-0.1.164.tar.gz
  • Upload date:
  • Size: 11.6 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.164.tar.gz
Algorithm Hash digest
SHA256 6c8d5cb0d190e4f49cf73ca08b24df5c4fd1cde7a0b4ac188ba4774f982a646f
MD5 3648aafdaaee90ed9d1c03e4f34385fd
BLAKE2b-256 c20412df1a8b9efd540789f9c6d1d8e1b457f33551e40ec43c35d2b10067551f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agentum_cloud_sdk-0.1.164-py3-none-any.whl
Algorithm Hash digest
SHA256 e20247babfe8137d67731f0f9d8291c65c5a42bbf8ed514c1dc5f16442daa870
MD5 25a9d729e5f8953ebe384dc779a7bb25
BLAKE2b-256 f395b9bda8c6bb29b6c46dbdc579abdd40d99fc7e9cd0532713bb552ef7f14bf

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