Crea y administra resultados de predicción

En esta página, se muestra cómo crear y administrar los resultados de la predicción de AML AI. Los resultados de la predicción se guardan en las tablas de BigQuery.

En este punto, solo debes crear los resultados de la predicción. Los otros métodos de resultados de predicción se proporcionan por conveniencia.

Antes de comenzar

Crea resultados de predicción

Algunos métodos de la API muestran una operación de larga duración (LRO). Estos métodos son asíncronos. Es posible que la operación no se complete cuando el método muestra una respuesta. Para estos métodos, envía la solicitud y, luego, verifica el resultado.

Envía la solicitud

Para crear resultados de la predicción, usa el método projects.locations.instances.predictionResults.create.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
  • LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: Un identificador definido por el usuario para la instancia
  • PREDICTION_RESULTS_ID: Un identificador definido por el usuario para los resultados de la predicción
  • MODEL_ID: Es un identificador definido por el usuario para el modelo.
  • DATASET_ID: Es el identificador definido por el usuario para el conjunto de datos que se usa en las predicciones. Las tablas no deben tener las columnas de etiquetas de entrenamiento.
  • PREDICTION_END_DATE: La hora más reciente a partir de la cual se usan los datos para generar atributos de predicciones. Esta fecha debe ser la misma o anterior a la hora de finalización de los conjuntos de datos. Usa el formato RFC3339 UTC “Zulú” (por ejemplo, 2014-10-02T15:01:23Z).
  • PREDICTION_PERIODS: Es la cantidad de meses consecutivos para los que se producen predicciones, que finalizan con el último mes completo antes de la fecha de finalización de la predicción según la zona horaria del conjunto de datos.
  • BQ_OUTPUT_DATASET_NAME: Es el nombre del conjunto de datos de salida de BigQuery que se usa para la predicción.
  • BQ_OUTPUT_PREDICTION_TABLE: Es el identificador definido por el usuario para la tabla de BigQuery de salida que se usa en las predicciones.
  • BQ_OUTPUT_PREDICTION_EXPLAINABILITY_TABLE: El identificador definido por el usuario para la tabla de BigQuery explicativa de salida que se usa para la predicción. Quita el objeto explainabilityDestination opcional del JSON de la solicitud si no deseas exportar a una tabla de BigQuery.
  • WRITE_DISPOSITION: Es la acción que se produce si la tabla de destino ya existe. Usa uno de los siguientes valores:
    • WRITE_EMPTY: Solo exportar datos si la tabla de destino está vacía.
    • WRITE_TRUNCATE: Borra todos los datos existentes en la tabla de BigQuery antes de escribir en ella.

Cuerpo JSON de la solicitud:

{
    "model": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/models/MODEL_ID",
    "dataset": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/datasets/DATASET_ID",
    "endTime": "PREDICTION_END_DATE",
    "predictionPeriods": "PREDICTION_PERIODS",
    "outputs": {
      "predictionDestination": {
        "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.BQ_OUTPUT_PREDICTION_TABLE",
        "writeDisposition": "WRITE_DISPOSITION"
      },
      "explainabilityDestination": {
        "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.BQ_OUTPUT_PREDICTION_EXPLAINABILITY_TABLE",
        "writeDisposition": "WRITE_DISPOSITION"
      }
    }
}

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/predictionResults/PREDICTION_RESULTS_ID",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Verifica el resultado

Usa el método projects.locations.operations.get para verificar si se crearon los resultados de la predicción. Si la respuesta contiene "done": false, repite el comando hasta que contenga "done": true. Estas operaciones pueden tardar entre unos minutos y varias horas en completarse.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_ID: Es el ID del proyecto de Google Cloud que aparece en la configuración de IAM.
  • LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • OPERATION_ID: Es el identificador de la operación.

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": CREATE_TIME,
    "endTime": END_TIME,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/predictionResults/PREDICTION_RESULTS_ID",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/dataresidency.monitoring.DataResidencyAugmentedView",
    "tpIds": [
      "i608e8cf4abb2a7d9-tp"
    ]
  }
}

Obtén resultados de predicciones

Para obtener resultados de la predicción, usa el método projects.locations.instances.predictionResults.get.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
  • LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: El identificador definido por el usuario para la instancia
  • PREDICTION_RESULTS_ID: El identificador definido por el usuario para los resultados de la predicción

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
    "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/predictionResults/PREDICTION_RESULTS_ID",
    "createTime": CREATE_TIME,
    "updateTime": UPDATE_TIME,
    "state": "ACTIVE",
    "model": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/models/MODEL_ID",
    "dataset": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/datasets/DATASET_ID",
    "endTime": "PREDICTION_END_DATE",
    "predictionPeriods": PREDICTION_PERIODS,
    "outputs": {
      "predictionDestination": {
        "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.BQ_OUTPUT_PREDICTION_TABLE",
        "writeDisposition": "WRITE_DISPOSITION"
      },
      "explainabilityDestination": {
        "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.BQ_OUTPUT_PREDICTION_EXPLAINABILITY_TABLE",
        "writeDisposition": "WRITE_DISPOSITION"
      }
    },
    "lineOfBusiness": "RETAIL"
}

