Vue VECTOR_INDEX_OPTIONS

La vue INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS contient une ligne pour chaque colonne doté d'un index vectoriel sur chaque table d'un ensemble de données.

Autorisations requises

Pour afficher les métadonnées d'index vectoriel, vous devez disposer de l'autorisation IAM (gestion de l'authentification et des accès) bigquery.tables.get ou bigquery.tables.list sur la table contenant l'index. Chacun des rôles IAM prédéfinis suivants inclut au moins l'une de ces autorisations :

  • roles/bigquery.admin
  • roles/bigquery.dataEditor
  • roles/bigquery.dataOwner
  • roles/bigquery.dataViewer
  • roles/bigquery.metadataViewer
  • roles/bigquery.user

Pour plus d'informations sur les autorisations BigQuery, consultez la page Contrôle des accès avec IAM.

Schéma

Lorsque vous interrogez la vue INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS, les résultats de la requête contiennent une ligne pour chaque index de chaque table d'un ensemble de données.

La vue INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS présente le schéma suivant :

Nom de la colonne Type de données Valeur
index_catalog STRING Nom du projet qui contient l'ensemble de données.
index_schema STRING Nom de l'ensemble de données contenant l'index vectoriel.
table_name STRING Nom de la table sur laquelle l'index vectoriel est créé.
index_name STRING Nom de l'index vectoriel.
option_name STRING Nom de l'option utilisée dans l'instruction LDD (langage de définition de données) pour créer l'index vectoriel.
option_type STRING Type de données de l'option.
option_value STRING Valeur de l'option.

Champ d'application et syntaxe

Les requêtes exécutées sur cette vue doivent être associées à un qualificatif d'ensemble de données. Le tableau suivant explique le champ d'application de la région pour cette vue :

Nom de la vue Champ d'application de la ressource Champ d'application de la région
[PROJECT_ID.]DATASET_ID.INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS Niveau de l'ensemble de données Emplacement d'un ensemble de données

Remplacez les éléments suivants :

  • Facultatif : PROJECT_ID : ID de votre projet Google Cloud. Si non spécifié, le projet par défaut est utilisé.

    Exemple

    -- Returns metadata for vector indexes in a single dataset.
    SELECT * FROM myDataset.INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS;
    

    Exemples

    La requête suivante extrait des informations sur les options d'index vectoriels :

    SELECT table_name, index_name, option_name, option_type, option_value
    FROM my_project.dataset.INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS;

    Le résultat ressemble à ce qui suit :

    +------------+------------+------------------+------------------+-------------------------------------------------------------------+
    | table_name | index_name | option_name      | option_type      | option_value                                                      |
    +------------+------------+------------------+------------------+-------------------------------------------------------------------+
    | table1     | indexa     | index_type       | STRING           | IVF                                                               |
    | table1     | indexa     | distance_type    | STRING           | EUCLIDEAN                                                         |
    | table1     | indexa     | ivf_options      | STRING           | {"num_lists": 100}                                                |
    | table2     | indexb     | index_type       | STRING           | IVF                                                               |
    | table2     | indexb     | distance_type    | STRING           | COSINE                                                            |
    | table2     | indexb     | ivf_options      | STRING           | {"num_lists": 500}                                                |
    | table3     | indexc     | index_type       | STRING           | TREE_AH                                                           |
    | table3     | indexc     | distance_type    | STRING           | DOT_PRODUCT                                                       |
    | table3     | indexc     | tree_ah_options  | STRING           | {"leaf_node_embedding_count": 1000, "normalization_type": "NONE"} |
    +------------+------------+------------------+------------------+-------------------------------------------------------------------+