Перейти к содержанию

Методы API

Чтобы получить, загрузить и удалить загруженные изображения и звуки, надо передать OAuth Token при создании навыка и воспользоваться одним из следующих методов экземпляра:

1
skill = Skill(skill_id="...", oauth_token="it_is_required_for_methods")

Важно

Без токена невозможно использовать все следующие методы.

Свободное место

aliceio.client.skill.Skill.status(request_timeout: Optional[int] = None) -> SpaceStatus async

Для каждого аккаунта Яндекса на Диалоги можно загрузить не больше 100 МБ картинок и 1 ГБ аудио. Чтобы узнать, сколько места уже занято, используйте этот метод. Док 1 Док 2

1
space_status = await skill.status()

Изображения

aliceio.client.skill.Skill.get_images(request_timeout: Optional[int] = None) -> UploadedImagesList async

Список изображений, загруженных для навыка, можно получить этим методом. Док

1
images = await skill.get_images()

aliceio.client.skill.Skill.upload_image(file: Union[InputFile, str], request_timeout: Optional[int] = None) -> PreUploadedImage async

Чтобы загрузить картинку для навыка из интернета, передайте URL картинки в метод. Док

1
image = await skill.upload_image("https://example.com")

Чтобы загрузить файл, передайте наследника InputFile'а в метод. Док

1
image = await skill.upload_image(BufferedInputFile(file=b"..."))

aliceio.client.skill.Skill.delete_image(file_id: str, request_timeout: Optional[int] = None) -> Result async

Чтобы удалить загруженное изображение, передайте его идентификатор в этот метод. Док

1
result = await skill.delete_image(file_id="...")

Аудио

aliceio.client.skill.Skill.get_sounds(request_timeout: Optional[int] = None) -> UploadedSoundsList async

Чтобы посмотреть аудиофайлы, загруженные для навыка, используйте этот метод. Док

1
sounds = await skill.get_sounds()

aliceio.client.skill.Skill.upload_sound(file: InputFile, request_timeout: Optional[int] = None) -> PreUploadedSound async

Аудио можно загрузить только файлом, передайте наследника InputFile'а в метод. Док

1
sound = await skill.upload_sound(path="...")

aliceio.client.skill.Skill.delete_sound(file_id: str, request_timeout: Optional[int] = None) -> Result async

Чтобы удалить загруженное аудио, передайте его идентификатор в этот метод. Док

1
result = await skill.delete_sound(file_id="...")

Примеры