Actualiza los resultados de la predicción

Para actualizar los resultados de la predicción, usa el método projects.locations.instances.predictionResults.patch.

No todos los campos en los resultados de la predicción se pueden actualizar. En el siguiente ejemplo, se actualizan las etiquetas de usuario del par clave-valor asociadas con los resultados de la predicción.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
  • LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: El identificador definido por el usuario para la instancia
  • PREDICTION_RESULTS_ID: El identificador definido por el usuario para los resultados de la predicción
  • KEY: Es la clave de un par clave-valor que se usa para organizar los resultados de la predicción. Consulta labels para obtener más información.
  • VALUE: Es el valor de un par clave-valor que se usa para organizar los resultados de la predicción. Consulta labels para obtener más información.

Cuerpo JSON de la solicitud:

{
  "labels": {
    "KEY": "VALUE"
  }
}

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/predictionResults/PREDICTION_RESULTS_ID",
    "verb": "update",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Si quieres obtener más información para obtener el resultado de la operación de larga duración (LRO), consulta Verifica el resultado.

Obtén una lista de los resultados de la predicción

Para enumerar los resultados de la predicción de una instancia determinada, usa el método projects.locations.instances.predictionResults.list.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
  • LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: El identificador definido por el usuario para la instancia

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "predictionResults": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/predictionResults/PREDICTION_RESULTS_ID",
      "createTime": CREATE_TIME,
      "updateTime": UPDATE_TIME,
      "state": "ACTIVE",
      "model": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/models/MODEL_ID",
      "dataset": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/datasets/DATASET_ID",
      "endTime": "PREDICTION_END_DATE",
      "predictionPeriods": PREDICTION_PERIODS,
      "outputs": {
        "predictionDestination": {
          "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.BQ_OUTPUT_PREDICTION_TABLE",
          "writeDisposition": "WRITE_DISPOSITION"
        },
        "explainabilityDestination": {
          "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.BQ_OUTPUT_PREDICTION_EXPLAINABILITY_TABLE",
          "writeDisposition": "WRITE_DISPOSITION"
        }
      },
      "lineOfBusiness": "RETAIL"
    }
  ]
}

Exportar metadatos

Para exportar metadatos desde los resultados de la predicción, usa el método projects.locations.instances.predictionResults.exportMetadata.

Para obtener más información, consulta Metadatos exportados en el modelo de datos de salida AML.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
  • LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: El identificador definido por el usuario para la instancia
  • PREDICTION_RESULTS_ID: El identificador definido por el usuario para los resultados de la predicción
  • BQ_OUTPUT_DATASET_NAME: Un conjunto de datos de BigQuery en el que se exportará una tabla que describe los metadatos estructurados de los resultados de la predicción
  • STRUCTURED_METADATA_TABLE: Es la tabla en la que se escribirán los metadatos estructurados.
  • WRITE_DISPOSITION: Es la acción que se produce si la tabla de destino ya existe. Usa uno de los siguientes valores:
    • WRITE_EMPTY: Solo exportar datos si la tabla de destino está vacía.
    • WRITE_TRUNCATE: Borra todos los datos existentes en la tabla de BigQuery antes de escribir en ella.

Cuerpo JSON de la solicitud:

{
  "structuredMetadataDestination": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.STRUCTURED_METADATA_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  }
}

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/predictionResults/PREDICTION_RESULTS_ID",
    "verb": "exportMetadata",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Si quieres obtener más información para obtener el resultado de la operación de larga duración (LRO), consulta Verifica el resultado.

Borrar resultados de predicción

Para borrar los resultados de la predicción, usa el método projects.locations.instances.predictionResults.delete.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_ID: Es tu ID de tu proyecto de Google Cloud que aparece en Configuración de IAM.
  • LOCATION: Es la ubicación de la instancia. Usa una de las regiones compatibles:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: El identificador definido por el usuario para la instancia
  • PREDICTION_RESULTS_ID: El identificador definido por el usuario para los resultados de la predicción

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/predictionResults/PREDICTION_RESULTS_ID",
    "verb": "delete",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Si quieres obtener más información para obtener el resultado de la operación de larga duración (LRO), consulta Verifica el resultado.