Моделі запиту й відповіді

Розгортання AI у продакшні з FastAPI

Matt Eckerle

Software and Data Engineering Leader

Структури запиту й відповіді в API

Структура запиту

Дані, які клієнт надсилає до API
Зазвичай містить:
- Метод HTTP (GET, POST тощо)
- Заголовки
- Параметри запиту
- Тіло запиту

http://localhost:8000/users/? [email protected]

:8000: номер порту. У FastAPI типовий порт — 8000.
/users/: шлях до конкретного endpoint, який ми викликаємо.
?: початок параметрів запиту.
`[email protected]`: параметр запиту. Тут ми передаємо адресу електронної пошти endpoint'у.

Структура відповіді

Дані, які API повертає клієнту
- Відповідь JSON із даними користувача
Зазвичай містить:
- Код стану (200 OK, 404 Not Found тощо)
- Заголовки
- Тіло відповіді (запитані дані або результат операції)

HTTP/1.1 200 OK
date: Fri, 18 Oct 2024 12:34:56 GMT
server: uvicorn
content-length: 76
content-type: application/json

{
  "username": "johndoe",
  "email": "[email protected]",
  "age": 30
}

Модель Pydantic

Створення User
Використання Pydantic

from pydantic import BaseModel

class User(BaseModel):
    username: str
    email: str
    age: int

Успадковує від BaseModel
Визначає атрибути з анотаціями типів
Автоматична валідація за типами

Помилка валідації

from pydantic import ValidationError
try:
    invalid_user = User(username="john_doe", email="[email protected]", 
                        age="thirty")
    print("Invalid User:", invalid_user)
except ValidationError as e:
    print("Validation Error:", e)

Validation Error: 1 validation error for User age
Input should be a valid integer, unable to parse string as an integer 
[type=int_parsing, input_value='thirty', input_type=str]

Використання моделей Pydantic у FastAPI

from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()


class User(BaseModel):
    username: str
    email: str
    age: int


@app.post("/users", response_model=User)

async def create_user(user: User):
    return user

Модель використовується як response_model
Модель як підказка типу параметра
Автоматична валідація запиту
Де/серіалізація запитів/відповідей
Генерація документації API

Формати запиту й відповіді

curl -X 'POST' \
  'http://localhost:8000/users/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "john_doe",
  "email": "[email protected]",
  "age": 30
  }'

{
  "username": "john_doe",
  "email": "[email protected]",
  "age": 30
}

Давайте потренуємось!

Розгортання AI у продакшні з FastAPI