Référence des helpers utilisés dans les migrations. Tous les helpers sont importés depuis mistralai.search.toolkit.plugins.vespa.migration et appelés depuis la méthode migrate() d'une migration.

from mistralai.search.toolkit.plugins.vespa.migration import (
    VespaMigration,
    set_app_name,
    create_schema,
    add_field,
    add_query_profiles,
)

from mistralai.search.toolkit.plugins.vespa.migration import (
    VespaMigration,
    set_app_name,
    create_schema,
    add_field,
    add_query_profiles,
)

set_app_name

def set_app_name(app_name: str) -> None

def set_app_name(app_name: str) -> None

Définissez le nom de l'application pour l'exécution de la migration. Obligatoire dans la première migration. Ne doit contenir que des lettres minuscules (a-z).

set_content_id

def set_content_id(content_id: str) -> None

def set_content_id(content_id: str) -> None

Remplacez l'id du cluster de contenu utilisé dans services.xml (par défaut, le nom de l'application). Utilisez cette option lorsque le cluster déployé a été créé à l'origine avec un id différent. Sinon, Vespa traite un changement de nom comme une suppression suivie d'une recréation, ce qui détruit tous les documents stockés.

allow_schema_removal

def allow_schema_removal(until: str) -> None

def allow_schema_removal(until: str) -> None

Indiquez qu'une migration supprime intentionnellement un ou plusieurs schémas. Vespa rejette les suppressions de schémas par défaut pour protéger les données ; cette opération écrit un fichier validation-overrides.xml qui autorise la suppression jusqu'à until (une date ISO "YYYY-MM-DD"). Choisissez une date une ou deux semaines après votre fenêtre de déploiement.

set_distribute_across_groups

def set_distribute_across_groups(value: bool) -> None

def set_distribute_across_groups(value: bool) -> None

create_schema

def create_schema(
    name: str,
    mode: SearchMode,
    indexing_mode: IndexingMode,
    embedding_model: EmbeddingModel | MistralEmbeddingPreset | None = None,
    embedding_dimensions: int | None = None,
    fields: list[FieldDefinition] | None = None,
    custom_functions: list[FunctionWithInputs] | None = None,
    default_query_profile_name: str | None = None,
    top_chunks: int | None = None,
    id_field: str | None = None,
    content_cluster: str = "content",
) -> None

def create_schema(
    name: str,
    mode: SearchMode,
    indexing_mode: IndexingMode,
    embedding_model: EmbeddingModel | MistralEmbeddingPreset | None = None,
    embedding_dimensions: int | None = None,
    fields: list[FieldDefinition] | None = None,
    custom_functions: list[FunctionWithInputs] | None = None,
    default_query_profile_name: str | None = None,
    top_chunks: int | None = None,
    id_field: str | None = None,
    content_cluster: str = "content",
) -> None

Créez un schéma avec un mode d'indexation explicite. C'est la méthode recommandée pour définir un schéma.

create_default_schema

Les deux sont importées depuis mistralai.search.toolkit.plugins.vespa.app.schemas.app.

SearchMode

IndexingMode

