Groupe de commandesai-search
L'utilisation de la CLI Databricks est soumise à la licence Databricks et à la politique de confidentialité de Databricks, y compris toute disposition relative aux données d'usage.
Le groupe de commandes ai-search au sein de la CLI Databricks contient des commandes permettant de gérer les Endpoint et les index de recherche IA. Un endpoint de recherche IA représente les ressources de compute permettant d'héberger des index de recherche IA. Voir Recherche IA.
databricks ai-search create-endpoint
Créer un endpoint de recherche IA.
databricks ai-search create-endpoint PARENT ENDPOINT_TYPE [flags]
Arguments
PARENT
Le Workspace où cet Endpoint sera créé. Format : workspaces/{workspace_id}
ENDPOINT_TYPE
Type d'endpoint. Valeurs prises en charge : STANDARD, STORAGE_OPTIMIZED
Options
--budget-policy-id string
L’identifiant de la politique budgétaire sélectionné par l’utilisateur pour l’endpoint.
--endpoint-id string
Le nom court fourni par l’utilisateur pour l’Endpoint.
--json JSON
La chaîne JSON inline ou le @path vers le fichier JSON contenant le corps de la requête.
--name string
Nom de l'endpoint de recherche IA.
--replica-count int
Le nombre de répliques souhaité pour l'Endpoint.
--target-qps int
QPS cible (query par seconde) pour l'Endpoint.
--usage-policy-id string
L'ID de politique d'utilisation appliqué à l'endpoint.
databricks ai-search create-index
Créer un index de recherche IA.
databricks ai-search create-index PARENT PRIMARY_KEY INDEX_TYPE [flags]
Arguments
PARENT
L'endpoint où cet index sera créé. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}
PRIMARY_KEY
Clé primaire de l’index. Défini lors de la création et immuable par la suite.
INDEX_TYPE
Type d’index. Valeurs prises en charge : DELTA_SYNC, DIRECT_ACCESS
Options
--index-id string
Nom de la table Unity Catalog fourni par l'utilisateur pour l'index.
--index-subtype IndexSubtype
Le sous-type de l'index. Valeurs prises en charge : FULL_TEXT, HYBRID, VECTOR
--json JSON
La chaîne JSON inline ou le @path vers le fichier JSON contenant le corps de la requête.
--name string
Nom de l’index de recherche IA.
databricks ai-search delete-endpoint
Supprimer un endpoint de recherche IA.
databricks ai-search delete-endpoint NAME [flags]
Arguments
NAME
Nom complet de la ressource de l'endpoint à supprimer. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}
Options
databricks ai-search delete-index
Supprimer un index de recherche IA.
databricks ai-search delete-index NAME [flags]
Arguments
NAME
Nom complet de la ressource de l'index à supprimer. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
Options
databricks ai-search get-endpoint
Obtenir un endpoint de recherche IA.
databricks ai-search get-endpoint NAME [flags]
Arguments
NAME
Nom complet de la ressource de l'endpoint. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}
Options
databricks ai-search get-index
Obtenir un index de recherche IA.
databricks ai-search get-index NAME [flags]
Arguments
NAME
Nom complet de la ressource de l'index. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
Options
databricks ai-search list-Endpoint
Lister les Endpoint de recherche IA.
databricks ai-search list-endpoints PARENT [flags]
Arguments
PARENT
Le Workspace qui possède cette collection d’Endpoint. Format : workspaces/{workspace_id}
Options
--limit int
Nombre maximal de résultats à renvoyer.
--page-size int
Limite supérieure au mieux du nombre de résultats à renvoyer.
databricks ai-search list-indexes
Lister les index de recherche IA.
databricks ai-search list-indexes PARENT [flags]
Arguments
PARENT
L’Endpoint qui possède cette collection d’index. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}
Options
--limit int
Nombre maximal de résultats à renvoyer.
--page-size int
Limite supérieure au mieux du nombre de résultats à renvoyer.
databricks ai-search query-index
Effectuer une query sur un index de recherche IA.
databricks ai-search query-index NAME [flags]
Arguments
NAME
Nom complet de la ressource de l'index à query. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
Options
--filters-json string
Chaîne JSON décrivant les filtres de query.
--json JSON
La chaîne JSON inline ou le @path vers le fichier JSON contenant le corps de la requête.
--max-results int
Nombre maximal de résultats à renvoyer.
--query-text string
Texte de la query.
--query-type string
Type de query : ANN, HYBRID ou FULL_TEXT.
--score-threshold float
threshold de score pour la recherche des plus proches voisins approximatifs.
databricks ai-search remove-data
Supprimer les données d’un index de recherche IA.
databricks ai-search remove-data NAME [flags]
Arguments
NAME
Nom complet de la ressource de l'index. Doit être un index à accès direct. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
Options
--json JSON
La chaîne JSON inline ou le @path vers le fichier JSON contenant le corps de la requête.
databricks ai-search scan-index
Analysez un index de recherche IA.
databricks ai-search scan-index NAME [flags]
Arguments
NAME
Nom complet de la ressource de l’index à analyser. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
Options
--json JSON
La chaîne JSON inline ou le @path vers le fichier JSON contenant le corps de la requête.
--page-size int
Nombre maximal de lignes à renvoyer sur cette page.
--page-token string
Jeton de page provenant d'une réponse précédente. Si non défini, l'analyse start au début.
databricks ai-search sync-index
Synchronisez un index de recherche IA.
databricks ai-search sync-index NAME [flags]
Arguments
NAME
Nom complet de la ressource de l'index à synchroniser. Doit être un index Delta Sync. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
Options
databricks ai-search update-endpoint
Mettre à jour un endpoint de recherche IA.
databricks ai-search update-endpoint NAME UPDATE_MASK ENDPOINT_TYPE [flags]
Arguments
NAME
Nom de l'endpoint de recherche IA. Chemin complet de la ressource en sortie (format : workspaces/{workspace_id}/endpoints/{endpoint_id}).
UPDATE_MASK
La liste des champs à mettre à jour.
ENDPOINT_TYPE
Type d'endpoint. Valeurs prises en charge : STANDARD, STORAGE_OPTIMIZED
Options
--budget-policy-id string
L’identifiant de la politique budgétaire sélectionné par l’utilisateur pour l’endpoint.
--json JSON
La chaîne JSON inline ou le @path vers le fichier JSON contenant le corps de la requête.
--name string
Nom de l'endpoint de recherche IA.
--replica-count int
Le nombre de répliques souhaité pour l'Endpoint.
--target-qps int
QPS cible (query par seconde) pour l'Endpoint.
--usage-policy-id string
L'ID de politique d'utilisation appliqué à l'endpoint.
databricks ai-search upsert-data
Upserter des données dans un index de recherche IA.
databricks ai-search upsert-data NAME INPUTS_JSON [flags]
Arguments
NAME
Nom complet de la ressource de l'index. Doit être un index à accès direct. Format : workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}
INPUTS_JSON
Document JSON décrivant les lignes à upserter.
Options
--json JSON
La chaîne JSON inline ou le @path vers le fichier JSON contenant le corps de la requête.
Indicateurs globaux
--debug
Indique s'il faut activer la journalisation de débogage.
-h OU --help
Affichez l'aide pour la CLI Databricks, le groupe de commandes associé ou la commande associée.
--log-file chaîne
Chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, default consiste à é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
Chaîne représentant le niveau de format des Logs. Si rien n’est spécifié, le niveau de format des Logs est désactivé.
-o, --output Type
Le type de sortie de la commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Le nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, le profil nommé DEFAULT est utilisé s'il existe.
--progress-format Format
Le format d'affichage des logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser