## Search vector store

`$ openai vector-stores search`

**post** `/vector_stores/{vector_store_id}/search`

Search a vector store for relevant chunks based on a query and file attributes filter.

### Parameters

- `--vector-store-id: string`

  The ID of the vector store to search.

- `--query: string or array of string`

  A query string for a search

- `--filters: optional ComparisonFilter or CompoundFilter`

  A filter to apply based on file attributes.

- `--max-num-results: optional number`

  The maximum number of results to return. This number should be between 1 and 50 inclusive.

- `--ranking-options: optional object { ranker, score_threshold }`

  Ranking options for search.

- `--rewrite-query: optional boolean`

  Whether to rewrite the natural language query for vector search.

### Returns

- `VectorStoreSearchResultsPage: object { data, has_more, next_page, 2 more }`

  - `data: array of object { attributes, content, file_id, 2 more }`

    The list of search result items.

    - `attributes: map[string or number or boolean]`

      Set of 16 key-value pairs that can be attached to an object. This can be
      useful for storing additional information about the object in a structured
      format, and querying for objects via API or the dashboard. Keys are strings
      with a maximum length of 64 characters. Values are strings with a maximum
      length of 512 characters, booleans, or numbers.

      - `union_member_0: string`

      - `union_member_1: number`

      - `union_member_2: boolean`

    - `content: array of object { text, type }`

      Content chunks from the file.

      - `text: string`

        The text content returned from search.

      - `type: "text"`

        The type of content.

        - `"text"`

    - `file_id: string`

      The ID of the vector store file.

    - `filename: string`

      The name of the vector store file.

    - `score: number`

      The similarity score for the result.

  - `has_more: boolean`

    Indicates if there are more results to fetch.

  - `next_page: string`

    The token for the next page, if any.

  - `object: "vector_store.search_results.page"`

    The object type, which is always `vector_store.search_results.page`

  - `search_query: array of string`

### Example

```cli
openai vector-stores search \
  --api-key 'My API Key' \
  --vector-store-id vs_abc123 \
  --query string
```

#### Response

```json
{
  "data": [
    {
      "attributes": {
        "foo": "string"
      },
      "content": [
        {
          "text": "text",
          "type": "text"
        }
      ],
      "file_id": "file_id",
      "filename": "filename",
      "score": 0
    }
  ],
  "has_more": true,
  "next_page": "next_page",
  "object": "vector_store.search_results.page",
  "search_query": [
    "string"
  ]
}
```