REST Resource: projects.locations.investigations

Recurso: Investigación

Contiene el contenido de una investigación de solución de problemas de Gemini Cloud Assist.

Representación JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "revision": string,
  "revisionIndex": integer,
  "revisionPredecessor": string,
  "annotations": {
    object (InvestigationAnnotations)
  },
  "executionState": enum (InvestigationExecutionState),
  "error": {
    object (Status)
  },
  "operation": string,
  "title": string,
  "observations": {
    string: {
      object (Observation)
    },
    ...
  },
  "observerStatuses": {
    string: {
      object (ObserverStatus)
    },
    ...
  }
}
Campos
name

string

Es el identificador. Nombre de la investigación, con el siguiente formato: projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}
createTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó la investigación.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó la investigación por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Opcional. Son etiquetas definidas por el usuario para la investigación.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
revision

string

Solo salida. Es el nombre del recurso de la revisión actual de la investigación, con el siguiente formato: projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}/revisions/{revision_id}
revisionIndex

integer

Solo salida. Índice de la revisión actual de la investigación.
revisionPredecessor

string

Opcional. Es el nombre de la revisión que fue la predecesora de esta revisión.
annotations

object (InvestigationAnnotations)

Opcional. Son anotaciones adicionales sobre la investigación.
executionState

enum (InvestigationExecutionState)

Solo salida. Es el estado de ejecución de la investigación.
error

object (Status)

Solo salida. Es el error si falló la ejecución de la investigación. Este campo solo se establecerá si executionState es INVESTIGATION_EXECUTION_STATE_FAILED.
operation

string

Solo salida. Es el nombre del recurso de la operación de ejecución que se realizó más recientemente en la investigación, con el siguiente formato: projects/{projectNumber}/locations/{locationId}/operations/{operation_id}
title

string

Opcional. Es el título legible por humanos de la investigación.
observations

map (key: string, value: object (Observation))

Opcional. Son las observaciones sobre el estado del proyecto que comprenden el contenido de la investigación.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
observerStatuses

map (key: string, value: object (ObserverStatus))

Opcional. Son los estados de los observadores que se invocaron para ejecutar la investigación.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

InvestigationAnnotations

Son anotaciones adicionales en una investigación.

Representación JSON 
{
  "supportCase": string,
  "revisionLastRunInterval": {
    object (Interval)
  },
  "pagePath": string,
  "extrasMap": {
    string: string,
    ...
  }
}
Campos
supportCase

string

Opcional. Es el ID del caso de asistencia asociado con la investigación.
revisionLastRunInterval

object (Interval)

Solo salida. Es el intervalo durante el cual se ejecutó la investigación por última vez.
pagePath

string

Opcional. Es la ruta de acceso de una página web desde la que se creó esta investigación.
extrasMap

map (key: string, value: string)

Opcional. Son anotaciones adicionales especificadas por el cliente.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Intervalo

Representa un intervalo de tiempo, codificado como una marca de tiempo de inicio (inclusiva) y una marca de tiempo de finalización (exclusiva).

El inicio debe ser menor o igual que el final. Cuando el inicio es igual al final, el intervalo está vacío (no coincide con ninguna hora). Cuando no se especifican el inicio ni el final, el intervalo coincide con cualquier hora.

Representación JSON 
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Opcional. Es el inicio inclusivo del intervalo.

Si se especifica, la marca de tiempo que coincida con este intervalo deberá ser igual o posterior al inicio.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Opcional. Es el final exclusivo del intervalo.

Si se especifica, la marca de tiempo que coincida con este intervalo deberá ser anterior al final.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

InvestigationExecutionState

Es el estado de ejecución de una investigación.

Enums
INVESTIGATION_EXECUTION_STATE_UNSPECIFIED Valor predeterminado. Este valor no se usa.
INVESTIGATION_EXECUTION_STATE_RUNNING Se está ejecutando la investigación.
INVESTIGATION_EXECUTION_STATE_MODIFIED La investigación aún no se ejecutó desde la última actualización.
INVESTIGATION_EXECUTION_STATE_FAILED Se completó la ejecución de la investigación, pero se produjo un error.
INVESTIGATION_EXECUTION_STATE_COMPLETED Todas las tareas de ejecución se completaron y la investigación está en reposo.

Observación

Una observación representa un solo hecho sobre el estado del sistema en investigación, junto con una clasificación de su relevancia.

Representación JSON 
{
  "id": string,
  "timeIntervals": [
    {
      object (Interval)
    }
  ],
  "title": string,
  "observationType": enum (ObservationType),
  "observerType": enum (ObserverType),
  "text": string,
  "data": {
    object
  },
  "dataUrls": {
    string: string,
    ...
  },
  "knowledgeUrls": {
    string: string,
    ...
  },
  "baseObservations": [
    string
  ],
  "relevantResources": [
    string
  ],
  "recommendation": string,
  "systemRelevanceScore": number,
  "relevanceOverride": enum (UserRelevance),
  "observationCompletionState": enum (ObservationCompletionState),
  "observedNormalOperation": boolean
}
Campos
id

