| Name | Type | Description | Notes |
|---|---|---|---|
| query | kotlin.String | Query to search against the documents. | |
| documents | kotlin.Array<kotlin.String> | Up to 200 documents to search over, provided as a list of strings. The maximum document length (in tokens) is 2034 minus the number of tokens in the query. You should specify either `documents` or a `file`, but not both. | [optional] |
| file | kotlin.String | The ID of an uploaded file that contains documents to search over. You should specify either `documents` or a `file`, but not both. | [optional] |
| maxRerank | kotlin.Int | The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when `file` is set. | [optional] |
| returnMetadata | kotlin.Boolean | A special boolean flag for showing metadata. If set to `true`, each document entry in the returned JSON will contain a "metadata" field. This flag only takes effect when `file` is set. | [optional] |
| user | kotlin.String | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more. | [optional] |