Interface PreviewSearchDocumentsOptions

The request for the search_documents operation.

Export

SearchDocumentsRequest

interface PreviewSearchDocumentsOptions {
    filter?: object;
    includeFields?: string[];
    scoreBy: PreviewDocumentScoringMethod[];
    topK: number;
}

Properties

filter? includeFields? scoreBy topK

Properties

Optionalfilter

filter?: object

A metadata filter expression to restrict the documents searched.

Memberof

SearchDocumentsRequest

OptionalincludeFields

includeFields?: string[]

The document fields to include in the search results.

Memberof

SearchDocumentsRequest

scoreBy

scoreBy: PreviewDocumentScoringMethod[]

The list of scoring methods to use for ranking documents.

Memberof

SearchDocumentsRequest

topK

topK: number

The number of top-ranked documents to return.

Memberof

SearchDocumentsRequest

Settings

Member Visibility

On This Page

Properties