Pular para o conteúdo principal
POST
/
api
/
v1
/
llm
/
vector_stores
/
{vector_store_id}
/
search
Python (SDK)
from mka1 import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.vector_stores.search(vector_store_id="vs_abc123", query="How do I reset my password?", max_num_results=5, rewrite_query=False)

    # Handle response
    print(res)
{
  "object": "vector_store.search_results.page",
  "search_query": "How do I reset my password?",
  "data": [
    {
      "file_id": "file-abc123",
      "filename": "user-guide.pdf",
      "score": 0.92,
      "content": [
        {
          "type": "text",
          "text": "To reset your password, navigate to Settings > Security > Reset Password..."
        }
      ]
    }
  ],
  "has_more": false,
  "next_page": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.mka1.com/llms.txt

Use this file to discover all available pages before exploring further.

Autorizações

Authorization
string
header
obrigatório

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Cabeçalhos

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Parâmetros de caminho

vector_store_id
string
obrigatório

O ID do armazenamento de vetores a ser pesquisado.

Corpo

application/json

Corpo da solicitação para pesquisar um armazenamento de vetores.

query
obrigatório

Uma string de consulta para uma pesquisa, ou um array de strings de consulta.

filters
object

Um filtro a ser aplicado com base nos atributos do arquivo.

max_num_results
integer
padrão:10

O número máximo de resultados a retornar. Esse número deve estar entre 1 e 50, inclusive.

Intervalo obrigatório: 1 <= x <= 50
ranking_options
object

Opções de classificação para busca.

rewrite_query
boolean
padrão:false

Se devemos reescrever a consulta em linguagem natural para busca vetorial.

Resposta

200 - application/json

OK

Uma página de resultados de busca do banco de vetores.

object
any
obrigatório

O tipo de objeto, que é sempre 'vector_store.search_results.page'.

search_query
string
obrigatório

A consulta que foi usada para a busca.

data
object[]
obrigatório

Array de resultados da busca.

has_more
boolean
obrigatório

Se há mais resultados disponíveis.

next_page
string | null
obrigatório

Cursor para a próxima página de resultados, ou nulo se não houver mais resultados.