Interface CreateSearchRequest

Export

CreateSearchRequest

Hierarchy

  • CreateSearchRequest

Properties

documents? file? max-rerank? query return-metadata? user?

Properties

Optional documents

documents?: null | 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.

Memberof

CreateSearchRequest

Optional file

file?: null | string

The ID of an uploaded file that contains documents to search over. You should specify either documents or a file, but not both.

Memberof

CreateSearchRequest

Optional max-rerank

max-rerank?: null | number

The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when file is set.

Memberof

CreateSearchRequest

query

query: string

Query to search against the documents.

Memberof

CreateSearchRequest

Optional return-metadata

return-metadata?: null | 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.

Memberof

CreateSearchRequest

Optional user

user?: string

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Memberof

CreateSearchRequest

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc