Interface PreviewSemanticTextField

A semantic text field configuration. Backed by an integrated embedding model that embeds text at write and query time, enabling semantic similarity search without separate embedding calls.

SemanticTextField

interface PreviewSemanticTextField {
    metric?: string;
    model: string;
    readParameters?: object;
    type: "semantic_text";
    writeParameters?: object;
}

Properties

metric?: string

The distance metric used for similarity search. Defaults to the model's preferred metric if not specified. Possible values: cosine, dotproduct, or euclidean.

SemanticTextField

model: string

The name of the integrated embedding model to use for this field.

SemanticTextField

readParameters?: object

Model-specific parameters applied at query time, such as input_type.

SemanticTextField

type: "semantic_text"

Identifies this as a semantic text field. Must be semantic_text.

SemanticTextField

writeParameters?: object

Model-specific parameters applied at write time, such as input_type.

SemanticTextField