Interface PreviewSearchDocumentsResponse

The response for the search_documents operation.

Export

SearchDocumentsResponse

interface PreviewSearchDocumentsResponse {
    matches: PreviewDocumentSearchMatch[];
    namespace: string;
    usage: PreviewDocumentSearchUsage;
}

Properties

matches namespace usage

Properties

matches

matches: PreviewDocumentSearchMatch[]

The matching documents, ordered from most to least similar.

Memberof

SearchDocumentsResponse

namespace

namespace: string

The namespace that was searched.

Memberof

SearchDocumentsResponse

usage

usage: PreviewDocumentSearchUsage

Memberof

SearchDocumentsResponse

Settings

Member Visibility

On This Page

Properties