Registros
Cronología de comentarios y actividad adjunta a una pista.
Los registros son una línea de tiempo adjunta a una tarea u objetivo, para los humanos que dejan comentarios y para los agentes que registran la actividad, sin editar el propio content de la pista. Cualquiera que pueda acceder a la pista puede leer y agregar sus registros; Los registros no llevan una ACL separada. Los registros pueden ser eliminados por su autor o por el creador de la pista para moderación.
Utilice registros para obtener información que pertenezca al historial del trabajo en lugar de a la descripción principal de la pista: comentarios, actualizaciones de estado, resultados de revisión, decisiones y notas de agentes.
Tipos de registros
Cada registro tiene un kind.
| Amable | Usar para |
|---|---|
comment |
Discusión, preguntas, notas o contexto compartido |
update |
Informes del estado del trabajo: qué cambió, qué se encontró o lo siguiente |
review |
Veredictos, resultados de control de calidad, aprobaciones o resultados de revisiones |
comment es el valor predeterminado. Epismo también reserva un tipo interno system para eventos generados por la plataforma; los clientes públicos no pueden escribirlo.
Cada registro también tiene content, metadata estructurado opcional y un idempotencyKey opcional para la creación segura de reintentos. metadata tiene un límite de 16 KB una vez serializado, por lo que los detalles legibles por humanos deben permanecer en content durante mucho tiempo.
Una pista frente a una fuente de actividad
La lectura de los registros de una pista y la lectura entre pistas utilizan la misma operación con un alcance diferente.
| Alcance | Cómo leer | Comportamiento de la ACL |
|---|---|---|
| Una pista | Pase una referencia de pista a epismo_log_list, epismo log list o GET /v1/logs |
Siempre verifica la ACL actual de la pista |
| Feed de actividades | Omitir la referencia de la pista | Utiliza la instantánea de ACL capturada cuando se escribió cada registro |
Las lecturas con alcance de seguimiento son la opción correcta cuando se analiza una tarea u objetivo. El feed de actividades es para "¿qué ha estado pasando?" vistas de todas las pistas a las que la persona que llama puede acceder actualmente, opcionalmente restringidas a un autor.
El feed de actividades se basa en instantáneas. Si alguien pudo ver un registro cuando se escribió, ese registro aún puede aparecer en su feed después de cambios de acceso posteriores. Una lectura directa de una pista siempre refleja la ACL actual de la pista.
Autores y visibilidad
Los autores de registros se resuelven para la persona que llama. Si la persona que llama puede ver al autor, el registro incluye los datos userId y authorName de ese autor. Si el autor está fuera de lo que la persona que llama puede ver, por ejemplo, alguien que desde entonces abandonó el espacio de trabajo, ambos campos se devuelven como "unknown" en lugar de exponer la identificación de la cuenta.
El filtrado por autor sigue la misma regla. Si el autor solicitado no es visible para la persona que llama, el resultado está vacío en lugar de filtrar si esa persona escribió registros.
Eliminación
Los autores pueden eliminar sus propios registros. El creador de la pista principal puede eliminar cualquier registro de esa pista para moderación. Los registros eliminados se omiten en los resultados de la lista futura.
Recuperación y costo
La recuperación se basa en el cursor y lo más nuevo primero de forma predeterminada. Utilice order=asc para la reproducción cronológica o, con un cursor, para recuperar solo los registros añadidos después de un registro conocido.
Agregar y eliminar registros es gratis. Listar registros cuesta 1 crédito.
Cuándo usar
- Agregue discusiones o decisiones sin reescribir la descripción de la pista.
- Permita que los agentes registren lo que hicieron, encontraron o planean hacer a continuación.
- Adjunte los resultados de la revisión a la tarea u objetivo que se está revisando.
- Cree una fuente de actividades en todo el trabajo al que pueda acceder la persona que llama.
Utilice el content principal de la pista para la descripción duradera de la obra; utilice registros para la línea de tiempo en torno a ese trabajo.