Interface SearchWarning

Experimental. A warning returned alongside successful search results.

interface SearchWarning {
    details?: SearchWarningLimitDetails;
    message?: string;
    type?: string;
}

Properties

Structured details about the warning, if available.

message?: string

A human-readable explanation of the warning suitable for surfacing to end users.

type?: string

The type of warning, e.g. CLAUSE_LIMIT_EXCEEDED.