Partager via


vector-search-indexes groupe de commande

Note

Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Le vector-search-indexes groupe de commandes dans l’interface CLI Databricks contient des commandes pour gérer les index de recherche vectorielle. Un index de recherche vectorielle est une représentation efficace de vos vecteurs d'embedding qui prend en charge en temps réel les requêtes de recherche de voisinage approximatif (ANN). Consultez Recherche vectorielle Mosaic AI.

databricks vector-search-indexes create-index

Créez un index.

databricks vector-search-indexes create-index NAME ENDPOINT_NAME PRIMARY_KEY INDEX_TYPE [flags]

Arguments

NAME

    Nom de l'index.

ENDPOINT_NAME

    Nom du point de terminaison à utiliser pour servir l’index

PRIMARY_KEY

    Clé primaire de l’index

INDEX_TYPE

    Il existe deux types d’index de recherche vectorielle, la synchronisation Delta (index qui se synchronise automatiquement avec une table Delta source) ou un accès direct (un index qui prend en charge la lecture directe et l’écriture de vecteurs et de métadonnées). Valeurs prises en charge : DELTA_SYNC, DIRECT_ACCESS

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Examples

L’exemple suivant crée un index Delta Sync :

databricks vector-search-indexes create-index my-index my-endpoint id DELTA_SYNC

L’exemple suivant crée un index Direct Access :

databricks vector-search-indexes create-index my-index my-endpoint id DIRECT_ACCESS

databricks vector-search-indexes supprimer-index-vectoriel-données

Supprimez les données de l’index.

databricks vector-search-indexes delete-data-vector-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Nom de l’index vectoriel dans lequel les données doivent être supprimées. Doit être un index d’accès vectoriel direct.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Examples

L’exemple suivant supprime les données d’un index d’accès vectoriel direct :

databricks vector-search-indexes delete-data-vector-index my-index --json '{"primary_keys": ["key1", "key2"]}'

databricks vector-search-index delete-index

Supprimer un index.

databricks vector-search-indexes delete-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Nom de l'index.

Options

Indicateurs globaux

Examples

L’exemple suivant supprime un index de recherche vectorielle :

databricks vector-search-indexes delete-index my-index

databricks vector-search-indexes get-index

Obtenir un index.

databricks vector-search-indexes get-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Nom de l'index.

Options

Indicateurs globaux

Examples

L’exemple suivant obtient des détails pour un index de recherche vectorielle :

databricks vector-search-indexes get-index my-index

databricks indexation-vecteur-recherche lister-indexes

Répertorier les index.

databricks vector-search-indexes list-indexes ENDPOINT_NAME [flags]

Arguments

ENDPOINT_NAME

    Nom du point de terminaison

Options

--page-token string

    Jeton pour la pagination

Indicateurs globaux

Examples

L’exemple suivant répertorie tous les index d’un point de terminaison :

databricks vector-search-indexes list-indexes my-endpoint

L’exemple suivant répertorie les index à l’aide de la pagination :

databricks vector-search-indexes list-indexes my-endpoint --page-token next-page-token

Databricks index de recherche-vecteur requête-index

Envoyer une requête à un index

databricks vector-search-indexes query-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Nom de l’index vectoriel à interroger

Options

--filters-json string

    Chaîne JSON représentant des filtres de requête

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--num-results int

    Nombre de résultats à renvoyer

--query-text string

    Texte de requête

--query-type string

    Type de requête à utiliser

--score-threshold float

    Seuil pour la recherche approximative du voisin le plus proche

Indicateurs globaux

Examples

L’exemple suivant interroge un index avec du texte :

databricks vector-search-indexes query-index my-index --query-text "search term" --num-results 10

L’exemple suivant interroge un index avec des filtres :

databricks vector-search-indexes query-index my-index --query-text "search term" --filters-json '{"category": "product"}' --num-results 5

databricks index de recherche vectorielle interroger la page suivante

Interroge la page suivante.

databricks vector-search-indexes query-next-page INDEX_NAME [flags]

Arguments

INDEX_NAME

    Nom de l’index vectoriel à interroger

Options

--endpoint-name string

    Nom du point de terminaison

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--page-token string

    Jeton de page retourné par l’API QueryVectorIndex ou QueryVectorIndexNextPage précédente

Indicateurs globaux

Examples

L’exemple suivant interroge la page suivante des résultats :

databricks vector-search-indexes query-next-page my-index --endpoint-name my-endpoint --page-token "next-page-token"

Databricks indexation-vecteur-recherche index-d'analyse

Analysez un index.

databricks vector-search-indexes scan-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Nom de l’index vectoriel à analyser

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--last-primary-key string

    Clé primaire de la dernière entrée retournée lors de l'analyse précédente

--num-results int

    Nombre de résultats à renvoyer

Indicateurs globaux

Examples

L’exemple suivant analyse un index :

databricks vector-search-indexes scan-index my-index --num-results 100

L’exemple suivant analyse un index à partir d’une clé spécifique :

databricks vector-search-indexes scan-index my-index --last-primary-key "key123" --num-results 100

databricks index-recherche-vecteur index-synchronisation

Synchronisez un index.

databricks vector-search-indexes sync-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Nom de l’index vectoriel à synchroniser. Doit être un index "Delta Sync".

Options

Indicateurs globaux

Examples

L’exemple suivant déclenche la synchronisation pour un index Delta Sync :

databricks vector-search-indexes sync-index my-delta-sync-index

databricks index-de-recherche-vecteur mise-à-jour-ou-insertion-données-index-vecteur

Insérer ou mettre à jour des données dans un index.

databricks vector-search-indexes upsert-data-vector-index INDEX_NAME INPUTS_JSON [flags]

Arguments

INDEX_NAME

    Nom de l’index vectoriel dans lequel les données doivent être fusionnées. Doit être un index d’accès vectoriel direct.

INPUTS_JSON

    Chaîne JSON représentant les données à mettre à jour

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Examples

L’exemple suivant insère ou met à jour les données dans un index d’accès vectoriel direct :

databricks vector-search-indexes upsert-data-vector-index my-index '{"vectors": [{"id": "1", "vector": [0.1, 0.2, 0.3], "metadata": {"title": "Document 1"}}]}'

Indicateurs globaux

--debug

  Active la journalisation du débogage.

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne

    Chaîne représentant le fichier dans lequel écrire les journaux de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format format

    Format des journaux : text ou json. La valeur par défaut est text.

--log-level chaîne

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne

    Nom du profil dans le ~/.databrickscfg fichier à utiliser pour exécuter la commande. Si cet indicateur n’est pas spécifié, s’il existe, le profil nommé DEFAULT est utilisé.

--progress-format format

    Format permettant d’afficher les journaux de progression : default, append, inplace ou json

-t, --target chaîne

    Le cas échéant, la cible d’offre groupée à utiliser