Saltar al contenido principal
POST
/
api
/
v1
/
llm
/
vector_stores
/
{vector_store_id}
/
search
Python (SDK)
from openapi 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
}

Autorizaciones

Authorization
string
header
requerido

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>.

Parámetros de ruta

vector_store_id
string
requerido

El ID del almacén de vectores a buscar.

Cuerpo

application/json

Cuerpo de la solicitud para buscar en un almacén de vectores.

query
requerido

Una cadena de consulta para una búsqueda, o un arreglo de cadenas de consulta.

filters
object

Un filtro para aplicar en función de los atributos del archivo.

max_num_results
integer
predeterminado:10

El número máximo de resultados a devolver. Este número debe estar entre 1 y 50, inclusive.

Rango requerido: 1 <= x <= 50
ranking_options
object

Opciones de clasificación para la búsqueda.

rewrite_query
boolean
predeterminado:false

Si se debe reescribir la consulta en lenguaje natural para la búsqueda por vectores.

Respuesta

200 - application/json

Está bien

Una página de resultados de búsqueda de la tienda de vectores.

object
any
requerido

El tipo de objeto, que siempre es 'vector_store.search_results.page'.

search_query
string
requerido

La consulta que se utilizó para la búsqueda.

data
object[]
requerido

Array de resultados de búsqueda.

has_more
boolean
requerido

Si hay más resultados disponibles.

next_page
string | null
requerido

Cursor para la siguiente página de resultados, o nulo si no hay más resultados.