VocalStack Logo

Documentation

Атрымаць дадзеныя перапіскі

Атрымаць дадзеныя з чаканых або завершаных перапісаў

Транскрыпцыя з мікрафона або LiveStream

Праграма дазваляе перакладаць гук з мікрафона або з аўдыё- і відэа-потокаў

Сеансы перапіскі

Назіранне і кіраванне станам транскрыпцыі з дапамогай сеансаў

Пераклад

Перакладаць транскрыпцыю тэксту на іншую мову

Перапісаць гук з URL

Праграма перакладае гук з запісанага аўдыё ў URL у звычайны тэкст

Запыт і адказ на перапіску

Агульныя параметры запыту і адказу для ўсіх аперацый перапісвання

Транслітарацыя і прэзентацыя сеансу Polyglot

Стварыць сеанс, які можна выкарыстоўваць для трансляцыі транскрыпцыі ў рэжыме рэальнага часу праз публічную спасылку

Кліентскія аўтэнтыфікацыйныя токены

Прагляд дакументацыі
Стварыць часовы аўтэнтыфікацыйны токен для запытаў з боку кліента. Бездакорная рэалізацыя запытаў API у браўзарах без выяўлення вашых ключоў API.
У тэхнічных тэкстах звычайна выкарыстоўваецца сінтаксічная мова, якая ўключае ў сябе граматычныя элементы. Гэта неабходна пры рэалізацыі запытаў API у браўзарах, праграмах або іншых агульнапрынятых асяроддзях.
На сервернай баку мы можам выкарыстоўваць SDK для генерацыі аўтэнтыфікацыйнага токену. Па змаўчанні, параметры для таго, каб атрымаць ключ, абмежаваныя. Вы можаце абнавіць іх, каб адпавядаць вашым патрабаванням:
  • access: "толькі для чытання" або "для чытання і запісу". Першы дазваляе вам выконваць выклікі API, якія вяртаюць дадзеныя. У апошнім выпадку вы можаце таксама выконваць запыт API, які ўключае ў сябе аперацыі, звязаныя з плацежнымі транскрыпцыямі. Значэнне па змаўчанні для гэтага параметру -. "толькі для чытання".
  • lifetime_s: Лік паміж 1 і 120, які прадстаўляе час жыцця знака ў секундах. Пасля гэтага перыяду тэрмін дзеяння знака скончыцца і ён больш не будзе выкарыстоўвацца. Заўважце, што гэта не паўплывае на асінхронныя запыты, якія ўжо былі запушчаныя з выкарыстаннем гэтага токену. (Калі ў пачатку тэксту ёсць зварот да кагосьці, то ён павінен быць скончаны, калі не, то ён павінен быць спынены.) ) Значэнне па змаўчанні для гэтага параметру - 10-ы.
  • one_time: Лагічны значэнне, якое паказвае, ці прызначаны гэты токен API для аднаразовага выкарыстання. Калі вызначана, пасля таго, як гэты знак будзе выкарыстаны для запыту API, ён скончыцца. Значэнне па змаўчанні для гэтага параметру -. ісціна.
Вось як гэта будзе выглядаць на вашым серверы:
JavaScript
import { Security } from '@vocalstack/js-sdk'; const sdk = new Security({ apiKey: 'YOUR-API-KEY' }); const authToken = await sdk.generateToken({ access: 'readwrite', // Optional: 'readonly' or 'readwrite' lifetime_s: 60, // Optional: 1-120 seconds one_time: true, // Optional: true or false }); // Next, return the token to the client where API request will be made. // Make sure to keep the token secure and do not expose it to the public.
Вы павінны будзеце ўсталяваць механізм для абслугоўвання вашага сервера, які генеруе API- токены для вашага кліента. Гэта будзе ў значнай ступені залежаць ад вашай інфраструктуры і тэхналагічнага стака. Упэўніцеся, што вы ўкараняеце лепшыя практыкі бяспекі. Напрыклад, вы не павінны ствараць канечную кропку API, якая абслугоўвае генераваныя токены API для неаўтэнтыфікаваных запытаў.
Выкарыстанне API VocalStack на баку кліента патрабуе выкарыстання. authToken setting instead of an apiKey. Напрыклад, разгледзім дакументацыю для Перапісаць гук з URL.
У гэтым прыкладзе проста замяніць:
{ apiKey: 'YOUR-API-KEY' } з { authToken: 'YOUR-AUTH-TOKEN' } 2-е.
JavaScript
import { UrlTranscription } from '@vocalstack/js-sdk'; const authToken = await fetch('http://example.com/your-secured-api/authenticate') .then((response) => response.json()) .then((data) => data.token); const sdk = new UrlTranscription({ authToken }); const transcription = await sdk.connect({ url: 'http://example.com/speech.mp3' }); transcription.start();
У выпадку, калі ўсе патрабаванні да бяспекі і абароны дадзеных былі выкананы, то карыстальнікі могуць атрымаць доступ да дадзеных, якія не былі абаронены. Токены – гэта магутныя інструменты для доступу да рэсурсаў і паслуг, і калі яны не абаронены, то могуць быць выкарыстаны няправільна. Вы павінны пераканацца, што толькі аўтарызаваныя кліенты могуць запрашаць і выкарыстоўваць токены, і вы ніколі не павінны выяўляць асабістыя дадзеныя, такія як ключы API ў публічнай асяроддзі. Недахопы могуць быць выяўлены ў неадпаведнасці з патрабаваннямі да бяспекі, неадпаведнасці патрабаванням да бяспекі, неадпаведнасці патрабаванням да бяспекі.
Каб забяспечыць бяспеку вашай рэалізацыі, разгледзіце наступныя лепшыя практыкі:
  • Ніколі не паказваць ключы API на баку кліента: Ключы API павінны заўсёды заставацца канфідэнцыйнымі і захоўвацца на серверы. У ёй змешчаны тэксты з кнігі «Кніга прарокаў» (І. сакавіка HTML (англ.: HTML) — мова праграмавання, якая выкарыстоўваецца для стварэння інтэрнэт-старонак.
  • Выкарыстоўваць генерацыю бяспечных токенаў з боку сервера: Усе карыстальнікі могуць выкарыстоўваць ключы для аўтэнтыфікацыі, якія не патрабуюцца для ўваходу ў сістэму.
  • Запыты на аўтэнтыфікацыю для токенаў: Дазволіць карыстальнікам або службам запытваць токены API пры дапамозе механізмаў аўтэнтыфікацыі (e.g. г. , OAuth, праверка сеансаў).
  • Ужываць HTTPS: Усе карыстальнікі HTTPS павінны быць у курсе, што HTTPS не забяспечвае абарону ад атак «чалавек па сярэдзіне».
  • Не паказваць знакі ў URL: У тэксце не павінна быць тэкстаў, якія могуць быць выкарыстаны ў якасці прыкладаў для ўваходу ў рэсурс.
  • Абмежаваць аб' ект: Усе карыстальнікі маюць доступ да ўсяго, што ім трэба, акрамя таго, што яны не маюць права на запіс.
  • Усталяваць тэрмін дзеяння знака: Выкарыстоўвайце кароткія тэрміны жыцця токенаў, каб зменшыць рызыку неправамернага выкарыстання токенаў. У аснове ідэі ляжыць ідэя аб неабходнасці абароны і бяспекі.
  • Дазволіць аднаразовыя значкі: Калі гэта магчыма, выкарыстоўвайце аднаразовыя токены для асабліва чувствительных дзеянняў, каб пераканацца, што яны не могуць быць выкарыстаны зноў.
Scroll Up