此页面由 Cloud Translation API 翻译。

管理索引端点

Vision Warehouse 索引端点是用于提供 Vision Warehouse 索引的受管理环境。索引端点提供了一个用于发送搜索请求的单一访问点。如需搜索 Vision Warehouse 语料库，您需要先创建 indexEndpoint 资源，然后将索引部署到该资源。

创建索引端点

REST

如需创建索引端点，请使用 projects.locations.indexEndpoints.create 方法发送 POST 请求。

在使用任何请求数据之前，请先进行以下替换：

REGIONALIZED_ENDPOINT：端点可能包含与 LOCATION_ID 匹配的前缀，例如 europe-west4-。详细了解区域化端点。
PROJECT_NUMBER：您的 Google Cloud 项目编号。
LOCATION_ID：您使用 Vertex AI Vision 的区域。例如：us-central1、europe-west4。请参阅可用区域。
INDEX_ENDPOINT_ID：（可选）用户为索引端点 ID 提供的值。在此请求中，该值以以下形式添加到请求网址中：
- https://REGIONALIZED_ENDPOINT/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints?index_endpoint_id=INDEX_ENDPOINT_ID

HTTP 方法和网址：

POST https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints

请求 JSON 正文：

{
  "display_name": "DISPLAY_NAME",
  "description": "DESCRIPTION",
}

如需发送请求，请选择以下方式之一：

curl

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI，或者使用了 Cloud Shell，这会使您自动登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints"

PowerShell

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.visionai.v1.CreateIndexEndpointMetadata"
  }
}

更新索引端点

借助 UpdateIndexEndpoint API，您可以更新索引端点的元数据字段，例如 display_name 和 description。不允许更新索引端点的 labels 字段。

请求中的 update_mask 字段（也称为字段掩码）用于指定更新将在 indexEndpoint 资源中覆盖的字段。update_mask 字段中指定的字段与资源相关，而不是与完整请求相关。如果资源字段在掩码中，则会被覆盖。不允许字段掩码为空。如果掩码为“*”，则会触发对索引端点的完全更新。

REST

如需更新索引端点，请使用 projects.locations.indexEndpoints.patch 方法发送 PATCH 请求。

在使用任何请求数据之前，请先进行以下替换：

REGIONALIZED_ENDPOINT：端点可能包含与 LOCATION_ID 匹配的前缀，例如 europe-west4-。详细了解区域化端点。
PROJECT_NUMBER：您的 Google Cloud 项目编号。
LOCATION_ID：您使用 Vertex AI Vision 的区域。例如：us-central1、europe-west4。请参阅可用区域。
INDEX_ENDPOINT_ID：目标索引端点的 ID。
?update_mask=fieldToUpdate：您要应用更新的可用字段的列表。在请求正文中为新字段指定相应的值。此新值会替换现有的字段值。您可以将多个字段指定为以逗号分隔的值。可用字段：
- 显示名：?update_mask=display_name
- 说明：?update_mask=description
- 更新所有字段：?update_mask=*

HTTP 方法和网址：

PATCH https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID?update_mask=display_name

请求 JSON 正文：

{
  "display_name": "DISPLAY_NAME"
}

如需发送请求，请选择以下方式之一：

curl

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID?update_mask=display_name"

PowerShell

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID?update_mask=display_name" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.visionai.v1.UpdateIndexEndpointMetadata"
  }
}

列出索引端点

REST

如需列出 Vision Warehouse 项目下的索引端点，请使用 projects.locations.indexEndpoints.list 方法发送 GET 请求。

在使用任何请求数据之前，请先进行以下替换：

REGIONALIZED_ENDPOINT：端点可能包含与 LOCATION_ID 匹配的前缀，例如 europe-west4-。详细了解区域化端点。
PROJECT_NUMBER：您的 Google Cloud 项目编号。
LOCATION_ID：您使用 Vertex AI Vision 的区域。例如：us-central1、europe-west4。请参阅可用区域。

HTTP 方法和网址：

GET https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints

如需发送请求，请选择以下方式之一：

curl

执行以下命令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints"

PowerShell

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "indexEndpoints": [
    {
      "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID_1",
      "displayName": "DISPLAY_NAME_1",
      "description": "DESCRIPTION_1",
      "state": "CREATED"
    },
    {
      "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID_2",
      "displayName": "DISPLAY_NAME_2",
      "description": "DESCRIPTION_2",
      "state": "CREATED"
    }
  ]
}

