Saltar al contenido principal
POST
Python (SDK)

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

Encabezados

X-On-Behalf-Of
string

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

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

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.