Notrus
Beta

Referência do schema

Todos os tipos, campos e argumentos da API de leitura da Notrus, gerados a partir do schema em produção.

tipo

Query

categories
[Category!]!

Active categories in the authenticated organization's classification catalog.

conversation
Conversation

Uma única conversa pelo seu id de conversa nativo da plataforma; nulo se não encontrada.

  • conversationIdString!Seu id de conversa nativo da plataforma.
conversations
ConversationConnection!

Lista paginada de conversas da organização autenticada, das mais antigas para as mais recentes por padrão (veja `orderBy`).

  • afterStringCursor opaco do `pageInfo.endCursor` de uma página anterior.
  • filterConversationFilterFiltro booleano opcional sobre os tag-links das threads (retorna apenas as threads correspondentes), mais uma janela opcional e inclusiva de startDate/endDate sobre quando a conversa começou (nunca restringe as threads retornadas).
  • firstIntTamanho da página (limitado pelo servidor).
  • orderByConversationSortDirectionDireção de ordenação por quando cada conversa começou. Padrão ASC (mais antigas primeiro) — o comportamento histórico, inalterado a menos que você opte por DESC. Repita o mesmo valor em todas as páginas de uma mesma execução de paginação; cursores de `after` só são válidos combinados com a direção sob a qual foram emitidos.
tipo

Category

A category from your classification catalog.

definition
String!

Description of when this category applies.

identifier
String!

Stable machine identifier of the category.

name
String!

Human-readable name of the category.

subcategory
String

Subcategory grouping, when defined.

tipo

ClassifiedCategory

A categoria em que uma thread foi classificada, do seu catálogo de categorias.

identifier
String!

Identificador estável (de máquina) da categoria.

name
String!

Nome legível da categoria.

subcategory
String

Agrupamento de subcategoria, quando definido.

tipo

Conversation

Uma conversa — as threads que compartilham um mesmo id de conversa nativo da plataforma.

conversationId
String!

Seu id de conversa nativo da plataforma, exatamente como enviado à Notrus.

threads
[Thread!]!

As threads que pertencem a esta conversa, das mais antigas para as mais recentes.

tipo

ConversationConnection

Uma página de conversas no estilo Relay.

edges
[ConversationTypeEdge!]!
pageInfo
PageInfo!
enum

ConversationSortDirection

Direção de ordenação de `conversations`, por quando cada conversa começou.

  • ASCOldest conversations first (the default).
  • DESCMost recent conversations first.
tipo

ConversationTypeEdge

cursor
String!

Cursor opaco que identifica esta aresta para paginação.

node
Conversation!

O item nesta aresta.

escalar

DateTime

Uma data-hora em UTC, como 2019-12-03T09:54:33Z, em conformidade com o formato date-time.

tipo

Document

Um documento armazenado no armazenamento de objetos.

bucketName
String!

Bucket em que o documento está armazenado.

fileName
String!

Nome do objeto dentro do bucket.

filePath
String!

Caminho do objeto dentro do bucket.

mimeType
String!

Content type com que o documento foi armazenado.

originalName
String!

O nome de arquivo com que você o enviou.

tipo

Mutation

uploadDocument
Document!

Envia um documento. Mande como requisição multipart do GraphQL; o nome do arquivo e o content type são lidos da parte do arquivo.

  • fileUpload!O arquivo a armazenar.
tipo

PageInfo

Metadados de paginação no estilo Relay para uma página de conexão.

endCursor
String

Cursor opaco para passar como `after` na próxima página; nulo em uma página vazia.

hasNextPage
Boolean!

Verdadeiro se houver mais itens após esta página.

tipo

Thread

Uma thread dentro de uma conversa, projetada para o seu estado de classificação.

chatState
[TagLink!]!

Valores de chat-state aplicados à thread, dos mais antigos para os mais recentes.

classifiedCategory
ClassifiedCategory

A categoria em que a thread foi classificada; nulo quando não categorizada.

classifierState
[TagLink!]!

Valores de classifier-state aplicados à thread, dos mais antigos para os mais recentes.

summary
String

Resumo justificativo da Notrus para a thread, quando produzido.

threadId
ID!

Identificador interno de thread da Notrus (opaco, estável).

escalar

Upload

O escalar `Upload` representa o envio de um arquivo.