Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

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

未關閉 適合新手
#128 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

@tharropoulos 已經在處理了。

開始於 2026年5月4日。

  • #130 來自 @tharropoulos —— 未關閉

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
78/100
Issue 類型
缺陷
描述清晰度
描述清楚
活躍度
冷清
技術堆疊
python
領域
api

研究方向

從 src/typesense/types/multi_search.py 開始,追蹤 multi_search.perform() 使用的回傳註記。將 issue 中描述的聯邦回應與連結的 API 文件中 union=True 的形式進行比較。完成標準是 MultiSearchResponse 的型別能準確表示這兩種回應形式,且不會誤導呼叫端。

由索引模型根據 Issue 內容生成。

描述

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.

主要語言
Python
星號
247
分支
66
平均合併
22 小時 47 分鐘
30 天內合併 PR
8

環境準備

這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

typesense/typesense-python 的其他 Issue

查看 typesense/typesense-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。