Interface PreviewResponseStringField

A string field as returned in index schema responses. String fields configured for full-text search include a full_text_search object; string fields used for metadata filtering only include a filterable flag.

ResponseStringField

interface PreviewResponseStringField {
    description?: string;
    filterable?: boolean;
    fullTextSearch?: PreviewResponseStringFieldFullTextSearch;
    type: "string";
}

Properties

description?: string

Optional description for this field.

ResponseStringField

filterable?: boolean

Whether this field is indexed for metadata filtering.

ResponseStringField

ResponseStringField

type: "string"

Identifies this as a string field. Must be string.

ResponseStringField