Restricción
Si hay una propiedad de facet en la configuración de búsqueda, sus campos asignados siempre deben coincidir con los de la propiedad de criterios de búsqueda. Estos campos deben ser el esquema de datos que ya tengas, con el mismo tipo, granularidad y estrategia de búsqueda.
Crear una configuración de búsqueda
REST
Para crear un recurso SearchConfig
, envía una solicitud POST mediante el método projects.locations.corpora.searchConfigs.create
.
A continuación, se muestra un ejemplo de cómo crear una configuración de búsqueda con criterios de búsqueda personalizados.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- REGIONALIZED_ENDPOINT: el endpoint puede incluir un prefijo que coincida con
LOCATION_ID
, comoeurope-west4-
. Consulta más información sobre los puntos finales regionalizados. - PROJECT_NUMBER: tu Google Cloud número de proyecto.
- LOCATION_ID: la región en la que usas Vertex AI Vision. Por ejemplo:
us-central1
,europe-west4
. Consulta las regiones disponibles. - CORPUS_ID: el ID del corpus de destino.
- SEARCHCONFIG: el nombre de tu objetivo
SearchConfig
. - El
SearchConfig
de este ejemplo esperson
.
Método HTTP y URL:
POST https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?search_config_id=person
Cuerpo JSON de la solicitud:
{ "search_criteria_property": { "mapped_fields": "player", "mapped_fields": "coach", "mapped_fields": "cheerleader", } }
Para enviar tu solicitud, elige una de estas opciones:
curl
Guarda el cuerpo de la solicitud en un archivo llamado request.json
y ejecuta el siguiente comando:
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/corpora/CORPUS_ID/searchConfigs?search_config_id=person"
PowerShell
Guarda el cuerpo de la solicitud en un archivo llamado request.json
y ejecuta el siguiente comando:
$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/corpora/CORPUS_ID/searchConfigs?search_config_id=person" | Select-Object -Expand Content
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/person", "searchCriteriaProperty": { "mappedFields": [ "player", "coach", "cheerleader" ] } }
Actualizar una configuración de búsqueda
REST
Para actualizar un recurso SearchConfig
, envía una solicitud POST mediante el método projects.locations.corpora.searchConfigs.patch
.
A continuación, se muestra un ejemplo de cómo crear una configuración de búsqueda con criterios de búsqueda personalizados.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- REGIONALIZED_ENDPOINT: el endpoint puede incluir un prefijo que coincida con
LOCATION_ID
, comoeurope-west4-
. Consulta más información sobre los puntos finales regionalizados. - PROJECT: tu Google Cloud ID de proyecto o número de proyecto.
- LOCATION_ID: la región en la que usas Vertex AI Vision. Por ejemplo:
us-central1
,europe-west4
. Consulta las regiones disponibles. - CORPUS_ID: el ID del corpus de destino.
- SEARCHCONFIG_ID: el ID de tu
SearchConfig
objetivo. "mappedFields"
: una o varias claves de anotación proporcionadas por el usuario.
Método HTTP y URL:
PATCH https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID
Cuerpo JSON de la solicitud:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID1", "searchCriteriaProperty": { "mappedFields": "dataschema2" } }
Para enviar tu solicitud, elige una de estas opciones:
curl
Guarda el cuerpo de la solicitud en un archivo llamado request.json
y ejecuta el siguiente comando:
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/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID"
PowerShell
Guarda el cuerpo de la solicitud en un archivo llamado request.json
y ejecuta el siguiente comando:
$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/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID" | Select-Object -Expand Content
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID1", "searchCriteriaProperty": { "mappedFields": [ "dataschema2" ] } }
Obtener una configuración de búsqueda
En el siguiente ejemplo se muestra cómo recuperar un SearchConfig
que facilita la búsqueda de personas en los datos almacenados en el almacén.
REST
Para obtener detalles sobre un SearchConfig
, envía una solicitud GET mediante el método projects.locations.corpora.searchConfigs.get.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- REGIONALIZED_ENDPOINT: el endpoint puede incluir un prefijo que coincida con
LOCATION_ID
, comoeurope-west4-
. Consulta más información sobre los puntos finales regionalizados. - PROJECT_NUMBER: tu Google Cloud número de proyecto.
- LOCATION_ID: la región en la que usas Vertex AI Vision. Por ejemplo:
us-central1
,europe-west4
. Consulta las regiones disponibles. - CORPUS_ID: el ID del corpus de destino.
- SEARCHCONFIG: el nombre de tu objetivo
SearchConfig
. - El
SearchConfig
de este ejemplo esperson
.
Método HTTP y URL:
GET https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el comando siguiente:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG"
PowerShell
Ejecuta el comando siguiente:
$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/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG" | Select-Object -Expand Content
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/person" "facet_property": { // Top-level facet group name. "display_name": "Person", // Each mapped_field will be displayed in the UI as a selectable value // under "Person". "mapped_fields": "player", // The maximum number of mapped_fields to be displayed. "result_size": 2, // The facet type is a singular value. In this case, type string. "bucket_type": FACET_BUCKET_TYPE_VALUE } }
Mostrar configuraciones de búsqueda
En el siguiente ejemplo se muestra cómo enumerar todos los recursos SearchConfig
creados anteriormente.
Puedes especificar el número de configuraciones de búsqueda que se mostrarán configurando el campo page_size
en tu solicitud.
REST
Para enumerar todas las configuraciones de búsqueda, envíe una solicitud GET mediante el método projects.locations.corpora.searchConfigs.list
.
En este ejemplo, el campo page_size
se ha definido en 2, lo que limita la respuesta a dos configuraciones de búsqueda. Si no se especifica el tamaño de la página, se usa el valor predeterminado de 25.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- REGIONALIZED_ENDPOINT: el endpoint puede incluir un prefijo que coincida con
LOCATION_ID
, comoeurope-west4-
. Consulta más información sobre los puntos finales regionalizados. - PROJECT_NUMBER: tu Google Cloud número de proyecto.
- LOCATION_ID: la región en la que usas Vertex AI Vision. Por ejemplo:
us-central1
,europe-west4
. Consulta las regiones disponibles. - CORPUS_ID: el ID del corpus de destino.
- PAGE_SIZE: (Opcional) Número de resultados que se devolverán.
Método HTTP y URL:
GET https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?page_size=2
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el comando siguiente:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?page_size=2"
PowerShell
Ejecuta el comando siguiente:
$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/corpora/CORPUS_ID/searchConfigs?page_size=2" | Select-Object -Expand Content
Deberías recibir una respuesta JSON similar a la siguiente:
{ "next_page_token": "xyz", "search_configs": { "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/person", "facet_property": { // Top-level facet group name. "display_name": "Person", // Each mapped_field will be displayed in the console as a selectable value // under "Person". "mapped_fields": "player", // The maximum number of mapped_fields to be displayed. "result_size": 2, // The facet type is a singular value. In this case, type string. "bucket_type": FACET_BUCKET_TYPE_VALUE } }, "search_configs": { "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/location", "facet_property": { // Top-level facet group name. "display_name": "location", // Each mapped_field will be displayed in the console as a selectable value // under "location". "mapped_fields": "city", // The maximum number of mapped_fields to be displayed. "result_size": 2, // The facet type is a singular value. In this case, type string. "bucket_type": FACET_BUCKET_TYPE_VALUE } } }
La respuesta solo contiene dos SearchConfigs
porque en la solicitud se ha definido el campo page_size=2
. Para ver la página siguiente de configuraciones de búsqueda, incluye el ajuste next_page_token
de la respuesta anterior en tu siguiente solicitud:
- https://warehouse-visionai.googleapis.com/v1alpha/[...]/searchConfigs?page_size=2&page_token='xyz'
Eliminar una configuración de búsqueda
REST Y LÍNEA DE COMANDOS
En el siguiente ejemplo de código se usa el método
projects.locations.corpora.searchConfigs.delete
para eliminar un SearchConfig
. El SearchConfig
debe existir para que esta solicitud se complete correctamente.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- REGIONALIZED_ENDPOINT: el endpoint puede incluir un prefijo que coincida con
LOCATION_ID
, comoeurope-west4-
. Consulta más información sobre los puntos finales regionalizados. - PROJECT_NUMBER: tu Google Cloud número de proyecto.
- LOCATION_ID: la región en la que usas Vertex AI Vision. Por ejemplo:
us-central1
,europe-west4
. Consulta las regiones disponibles. - CORPUS_ID: el ID del corpus de destino.
- SEARCHCONFIG_ID: el ID de tu
SearchConfig
objetivo.
Método HTTP y URL:
DELETE https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el comando siguiente:
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID"
PowerShell
Ejecuta el comando siguiente:
$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/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID" | Select-Object -Expand Content
Deberías recibir una respuesta JSON similar a la siguiente:
{}