[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: indexes.import\n\n**Full name**: projects.locations.indexes.import\n\nImports an Index from an external source (e.g., BigQuery). \n\n### Endpoint\n\npost `https:``/``/{service-endpoint}``/v1beta1``/{name}:import` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`name` `string` \nRequired. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`\n\n### Request body\n\nThe request body contains data with the following structure:\nFields `isCompleteOverwrite` `boolean` \nOptional. If true, completely replace existing index data. Must be true for streaming update indexes.\n`config` `object (`[ConnectorConfig](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.indexes/import#ConnectorConfig)`)` \nRequired. Configuration for importing data from an external source. \n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\nConnectorConfig\n---------------\n\nConfiguration for importing data from an external source.\nFields \n`source` `Union type` \nThe source of the data to import. `source` can be only one of the following:\n`bigQuerySourceConfig` `object (`[BigQuerySourceConfig](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.indexes/import#BigQuerySourceConfig)`)` \nConfiguration for importing data from a BigQuery table. \n\nBigQuerySourceConfig\n--------------------\n\nConfiguration for importing data from a BigQuery table.\nFields `tablePath` `string` \nRequired. The path to the BigQuery table containing the index data, in the format of `bq://\u003cprojectId\u003e.\u003cdatasetId\u003e.\u003ctable\u003e`.\n`datapointFieldMapping` `object (`[DatapointFieldMapping](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.indexes/import#DatapointFieldMapping)`)` \nRequired. Mapping of datapoint fields to BigQuery column names. \n\nDatapointFieldMapping\n---------------------\n\nMapping of datapoint fields to column names for columnar data sources.\nFields `idColumn` `string` \nRequired. The column with unique identifiers for each data point.\n`embeddingColumn` `string` \nRequired. The column with the vector embeddings for each data point.\n`restricts[]` `object (`[Restrict](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.indexes/import#Restrict)`)` \nOptional. List of restricts for string values.\n`numericRestricts[]` `object (`[NumericRestrict](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.indexes/import#NumericRestrict)`)` \nOptional. List of restricts for numeric values.\n`metadataColumns[]` `string` \nOptional. List of columns containing metadata to be included in the index. \n\nRestrict\n--------\n\nRestrictions on string values.\nFields `namespace` `string` \nRequired. The namespace of the restrict in the index.\n`allowColumn[]` `string` \nOptional. The columns containing the allow values.\n`denyColumn[]` `string` \nOptional. The columns containing the deny values. \n\nNumericRestrict\n---------------\n\nRestrictions on numeric values.\nFields `namespace` `string` \nRequired. The namespace of the restrict.\n`valueColumn` `string` \nOptional. The column containing the numeric value.\n`valueType` `enum (`[ValueType](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.indexes/import#ValueType)`)` \nRequired. Numeric type of the restrict. Must be consistent for all datapoints within the namespace. \n\nValueType\n---------\n\nThe type of numeric value for the restrict."]]
