{"id":13754953,"url":"https://github.com/Demetrous-fd/alice_types","last_synced_at":"2025-05-10T00:31:19.617Z","repository":{"id":214121047,"uuid":"733903758","full_name":"Demetrous-fd/alice_types","owner":"Demetrous-fd","description":"Pydantic модели для валидации протокола Я.Диалогов","archived":false,"fork":false,"pushed_at":"2024-02-10T15:37:40.000Z","size":284,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T15:07:22.949Z","etag":null,"topics":["alice","pydantic","pypi","python","yandex"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/alice-types/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Demetrous-fd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-12-20T11:52:31.000Z","updated_at":"2024-08-07T04:35:23.000Z","dependencies_parsed_at":"2024-03-05T14:05:40.603Z","dependency_job_id":"8632da23-6cc0-4f4d-80ee-7d0a9105c6ca","html_url":"https://github.com/Demetrous-fd/alice_types","commit_stats":null,"previous_names":["demetrous-fd/alice_types"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Demetrous-fd%2Falice_types","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Demetrous-fd%2Falice_types/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Demetrous-fd%2Falice_types/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Demetrous-fd%2Falice_types/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Demetrous-fd","download_url":"https://codeload.github.com/Demetrous-fd/alice_types/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253346419,"owners_count":21894263,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alice","pydantic","pypi","python","yandex"],"created_at":"2024-08-03T10:00:37.696Z","updated_at":"2025-05-10T00:31:19.146Z","avatar_url":"https://github.com/Demetrous-fd.png","language":"Python","funding_links":[],"categories":["Разработка"],"sub_categories":["SDK"],"readme":"## AliceTypes\n\nБиблиотека моделей Pydantic-V2 для валидации протокола Я.Диалогов\n\n## Установка:\n\n```shell\npip install alice-types\n```\n\n## Использование\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eПример с FastApi\u003c/strong\u003e\u003c/summary\u003e\n\n```python\nfrom alice_types.response import AliceResponse\nfrom alice_types.request import AliceRequest\nfrom fastapi import FastAPI\n\napp = FastAPI()\n\n\n@app.post(path=\"/\")\nasync def handler(alice_request: AliceRequest):\n    reply = AliceResponse()\n\n    if alice_request.is_new_session():\n        reply.response.text = \"Привет, скажи что-нибудь и я это повторю\"\n        return reply\n\n    reply.response.text = alice_request.request.original_utterance\n    return reply\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eПример с AIOHttp\u003c/strong\u003e\u003c/summary\u003e\n\n```python\nfrom alice_types.response import AliceResponse\nfrom alice_types.request import AliceRequest\nfrom aiohttp import web\n\n\nasync def handler(request):\n    body = await request.json()\n    alice_request = AliceRequest.model_validate(body)\n\n    reply = AliceResponse()\n\n    if alice_request.is_new_session():\n        reply.response.text = \"Привет, скажи что-нибудь и я это повторю\"\n    else:\n        reply.response.text = alice_request.request.original_utterance\n\n    body = reply.model_dump()\n    return web.json_response(body)\n\n\napp = web.Application()\napp.router.add_post('/', handler)\n\nif __name__ == \"__main__\":\n    web.run_app(app)\n\n```\n\n\u003c/details\u003e\n\n### Расширение типов полей\n\nВ библиотеке имеются модели с динамически расширяемыми полями:\n\n- [request.State](https://github.com/Demetrous-fd/alice_types/blob/main/examples/extend_fields/state.py)\n    - State.extend_session_model(model: BaseModel)\n    - State.extend_user_model(model: BaseModel)\n    - State.extend_application_model(model: BaseModel)\n- [request.RequestPurchase.payload](https://github.com/Demetrous-fd/alice_types/blob/main/examples/extend_fields/purchase.py)\n  - RequestPurchase.extend_payload_model(model: BaseModel)\n\n### Ограничение размера хранилищ для модели ответа\n\nВ модели AliceResponse по умолчанию установлен стандартный размер хранилищ (1 КБ), который можно изменить при\nнеобходимости:\n\n```python\nfrom alice_types.response import AliceResponse\n\nAliceResponse.set_session_state_limit_size(1024 * 8)\nAliceResponse.set_user_state_limit_size(1024 * 16)\nAliceResponse.set_application_state_limit_size(1024 * 32)\n```\n\n### Публичные методы\n\u003cdetails\u003e\n\u003csummary\u003eAliceRequest\u003c/summary\u003e\n\u003cul\u003e\n\u003cli\u003eAliceRequest.is_ping()\u003c/li\u003e\n\u003cli\u003eAliceRequest.is_new_session()\u003c/li\u003e\n\u003cli\u003eAliceRequest.authorization_is_completed()\u003c/li\u003e\n\u003c/ul\u003e\n\n```python\nfrom alice_types.response import AliceResponse, Response\nfrom alice_types.request import AliceRequest\n\n\nasync def handler(alice_request: AliceRequest):\n    if alice_request.is_ping():\n        return AliceResponse(\n            response=Response(\n                text=\"pong\"\n            )\n        )\n    \n    elif alice_request.is_new_session():\n        return AliceResponse(\n            response=Response(\n                text=\"Привет, скажи что-нибудь и я это повторю\"\n            )\n        )\n    \n    elif alice_request.authorization_is_completed():\n        return AliceResponse(\n            response=Response(\n                text=\"Ты авторизован это хорошо 👍\"\n            )\n        )\n    ...\n```\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003eAliceRequest.request.nlu.entities\u003c/summary\u003e \n\n\u003cul\u003e\n\u003cli\u003eentities.get(entity_type: SlotsType | str) - \u003cstrong\u003eВозвращает список сущностей заданного типа.\u003c/strong\u003e\u003c/li\u003e\n\u003cli\u003eentity.available() - \u003cstrong\u003eВозвращает список доступных атрибутов объекта, у которых значение не равно None. Метод доступен у всех сущностей.\u003c/strong\u003e\u003c/li\u003e\n\u003cli\u003eEntityDatetime.to_datetime(timezone: pytz.BaseTzInfo | str | None = None)\u003c/li\u003e\n\u003c/ul\u003e\n\n```python\nfrom typing import List\n\nfrom alice_types.request import AliceRequest, SlotsType, EntityFio, EntityDatetime\n\n\nasync def handler(alice_request: AliceRequest):\n    fio_entities: List[EntityFio] = alice_request.request.nlu.entities.get(SlotsType.YANDEX_FIO)\n    names = []\n    for entity in fio_entities:\n        if \"first_name\" in entity.value.available():\n            names.append(entity.value.first_name)\n\n    dates = []\n    datetime_entities: List[EntityDatetime] = alice_request.request.nlu.entities.get(SlotsType.YANDEX_DATETIME)\n    for entity in datetime_entities:\n        dates.append(\n            entity.to_datetime(\n                timezone=alice_request.meta.timezone  # Default: None\n            )\n        )\n    ...\n```\n\n\u003c/details\u003e\n\u003cdetails\u003e\n\n\u003csummary\u003eAliceRequest.request.meta.interfaces\u003c/summary\u003e\n\n\u003cul\u003e\n\u003cli\u003einterfaces.has(interface: Union[InterfaceType, str]) - \u003cstrong\u003eПроверяет, существует ли этот интерфейс.\u003c/strong\u003e\u003c/li\u003e\n\u003cli\u003einterfaces.available() - \u003cstrong\u003eВозвращает список доступных интерфейсов.\u003c/strong\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n```python\nfrom alice_types.request import AliceRequest, InterfaceType\n\n\nasync def handler(alice_request: AliceRequest):\n    if alice_request.meta.interfaces.has(InterfaceType.SCREEN):\n        pass\n```\n\u003c/details\u003e\n\n\n### Примеры\n\n- [EchoBot](https://github.com/Demetrous-fd/alice_types/blob/main/examples/base.py)\n- [Авторизация](https://github.com/Demetrous-fd/alice_types/blob/main/examples/auth.py)\n- Расширение типов полей:\n    - [request.State](https://github.com/Demetrous-fd/alice_types/blob/main/examples/extend_fields/state.py)\n    - [request.RequestPurchase.payload](https://github.com/Demetrous-fd/alice_types/blob/main/examples/extend_fields/purchase.py)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDemetrous-fd%2Falice_types","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDemetrous-fd%2Falice_types","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDemetrous-fd%2Falice_types/lists"}