groupe de commandesvector-search-indexes
L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.
Le groupe de commandes vector-search-indexes au sein de la CLI Databricks contient des commandes pour gérer les index de recherche IA. Un index de recherche AI est une représentation efficace de vos vecteurs d'intégration qui prend en charge les queries de recherche en temps réel et de voisins les plus proches approximatifs (ANN). Consultez Databricks AI Search.
databricks vector-search-indexes create-index
Créer un nouvel index.
databricks vector-search-indexes create-index NAME ENDPOINT_NAME PRIMARY_KEY INDEX_TYPE [flags]
Arguments
NAME
Nom de l'index
ENDPOINT_NAME
Nom de l'endpoint à utiliser pour servir l'index
PRIMARY_KEY
Clé primaire de l'index
INDEX_TYPE
Il existe deux types d’index de recherche IA : la synchronisation Delta (un index qui se synchronise automatiquement avec une table Delta source) ou l’accès direct (un index qui prend en charge la lecture et l’écriture directes de vecteurs et de métadonnées). Valeurs supportées : DELTA_SYNC, DIRECT_ACCESS
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
Exemples
L'exemple suivant crée un nouvel index Delta Sync :
databricks vector-search-indexes create-index my-index my-endpoint id DELTA_SYNC
L'exemple suivant crée un nouvel index d'accès direct :
databricks vector-search-indexes create-index my-index my-endpoint id DIRECT_ACCESS
databricks vector-search-indexes delete-data-vector-index
Supprimer 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 où les données doivent être supprimées. Doit être un index d'accès direct aux vecteurs.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
Exemples
L'exemple suivant supprime les données d'un index vectoriel d'accès direct :
databricks vector-search-indexes delete-data-vector-index my-index --json '{"primary_keys": ["key1", "key2"]}'
databricks vector-search-indexes supprimer l'index
Supprimer un index.
databricks vector-search-indexes delete-index INDEX_NAME [flags]
Arguments
INDEX_NAME
Nom de l'index
Options
Exemples
L'exemple suivant supprime un index de recherche IA :
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
Exemples
L’exemple suivant obtient les détails d’un index de recherche IA :
databricks vector-search-indexes get-index my-index
databricks vector-search-indexes list-indexes
Lister les index.
databricks vector-search-indexes list-indexes ENDPOINT_NAME [flags]
Arguments
ENDPOINT_NAME
Nom de l'Endpoint
Options
--page-token string
Jeton pour la pagination
Exemples
L'exemple suivant répertorie tous les index dans un endpoint :
databricks vector-search-indexes list-indexes my-endpoint
L'exemple suivant liste les index à l'aide de la pagination :
databricks vector-search-indexes list-indexes my-endpoint --page-token next-page-token
databricks vector-search-indexes query-index
Interroger un index.
databricks vector-search-indexes query-index INDEX_NAME [flags]
Arguments
INDEX_NAME
Nom de l'index vectoriel de query
Options
--filters-json string
Chaîne JSON représentant les filtres de query
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--num-results int
Nombre de résultats à renvoyer
--query-text string
Texte de la requête
--query-type string
Le type de query à utiliser
--score-threshold float
threshold pour la recherche approximative des plus proches voisins
Exemples
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 vector-search-indexes query-next-page
Page de query suivante.
databricks vector-search-indexes query-next-page INDEX_NAME [flags]
Arguments
INDEX_NAME
Nom de l'index vectoriel de query
Options
--endpoint-name string
Nom de l'Endpoint
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--page-token string
Jeton de page renvoyé par l'API QueryVectorIndex ou QueryVectorIndexNextPage précédente
Exemples
L’exemple suivant interroge la page de résultats suivante :
databricks vector-search-indexes query-next-page my-index --endpoint-name my-endpoint --page-token "next-page-token"
databricks vector-search-indexes scan-index
Analysez un index.
databricks vector-search-indexes scan-index INDEX_NAME [flags]
Arguments
INDEX_NAME
Nom de l'index vectoriel à analyser
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--last-primary-key string
Clé primaire de la dernière entrée renvoyée lors de l'analyse précédente
--num-results int
Nombre de résultats à renvoyer
Exemples
L’exemple suivant scanne 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 vector-search-indexes sync-index
Synchroniser 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
Exemples
L'exemple suivant Trigger la synchronisation pour un index Delta Sync :
databricks vector-search-indexes sync-index my-delta-sync-index
databricks vector-search-indexes upsert-data-vector-index
Upsertez les 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 où les données doivent être upsertées. Doit être un index d'accès direct aux vecteurs.
INPUTS_JSON
Chaîne JSON représentant les données à insérer/mettre à jour
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
Exemples
L'exemple suivant insère ou met à jour des données dans un index d'accès direct au vecteur :
databricks vector-search-indexes upsert-data-vector-index my-index '{"vectors": [{"id": "1", "vector": [0.1, 0.2, 0.3], "metadata": {"title": "Document 1"}}]}'
Drapeaux globaux
--debug
Activer ou non la journalisation de débogage.
-h OU --help
Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.
--log-file chaîne
Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.
--log-format Format
Le type de format de log, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.
-o, --output Type
Le type de sortie de commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Le format pour afficher les logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser