Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta Para iniciantes
#128 0 comentários 0 reações 0 responsáveis Ver no GitHub

@tharropoulos já está trabalhando nisso.

Desde 4/5/2026.

  • #130 de @tharropoulos — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
78/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Pouca atividade
Stack de tecnologia
python
Domínio
api

Direção de pesquisa

Comece em src/typesense/types/multi_search.py e siga a anotação de retorno usada por multi_search.perform(). Compare a resposta federada descrita na issue com o formato de union=True na documentação da API vinculada. O trabalho estará concluído quando a tipagem de MultiSearchResponse representar corretamente os dois formatos de resposta sem induzir os chamadores ao erro.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Python
Estrelas
247
Forks
66
Merge médio
22h 47min
PRs com merge (30d)
8

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de typesense/typesense-python

Todas as issues de typesense/typesense-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.