Type Alias CreateIndexForModelEmbed

CreateIndexForModelEmbed: {
    fieldMap: object;
    metric?: string;
    model: string;
    readParameters?: object;
    writeParameters?: object;
}

Specifies the integrated inference embedding configuration for the index. Once set the model cannot be changed, but you can later update the embedding configuration for an integrated inference index including field map, read parameters, or write parameters. Refer to the model guide for available models and model details.

Type declaration

  • fieldMap: object

    Identifies the name of the text field from your document model that will be embedded.

  • Optionalmetric?: string

    The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If not specified, the metric will be defaulted according to the model. Cannot be updated once set.

  • model: string

    The name of the embedding model to use for the index.

  • OptionalreadParameters?: object

    The read parameters for the embedding model.

  • OptionalwriteParameters?: object

    The write parameters for the embedding model.