@echo_rec/speech-to-text - npm Package Compare versions

@echo_rec/speech-to-text

Package Overview

Dependencies

Maintainers

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 1.0.0 to 1.0.1

images/logo-dark.png

package.json

		{
		"name": "@echo_rec/speech-to-text",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "Software para transcrever audio em texto",
		@@ -5,0 +5,0 @@ "private": false,

README.md

		@@ -1,24 +0,20 @@
		# @reportfy/apm
		[![npm version](https://img.shields.io/npm/v/@reportfy/apm.svg?style=flat-square)](https://www.npmjs.org/package/@reportfy/apm)
		[![install size](https://packagephobia.now.sh/badge?p=@reportfy/apm)](https://packagephobia.now.sh/result?p=@reportfy/apm)
		[![npm downloads](https://img.shields.io/npm/dm/@reportfy/apm.svg?style=flat-square)](http://npm-stat.com/charts.html?package=@reportfy/apm)
		# @echo_rec/speech-to-text
		[![npm version](https://img.shields.io/npm/v/@echo_rec/speech-to-text.svg?style=flat-square)](https://www.npmjs.org/package/@echo_rec/speech-to-text)
		[![install size](https://packagephobia.now.sh/badge?p=@echo_rec/speech-to-text)](https://packagephobia.now.sh/result?p=@echo_rec/speech-to-text)
		[![npm downloads](https://img.shields.io/npm/dm/@echo_rec/speech-to-text.svg?style=flat-square)](http://npm-stat.com/charts.html?package=@echo_rec/speech-to-text)


		![reportfy](https://github.com/reportfy/apm/blob/master/images/reportfy.svg)
		![echo.rec](https://raw.githubusercontent.com/echo-rec/speech-to-text/main/images/logo-dark.png)

		Transcrição de voz para texto em clientes com node.js.

		Apm para clientes express para uso com node.js.
		> Sobre echo.rec [clique aqui](https://app.echo.rec.br).

		> Sobre reportfy: [clique aqui](https://reportfy.com.br/)

		## Sobre a apm.
		- [Instalação](#instalação)
		- [Configuração](#configuração)
		- [Chamadas de api da aplicação.](#api)
		- [Logs de aplicação](#logs)
		- [Interceptação de integração](#intercept)
		- [Erros costomizado](#custom)
		- [Transcrição de voz para texto.](#transcribe)


		## instalação
		## Instalação

		@@ -28,3 +24,3 @@ Usando npm:
		```bash
		$ npm install @reportfy/apm --save
		$ npm i @echo_rec/speech-to-text --save
		```
		@@ -35,3 +31,3 @@
		```bash
		$ yarn add @reportfy/apm
		$ yarn add @echo_rec/speech-to-text
		```
		@@ -41,15 +37,12 @@

		Para configuração é necessário acessar o [sistema da reporfy](https://app.reportfy.com.br) e
		criar sua APM, com isso terá o token para integração do sdk.
		Para utilização da ferramenta, é necessário acessar o [sistema da echo.rec](https://app.echo.rec.br) e criar o seu token de integração.

		Após a instalação do seu sdk no seu ```package.json``` iremos para iniciar o projeto.
		Após a instalação do seu sdk no projeto, segue o exemplo para iniciar a instância da biblioteca.

		```js
		const reportfyApm = require('@reportfy/apm')
		const echoRec = require('@echo_rec/speech-to-text')

		const reportfyApm = reportfyApm.init({
		key: 'sua_chave_aqui',
		env: 'development',
		accessKey: 'access_key_workspace',
		secretKey: 'secret_key_workspace'
		const { transcribe } = echoRec({
		token: 'sua_chave_aqui',
		env: 'seu_ambiente'
		})
		@@ -59,34 +52,42 @@

		- [x] O campo ```key``` é obrigatório para que seus logs e erros de aplicação sejam enviados para [reportfy](https://reportfy.com.br).
		-[x] O campo ```accessKey``` é obrigatório, chave secreta para leitura de dados que contém criptografia da sua área de trabalho(workspace).
		-[x] O campo ```accessKey``` é obrigatório, chave secreta para leitura de dados que contém criptografia da sua área de trabalho(workspace).
		- [x] O campo ```env``` é opcional, ele serve para identificar os logs, issues, handler e tracing do seu ambiente. Por default a ````.env ```` é development.
		- [x] O campo ```tracing``` é opcional, ele serve para identificar realizar tracing http da sua api. Por default a ````tracing ```` é false.
		- [x] O campo ```token``` é obrigatório para identificação da sua aplicação no [echo.rec](https://app.echo.rec.br).
		- [x] O campo ```env``` é opcional, ele serve para identificar o ambiente da sua maquina, a ````.env ```` por padrão é ```development.```


		## transcribe

		Para que o [echo.rec](https://app.echo.rec.br) transcreva em texto o seu áudio, é necessário que envie o arquivo dos tipo:

		## Api
		- mp3
		- ogg

		Para que o [reportfy](https://reportfy.com.br) escute todas as request do [framework express](https://expressjs.com/) necessita da
		alocação do ```captureHandler``` como middleware, segue o exemplo abaixo:
		Segue o exemplo usando o sdk para transcrição do audio:

		```js
		const express = require('express')
		const reportfyApm = require('@reportfy/apm')
		const path = require('path')
		const echoRec = require('@echo_rec/speech-to-text')

		const app = express()
		const reportfyApm = reportfyApm.init({
		key: 'sua_chave_aqui',
		env: 'development',
		accessKey: 'access_key_workspace',
		secretKey: 'secret_key_workspace'
		const { transcribe } = echoRec({
		token: 'sua_chave_aqui',
		env: 'seu_ambiente'
		})

		app.use(express.json({}))
		app.use(reportfyApm.captureHandler)
		const file = path.join(__dirname, './', 'meu_audio_aqui.mp3')

		const port = process.env.PORT \|\| 3000

		app.listen(3000, () => console.log('Aplicão no ar: http://localhost:3000'))
		const result = await transcribe(file)

		console.log(result)
		```

		Saída no terminal.

		````json
		{
		"data": {
		"id": "d128aec0-0607-444e-a269-5ea98c1ffbda",
		"message": "Sua transcrição aqui em texto!"
		},
		"status": 201
		}
		````

Improved metrics