Guia de Usuário¶

Este guia exemplifica de forma básica as principais operações para realizar a transcrição em arquivos individuais ou em um lote de arquivos. Elas são:

Transcrever arquivos¶

Exemplifica de forma básica as principais operações para transcrever arquivos individuais. Para maiores detalhes consulte o guia da API REST.

Para realizar a transcrição de arquivos individuais de áudio, deve-se realizar os seguintes passos:

1. Realizar o upload e a transcrição dos arquivos

Os arquivos podem ser transferidos pelo método create na API REST.

Exemplo:

curl -X POST "http://localhost:8000/trd/v3/job/create"
-H  "accept: application/json"
-H  "Content-Type: multipart/form-data"
-F "config="
-F "callback_urls="
-F "upload_file=@<path-to-file>/file1.wav;type=audio/wav"

Após utilizar o método create conforme descrito acima, serão devolvidas, como resultado, um json com informações relevantes ao estado do arquivo, como o seu identificador que é encontrado dentro do atributo <id> e informações relevantes ao estado atual do transcrição é pode ser encontrado dentro de <status>.

Exemplo:

{
	"job":{
	   "id":"5fc7baefeee464d8c64c7e1a",
	   "filename":"nas.wav",
	   "status":"QUEUED",
	   "created_at":"2020-12-02T13:03:59.801404-03:00",
	   "callback_urls":[
		  
	   ],
	   "media":{
		  "md5":"18eef3c06a975dc8cd1adad4ae662824",
		  "size":72544
	   },
	   "config":{
		  "diarization":{
			 "vad":{
				"chunk_max_silence":1200.0,
				"chunk_max_length":3600.0
			 },
			 "clustering":{
				"threshold":-0.4,
				"enabled": true
			}
		  },
		  "recognition":{
			 "params":{
				
			 },
			 "lm":"builtin:slm/callcenter-small"
		  }
	   }
	}
 }

2. Acompanhar o andamento do processo

Cada arquivo possui um atributo de controle que indica o estado atual do processo de transcrição. O atributo de controle possui os valores:

QUEUED: o arquivo está na fila esperando o inicio do processo de normalização.

IN_PROGRESS: o arquivo já entrou na pipeline de reconhecido e transcrição.

FAILED: o arquivo não conseguiu ser transcrito, por falha do sistema ou problemas com o audio.

STOPPED: o arquivo parou de ser transcrito por intermédio do operador do sistema.

COMPLETED: o arquivo já foi transcrito.

Exemplo:
curl -X GET "http://localhost:8000/trd/v3/job/status/<id>"

3. Recuperar o resultado da transcrição

Quando o arquivo estiver no estado COMPLETED, a transcrição daquele arquivo é considerada finalizada. A partir desse momento, o resultado da transcrição daquele arquivo pode ser consultado com segurança, pois todos os dados estarão completos.

Exemplo:
curl -X GET "http://localhost:8000/trd/v3/job/result/<id>""

4. Recuperar o resultado da transcrição com tags

Similar de como ocorre com a transcrição de arquivos individuais, podemos também fazer um controle de um grupo de arquivos através de uma <tag>, o upload funciona de forma similar ao item 1, porem podemos adicionar um parâmetro adicional a URL

Exemplo:
curl -X POST "http://localhost:8000/trd/v3/job/create?tag=<tag>"
-H "accept: application/json"
-H "Content-Type: multipart/form-data"
-F "config="
-F "callback_urls="
-F "upload_file=@<path-to-file>/file1.wav;type=audio/wav"

Agora podemos recuperar um grupo de arquivos que possuem a mesma <tag> e o mesmo <status>.

Exemplo:

curl -X GET "http://localhost:8000/trd/v3/query/job?status=<status>&tag=<tag>"