获取索引端点

REST

如需获取有关索引端点的详细信息，请使用 projects.locations.indexEndpoints.get 方法发送 GET 请求。

在使用任何请求数据之前，请先进行以下替换：

REGIONALIZED_ENDPOINT：端点可能包含与 LOCATION_ID 匹配的前缀，例如 europe-west4-。详细了解区域化端点。
PROJECT_NUMBER：您的 Google Cloud 项目编号。
LOCATION_ID：您使用 Vertex AI Vision 的区域。例如：us-central1、europe-west4。请参阅可用区域。
INDEX_ENDPOINT_ID：目标索引端点的 ID。

HTTP 方法和网址：

GET https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID

如需发送请求，请选择以下方式之一：

curl

执行以下命令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID"

PowerShell

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID",
  "displayName": "DISPLAY_NAME",
  "description": "DESCRIPTION",
  "state": "CREATED"
}

部署索引

REST

如需将索引部署到索引端点，请使用 projects.locations.indexEndpoints.deployIndex 方法发送 POST 请求。

在使用任何请求数据之前，请先进行以下替换：

REGIONALIZED_ENDPOINT：端点可能包含与 LOCATION_ID 匹配的前缀，例如 europe-west4-。详细了解区域化端点。
PROJECT_NUMBER：您的 Google Cloud 项目编号。
LOCATION_ID：您使用 Vertex AI Vision 的区域。例如：us-central1、europe-west4。请参阅可用区域。
INDEX_ENDPOINT_ID：目标索引端点的 ID。
CORPUS_ID：目标语料库的 ID。
INDEX_ID：目标索引的 ID。

HTTP 方法和网址：

POST https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID:deployIndex

请求 JSON 正文：

{
  "deployedIndex": {
    "index": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/indexes/INDEX_ID"
  }
}

如需发送请求，请选择以下方式之一：

curl

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID:deployIndex"

PowerShell

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID:deployIndex" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.visionai.v1.DeployIndexMetadata",
    "deployedIndex": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/indexes/INDEX_ID"
  }
}

取消部署索引

REST

如需从索引端点取消部署索引，请使用 projects.locations.indexEndpoints.undeployIndex 方法发送 POST 请求。

在使用任何请求数据之前，请先进行以下替换：

REGIONALIZED_ENDPOINT：端点可能包含与 LOCATION_ID 匹配的前缀，例如 europe-west4-。详细了解区域化端点。
PROJECT_NUMBER：您的 Google Cloud 项目编号。
LOCATION_ID：您使用 Vertex AI Vision 的区域。例如：us-central1、europe-west4。请参阅可用区域。
INDEX_ENDPOINT_ID：目标索引端点的 ID。

HTTP 方法和网址：

POST https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID:undeployIndex

如需发送请求，请选择以下方式之一：

curl

执行以下命令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID:undeployIndex"

PowerShell

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID:undeployIndex" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.visionai.v1.UndeployIndexMetadata"
  }
}

删除索引端点

只有在没有 index 部署到索引端点的情况下，才能删除该端点。在删除已部署索引的端点之前，请先取消部署索引。

REST

如需删除索引资源，请使用 projects.locations.indexEndpoints.delete 方法发送 DELETE 请求。

在使用任何请求数据之前，请先进行以下替换：

REGIONALIZED_ENDPOINT：端点可能包含与 LOCATION_ID 匹配的前缀，例如 europe-west4-。详细了解区域化端点。
PROJECT_NUMBER：您的 Google Cloud 项目编号。
LOCATION_ID：您使用 Vertex AI Vision 的区域。例如：us-central1、europe-west4。请参阅可用区域。
INDEX_ENDPOINT_ID：目标索引端点的 ID。

HTTP 方法和网址：

DELETE https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID

如需发送请求，请选择以下方式之一：

curl

执行以下命令：

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID"

PowerShell

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/indexEndpoints/INDEX_ENDPOINT_ID/operations/OPERATION_ID"
}

管理索引端点 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

创建索引端点

REST

curl

PowerShell

更新索引端点

REST

curl

PowerShell

列出索引端点

REST

curl

PowerShell

获取索引端点

REST

curl

PowerShell

部署索引

REST

curl

PowerShell

取消部署索引

REST

curl

PowerShell

删除索引端点

REST

curl

PowerShell

管理索引端点