Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

`MultiSearchResponse` type does not account for union search response shape

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#128 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

@tharropoulos đang làm issue này rồi.

Từ ngày 4/5/2026.

  • #130 của @tharropoulos — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
api

Hướng nghiên cứu

Bắt đầu tại src/typesense/types/multi_search.py và lần theo chú thích kiểu trả về được dùng bởi multi_search.perform(). So sánh phản hồi liên kết được mô tả trong issue với dạng union=True trong tài liệu API được liên kết. Hoàn thành khi kiểu của MultiSearchResponse biểu diễn chính xác cả hai dạng phản hồi mà không gây hiểu lầm cho bên gọi.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

The MultiSearchResponse type in src/typesense/types/multi_search.py only models the federated (default) multi-search response shape:

class MultiSearchResponse(typing.TypedDict):
    results: typing.List[SearchResponse[typing.Any]]

However, the /multi_search endpoint has two distinct response shapes depending on whether union is set in the request:

  • Federated search (union absent or False): returns { "results": [ ...one SearchResponse per query... ] }
  • Union search (union: True): returns with no results wrapper doc

The current type is incorrect for the union case and gives users a misleading return type annotation when they call multi_search.perform() with union=True.

Ngôn ngữ chính
Python
Star
247
Fork
66
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
7

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của typesense/typesense-python

Tất cả issue của typesense/typesense-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.