OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-search(3)

NAME
OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-search - Documentation for the /vector_stores/{vector_store_id}/search path.

DESCRIPTION
This document describes the API endpoint at "/vector_stores/{vector_store_id}/search".

PATHS

  "POST /vector_stores/{vector_store_id}/search"
Search a vector store for relevant chunks based on a query and file attributes filter.

Operation ID

"searchVectorStore"

    $client->searchVectorStore( ... );

Parameters

•   "vector_store_id" (in path) (Required) - The ID of the vector store to search.

    Type: "string"

Request Body

Content Type: "application/json"

Example:

    {
       "ranking_options" : null
    }

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "data" : [
              {
                 "content" : [
                    null
                 ]
              }
           ],
           "search_query" : [
              null
           ]
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.