string

Solo salida. Identifica esta observación de forma inequívoca. Siempre es igual a la clave del mapa de esta observación en la investigación principal.
timeIntervals[]

object (Interval)

Opcional. El momento en que se produjo la observación.
title

string

Opcional. Es el título legible por humanos de la observación.
observationType

enum (ObservationType)

Obligatorio. Es el tipo de observación.
observerType

enum (ObserverType)

Obligatorio. Es el tipo de observador que produjo esta observación.
text

string

Opcional. Es el texto en lenguaje natural o Markdown que explica la observación.
data

object (Struct format)

Opcional. Es una representación estructurada de la observación. No es necesario ni se garantiza que se ajuste a ningún esquema en particular.
dataUrls

map (key: string, value: string)

Opcional. Son las URLs que dirigen a la evidencia que respalda esta observación. Son mapas que relacionan una descripción legible por humanos con una URL.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
knowledgeUrls

map (key: string, value: string)

Opcional. Son URLs que dirigen a conocimiento de referencia relacionado con esta observación. Son mapas que relacionan una descripción legible por humanos con una URL.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
baseObservations[]

string

Opcional. Son los IDs de otras observaciones en las que se basa esta observación. Por ejemplo, una observación de hipótesis registrará las observaciones que respaldan esa hipótesis.
relevantResources[]

string

Opcional. Son los recursos de Google Cloud pertinentes para la observación. Deben ser URIs de recursos completamente calificados, p.ej.: "//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance"
recommendation

string

Opcional. Es un texto en lenguaje natural o Markdown que describe una acción recomendada para corregir la causa raíz o investigar más a fondo el problema.
systemRelevanceScore

number

Opcional. Qué tan pertinente considera el observador que es esta observación. Se usa para clasificar las observaciones al generar hipótesis. El sistema genera observaciones en el rango [-1, 1], en el que -1 significa completamente irrelevante, 0 significa neutral y 1 significa confianza total en su relevancia.
relevanceOverride

enum (UserRelevance)

Opcional. Es la evaluación de relevancia del usuario.
observationCompletionState

enum (ObservationCompletionState)

Opcional. Representa si la observación está completamente formada y se puede usar para sacar conclusiones.
observedNormalOperation

boolean

Opcional. Si es falso o no se especifica, esta observación brinda información sobre un problema o una causa raíz. Si es verdadero, esta observación indica que se observó que un sistema funcionaba con normalidad. Estos resultados negativos pueden ser hallazgos de diagnóstico útiles, y este campo no tiene correlación con la puntuación de relevancia.

ObservationType

Representa el tipo de datos que constituyen una observación. Esto es independiente de la procedencia: el usuario puede proporcionar un registro de forma explícita, o bien se puede extraer a través de la IA, o detectar con un manual de ejecución.

Enums
OBSERVATION_TYPE_UNSPECIFIED Valor predeterminado.
OBSERVATION_TYPE_CLOUD_LOG El texto de esta observación es una entrada de registro.
OBSERVATION_TYPE_CLOUD_METRIC El contenido de esta observación es una métrica o un grupo de métricas.
OBSERVATION_TYPE_CAIS_CONFIG Es una configuración.
OBSERVATION_TYPE_CAIS_CONFIG_DIFF Es un cambio de configuración.
OBSERVATION_TYPE_CLOUD_ALERT Es una alerta.
OBSERVATION_TYPE_CICD_EVENT Es un evento de un sistema de integración continua, p. ej., una falla del verificador.
OBSERVATION_TYPE_TEXT_DESCRIPTION Es una entrada de texto libre, como la entrada inicial del usuario. Puede ser Markdown.
OBSERVATION_TYPE_HYPOTHESIS Se trata de conclusiones [provisionales] que extrae el sistema. Estos se pueden convertir en entradas para una revisión posterior. En este caso, se usarán las recomendaciones, pero no la corrección.
OBSERVATION_TYPE_STRUCTURED_INPUT Es una entrada estructurada, p. ej., parámetros de un runbook escritos en un formulario.
OBSERVATION_TYPE_COMPOSITE Se usa para una observación que incluye más de un tipo de evidencia, como el resultado de un runbook.
OBSERVATION_TYPE_OTHER El resultado del runbook puede ser "otro" si no se aplica ninguno de los otros tipos.
OBSERVATION_TYPE_LOG_THEME Es un tema que se descubrió en los registros.
OBSERVATION_TYPE_CONFIG_ANALYSIS Es un resultado de indicadores que incluye una configuración que analizó el LLM.
OBSERVATION_TYPE_OUTAGE Es la salida de indicadores que incluye una interrupción de PSH.
OBSERVATION_TYPE_KNOWLEDGE Es un texto que proporciona conocimiento sobre el problema de un usuario en particular. Por ejemplo, instrucciones del catálogo de errores/vínculos externos, RAG, etcétera.