Les champs sont déclarés avec FieldDefinition, importé depuis mistralai.search.toolkit.plugins.vespa.app.schemas.app, puis passés à create_schema(fields=[...]) ou add_field(...). Définissez multi_dimensional=True (lorsque c'est pris en charge) pour transformer un champ en tableau.

EmbeddingField

FieldDefinition.EmbeddingField(name: str, multi_dimensional: bool = False)

FieldDefinition.EmbeddingField(name: str, multi_dimensional: bool = False)

Embeddings vectoriels indexés avec HNSW. La dimension du tenseur et la métrique de distance sont dérivées du embedding_model du schéma. Définissez multi_dimensional=True pour un tableau d'embeddings (par exemple par fragment).

TextField

FieldDefinition.TextField(
    name: str,
    multi_dimensional: bool = False,
    summary: SummaryDefinition = SummaryDefinition(),
)

FieldDefinition.TextField(
    name: str,
    multi_dimensional: bool = False,
    summary: SummaryDefinition = SummaryDefinition(),
)

Texte tokenisé comparé à la requête utilisateur (BM25). Inclus dans le fieldset par défaut. summary contrôle le rendu du champ dans les résultats.

StringField

FieldDefinition.StringField(
    name: str,
    multi_dimensional: bool = False,
    fast_search: bool = False,
    match: MatchDefinition | None = None,
    summary: SummaryDefinition | None = SummaryDefinition(),
    attribute: bool = True,
)

FieldDefinition.StringField(
    name: str,
    multi_dimensional: bool = False,
    fast_search: bool = False,
    match: MatchDefinition | None = None,
    summary: SummaryDefinition | None = SummaryDefinition(),
    attribute: bool = True,
)

Métadonnées stockées qui ne sont pas comparées à la requête (à utiliser pour les filtres, ids, tags). fast_search construit un index d'attribut dédié (plus de mémoire/CPU, recherches plus rapides) ; match définit un schéma de correspondance explicite ; attribute=False exclut la valeur des attributs en mémoire.

TimestampField

FieldDefinition.TimestampField(name: str, type: Literal["long", "int"] = "long")

FieldDefinition.TimestampField(name: str, type: Literal["long", "int"] = "long")

Timestamp numérique utilisé pour les fonctions de classement par fraîcheur et récence.

CountField

FieldDefinition.CountField(name: str)

FieldDefinition.CountField(name: str)

Compteur entier qui génère des fonctions de classement de normalisation et de boost. Pour un entier sur lequel vous ne voulez pas classer, utilisez IntField.

IntField

FieldDefinition.IntField(
    name: str,
    multi_dimensional: bool = False,
    summary: SummaryDefinition = SummaryDefinition(),
)

FieldDefinition.IntField(
    name: str,
    multi_dimensional: bool = False,
    summary: SummaryDefinition = SummaryDefinition(),
)

Entier stocké, non utilisé pour le classement ni pour la correspondance.

BoolField

FieldDefinition.BoolField(name: str, fast_search: bool = False)

FieldDefinition.BoolField(name: str, fast_search: bool = False)

Booléen stocké, non utilisé pour le classement ni pour la correspondance. Définissez fast_search=True pour émettre attribute { fast-search }, ce qui permet d'utiliser le champ dans le filtrage au moment de la requête (par exemple un indicateur is_public).

LanguageField

FieldDefinition.LanguageField(name: str = "language")

FieldDefinition.LanguageField(name: str = "language")

Définit la langue du document (une étiquette RFC 3066) et crée un index afin que les documents puissent être filtrés par langue.

Ajoutez des éléments à un schéma existant dans une migration ultérieure. Chaque appel lève ValueError si le schéma nommé n'existe pas.

add_field

def add_field(schema_name: str, field: FieldDefinition) -> None

def add_field(schema_name: str, field: FieldDefinition) -> None

Ajoutez un seul champ à un schéma existant.

add_custom_functions

def add_custom_functions(schema_name: str, functions: list[FunctionWithInputs]) -> None

def add_custom_functions(schema_name: str, functions: list[FunctionWithInputs]) -> None

Ajoutez des fonctions de classement personnalisées à un schéma existant.

add_query_profiles

def add_query_profiles(query_profiles: list[QueryProfile]) -> None

def add_query_profiles(query_profiles: list[QueryProfile]) -> None

Ajoutez ou mettez à jour des profils de requête sur l'application. Voir Gérer le classement.

add_schema_rank_profiles

def add_schema_rank_profiles(schema_name: str, rank_profiles: list[Path]) -> None

def add_schema_rank_profiles(schema_name: str, rank_profiles: list[Path]) -> None

Joignez des fichiers de profil de classement personnalisés à un schéma.

add_schema_model_files

def add_schema_model_files(schema_name: str, model_files: list[Path]) -> None

def add_schema_model_files(schema_name: str, model_files: list[Path]) -> None

Joignez des fichiers de modèle ML à un schéma.

add_schema_custom_document_summary

def add_schema_custom_document_summary(schema_name: str, custom_document_summary: DocumentSummary) -> None

def add_schema_custom_document_summary(schema_name: str, custom_document_summary: DocumentSummary) -> None

Joignez un résumé de document personnalisé à un schéma.

Classe de base de chaque migration. Créez-en une sous-classe et implémentez migrate(), en appelant les helpers ci-dessus :

from mistralai.search.toolkit.embedding import MistralEmbeddingPreset
from mistralai.search.toolkit.plugins.vespa.app.schemas.app import IndexingMode, SearchMode
from mistralai.search.toolkit.plugins.vespa.migration import VespaMigration, create_schema, set_app_name


class InitialSchema(VespaMigration):
    def migrate(self) -> None:
        set_app_name("myapp")
        create_schema(
            name="articles",
            mode=SearchMode.INDEX,
            embedding_model=MistralEmbeddingPreset.MISTRAL_EMBED_DIM_1024,
            indexing_mode=IndexingMode.DOCUMENT_PER_CHUNK,
        )

from mistralai.search.toolkit.embedding import MistralEmbeddingPreset
from mistralai.search.toolkit.plugins.vespa.app.schemas.app import IndexingMode, SearchMode
from mistralai.search.toolkit.plugins.vespa.migration import VespaMigration, create_schema, set_app_name


class InitialSchema(VespaMigration):
    def migrate(self) -> None:
        set_app_name("myapp")
        create_schema(
            name="articles",
            mode=SearchMode.INDEX,
            embedding_model=MistralEmbeddingPreset.MISTRAL_EMBED_DIM_1024,
            indexing_mode=IndexingMode.DOCUMENT_PER_CHUNK,
        )

create_schema(embedding_model=...) accepte un EmbeddingModel qui décrit les dimensions, le type de données et la métrique de distance des vecteurs stockés dans l’index. Transmettez un MistralEmbeddingPreset pour utiliser ses valeurs par défaut, ou directement un MistralEmbeddingModel ou CustomEmbeddingModel.

from mistralai.search.toolkit.embedding import MistralEmbeddingPreset

create_schema(
    ...,
    embedding_model=MistralEmbeddingPreset.MISTRAL_EMBED_DIM_1024,  # built for you
)

from mistralai.search.toolkit.embedding import MistralEmbeddingPreset

create_schema(
    ...,
    embedding_model=MistralEmbeddingPreset.MISTRAL_EMBED_DIM_1024,  # built for you
)

Pour la distinction entre MistralEmbeddingModel et CustomEmbeddingModel, les presets et la relation entre le modèle de schéma et l'embedder de votre pipeline, voir Modèle d'embedding.

• Gérer le schéma : créer et faire évoluer des schémas avec ces helpers
• Anatomie d'une application Vespa : concepts : schémas, champs, classement, profils de requête
• Gérer le classement : profils de requête et configuration du classement