Mensagens

BiometricConfig

Parâmetros de configuração comuns da verificação e cadastro. Todos os campos são opcionais.

min_utterances

uint32 - Define o número mínimo de enunciados que devem ser transmitidos para efetuar a operação biométrica.

O valor padrão é 1 e poderá ser definido entre 1 até 20. Se esse limiar não for atingido, a operação encerra com erro.

max_utterances

uint32 - Define o número máximo de enunciados que o serviço aceitará. Ao atingir esse limite, o serviço responderá uma decisão diferente de undecided.

O valor será de 1 até 20, e será maior ou igual ao valor de min_utterances. O valor padrão é o mesmo valor de min_utterances. Se a quantidade de enunciados ultrapassar este valor, o comportamento resultante é definido por max_constraint_behavior.

min_speech

uint32 - Duração mínima, em milissegundos, de fala. O valor será de 1000 até 120000. O valor padrão é 1000. Se esse limiar não for atingido, a operação encerra com erro.

max_speech

uint32 - Duração máxima, em milissegundos, de fala. O valor será de 1000 até 120000, e não deve ser inferior ao valor de min_speech. O valor padrão é 120000. Se esse limiar não for atingido, o comportamento resultante é definido por max_contraint_behavior.

max_constraint_behavior

string - Indica o comportamento quando os valores definidos por max_utterances e/ou max_speech forem ultrapassados. O valor padrão é trim. Os valores válidos são:

trim

Descarta o áudio excedente para que o total aproxime-se do limite superior e o processo continua normalmente (sem erro);

abort

Aborta todo o processo e retorna um erro para a aplicação.

end_silence

uint32 - Duração de um silêncio, em milissegundos, para que seja considerado como final de fala. O silêncio de final de fala define o ponto onde o áudio poderá ser cortado para gerar um enunciado. O valor padrão é 250 e pode ser definido entre 10 a 2000.

logging_tag

string - Tag a ser inserida nos logs do serviço para rastreio de requisições. O valor será uma string contendo até 32 caracteres e os caracteres válidos são: letras (não acentuadas), números, traços (-) e sublinhas (_).

account_tag

string - Tag a ser inserida no registro de tarifação, permitindo segregar o consumo em categorias. O valor será uma string contendo até 32 caracteres e os caracteres válidos são: letras (não acentuadas), números, traços (-) e sublinhas (_).

UtteranceInfo

Informações sobre os enunciados identificados nos áudios fornecidos pela aplicação.

audio_counter

uint32 - Contador de áudios, indicando a qual áudio de entrada que o enunciado corresponde. O primeiro áudio de entrada é representado pelo valor 0 (zero) e o valor é incrementado a cada áudio.

utterance_duration

uint32 - Duração total do enunciado, em milissegundos.

utterance_counter

uint32 - Identificador do enunciado. O primeiro enunciado é representado pelo valor 0 (zero) e o valor é incrementado a cada enunciado originado do mesmo áudio. A contagem reinicia para cada áudio de entrada.

ignored

boolean - Indica se o enunciado foi ignorado (true) ou não (false) durante o processamento da operação.

ignore_cause

string - Caso o valor do campo is_ignored seja true, este campo indica o motivo pelo qual o enunciado foi ignorado.

start_time

uint32 - Marcação temporal do início da fala, em milissegundos, relativo ao áudio de entrada.

end_time

uint32 - Marcação temporal do fim da fala, em milissegundos, relativo ao áudio de entrada.

ResultInfo

Resultado de verificação biométrica de um usuário específico.

user_id

uint64 - Identificador único do usuário ao qual o resultado se refere.

score

float - Score obtido considerando todos os áudios. Em caso de erro, será preenchido com 0 (zero), valor padrão para o campo.

decision

Decision - Decisão da verificação ou cadastro biométrico. Em caso de erro, será preenchido com UNDECIDED.

detail

ResultDetail - Detalhes sobre os resultados parciais que compõem a decisão final.

error

ErrorInfo - Informações sobre um erro na operação com o usuário indicado. Seu valor padrão é vazio em caso de sucesso.

ErrorInfo

Reúne informações sobre um erro relacionado a uma operação biométrica.

code

uint32 - Código de erro. Se a operação foi executada com sucesso, o valor zero será retornado.

message

string - Mensagem de erro. Se a operação foi executada com sucesso, nenhuma mensagem será retornada.

ResultDetail

Detalhes sobre os resultados parciais que compõem a decisão final.

biometric_decision

Decision - Decisão considerando apenas o resultado da verificação ou cadastro biométrico. Em caso de erro, será preenchido com UNDECIDED.

antispoofing_decision

Decision - Decisão considerando apenas o anti-spoofing. Em caso de erro, será preenchido com UNDECIDED.

ModificationStatus

Enumeração com os estados de modificação de uma entidade.

UNCHANGED

Nenhuma modificação foi realizada.

CREATED

Uma entidade foi criada.

UPDATED

Uma entidade foi atualizada/modificada.