ObserverType

Representa cómo llegaron los datos a la investigación.

Enums
OBSERVER_TYPE_UNSPECIFIED Valor predeterminado. No usuado.
OBSERVER_TYPE_DIAGNOSTICS Los diagnósticos tienen una noción explícita de las causas raíz, p. ej., a través de los runbooks.
OBSERVER_TYPE_SIGNALS Los indicadores son para el procesamiento que no tiene causas raíz explícitas.
OBSERVER_TYPE_DETERMINISTIC_CODE Esto es para el código que solo depende a nivel local. En particular, las búsquedas en el catálogo de errores.
OBSERVER_TYPE_AI Esto se aplica a las inferencias de IA que dependen solo de las observaciones que se enumeran como premisas.
OBSERVER_TYPE_USER Observación de la entrada del usuario, incluidas las respuestas a las aclaraciones. Todas las observaciones especificadas por el usuario se convertirán a este tipo.
OBSERVER_TYPE_ALERT Es una observación de una alerta.

UserRelevance

Esto representa la opinión del usuario respecto a la relevancia de una observación.

Enums
USER_RELEVANCE_UNSPECIFIED El usuario no marcó esta observación como pertinente o no pertinente.
USER_RELEVANCE_PROMOTED El usuario marcó esta observación como pertinente.
USER_RELEVANCE_REJECTED El usuario marcó esta observación como no pertinente.

ObservationCompletionState

Determina si la observación está completamente formada y completa.

Enums
OBSERVATION_COMPLETION_STATE_UNSPECIFIED Valor predeterminado. Se tratará como COMPLETADO.
OBSERVATION_COMPLETION_STATE_COMPLETE Esta observación está completamente formada.
OBSERVATION_COMPLETION_STATE_INCOMPLETE A esta observación le falta información o necesita que otro observador la procese aún más. Este tipo de observación se puede descartar en ejecuciones futuras de la investigación.

ObserverStatus

Un ObserverStatus representa el estado de un observador en un momento determinado durante la ejecución de una investigación.

Representación JSON 
{
  "observer": string,
  "observerExecutionState": enum (ObserverExecution),
  "observerDisplayName": string,
  "updateTime": string,
  "startTime": string,
  "updateComment": string,
  "observerErrors": [
    {
      object (Status)
    }
  ]
}
Campos
observer

string

Solo salida. Identifica este observador de forma única. Siempre es igual a la clave del mapa de este observador en la investigación principal.
observerExecutionState

enum (ObserverExecution)

Opcional. Es el estado actual de ejecución de la transacción.
observerDisplayName

string

Obligatorio. Nombre visible legible por humanos del observador.
updateTime

string (Timestamp format)

Opcional. Fecha y hora en la que el observador actualizó la investigación por última vez. Si el observerExecutionState es COMPLETE o FAILED, esta es la fecha y hora en que el observador finalizó su observación.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Opcional. Es la fecha y hora en que el observador comenzó su observación.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateComment

string

Opcional. Es una actualización de estado del observador.
observerErrors[]

object (Status)

Opcional. Es un error que impidió que un observador realizara una observación en particular.

ObserverExecution

Es el estado del observador.

Enums
OBSERVER_EXECUTION_UNSPECIFIED El estado del observador no está especificado.
OBSERVER_EXECUTION_NOT_STARTED La investigación aún no comenzó.
OBSERVER_EXECUTION_RUNNING La investigación se está ejecutando y este observador se puede ejecutar o se está ejecutando.
OBSERVER_EXECUTION_COMPLETE El observador finalizó sin errores internos.
OBSERVER_EXECUTION_FAILED El observador intentó ejecutarse, pero falló debido a un error. Esto es específico de un componente y se puede renderizar en la IU si se muestra la observación, ya que tiene una prioridad muy baja.
OBSERVER_EXECUTION_BLOCKED El observador está bloqueado a la espera de una entrada.
OBSERVER_EXECUTION_INVESTIGATION_BLOCKED El observador informa un error que bloquea o afecta gravemente la investigación, por ejemplo, CAIS o registro inhabilitado. Se debe renderizar de forma destacada en la IU.
OBSERVER_EXECUTION_INVESTIGATION_DEGRADED El observador informa un error que degrada la investigación y puede requerir que el usuario derive el caso o vuelva a ejecutar la investigación después de mitigar la causa.

Métodos

create

 Crea una investigación nueva en un proyecto determinado.

delete

 Borra una sola investigación.

get

 Obtiene detalles de una sola investigación.

getIamPolicy

 Permite obtener la política de control de acceso de un recurso.

list

 Enumera las investigaciones en una ubicación y un proyecto determinados.

patch

 Actualiza los parámetros de una sola investigación.

setIamPolicy

 Permite configurar la política de control de acceso en el recurso especificado.

testIamPermissions

 Permite mostrar los permisos que tiene un emisor para un recurso especificado.