github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/transcribe-streaming/2017-10-26/api-2.json (about)

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2017-10-26",
     5      "endpointPrefix":"transcribestreaming",
     6      "protocol":"rest-json",
     7      "protocolSettings":{"h2":"eventstream"},
     8      "serviceFullName":"Amazon Transcribe Streaming Service",
     9      "serviceId":"Transcribe Streaming",
    10      "signatureVersion":"v4",
    11      "signingName":"transcribe",
    12      "uid":"transcribe-streaming-2017-10-26"
    13    },
    14    "operations":{
    15      "StartMedicalStreamTranscription":{
    16        "name":"StartMedicalStreamTranscription",
    17        "http":{
    18          "method":"POST",
    19          "requestUri":"/medical-stream-transcription"
    20        },
    21        "input":{"shape":"StartMedicalStreamTranscriptionRequest"},
    22        "output":{"shape":"StartMedicalStreamTranscriptionResponse"},
    23        "errors":[
    24          {"shape":"BadRequestException"},
    25          {"shape":"LimitExceededException"},
    26          {"shape":"InternalFailureException"},
    27          {"shape":"ConflictException"},
    28          {"shape":"ServiceUnavailableException"}
    29        ]
    30      },
    31      "StartStreamTranscription":{
    32        "name":"StartStreamTranscription",
    33        "http":{
    34          "method":"POST",
    35          "requestUri":"/stream-transcription"
    36        },
    37        "input":{"shape":"StartStreamTranscriptionRequest"},
    38        "output":{"shape":"StartStreamTranscriptionResponse"},
    39        "errors":[
    40          {"shape":"BadRequestException"},
    41          {"shape":"LimitExceededException"},
    42          {"shape":"InternalFailureException"},
    43          {"shape":"ConflictException"},
    44          {"shape":"ServiceUnavailableException"}
    45        ]
    46      }
    47    },
    48    "shapes":{
    49      "Alternative":{
    50        "type":"structure",
    51        "members":{
    52          "Transcript":{"shape":"String"},
    53          "Items":{"shape":"ItemList"},
    54          "Entities":{"shape":"EntityList"}
    55        }
    56      },
    57      "AlternativeList":{
    58        "type":"list",
    59        "member":{"shape":"Alternative"}
    60      },
    61      "AudioChunk":{"type":"blob"},
    62      "AudioEvent":{
    63        "type":"structure",
    64        "members":{
    65          "AudioChunk":{
    66            "shape":"AudioChunk",
    67            "eventpayload":true
    68          }
    69        },
    70        "event":true
    71      },
    72      "AudioStream":{
    73        "type":"structure",
    74        "members":{
    75          "AudioEvent":{"shape":"AudioEvent"}
    76        },
    77        "eventstream":true
    78      },
    79      "BadRequestException":{
    80        "type":"structure",
    81        "members":{
    82          "Message":{"shape":"String"}
    83        },
    84        "error":{"httpStatusCode":400},
    85        "exception":true
    86      },
    87      "Boolean":{"type":"boolean"},
    88      "Confidence":{"type":"double"},
    89      "ConflictException":{
    90        "type":"structure",
    91        "members":{
    92          "Message":{"shape":"String"}
    93        },
    94        "error":{"httpStatusCode":409},
    95        "exception":true
    96      },
    97      "ContentIdentificationType":{
    98        "type":"string",
    99        "enum":["PII"]
   100      },
   101      "ContentRedactionType":{
   102        "type":"string",
   103        "enum":["PII"]
   104      },
   105      "Double":{"type":"double"},
   106      "Entity":{
   107        "type":"structure",
   108        "members":{
   109          "StartTime":{"shape":"Double"},
   110          "EndTime":{"shape":"Double"},
   111          "Category":{"shape":"String"},
   112          "Type":{"shape":"String"},
   113          "Content":{"shape":"String"},
   114          "Confidence":{"shape":"Confidence"}
   115        }
   116      },
   117      "EntityList":{
   118        "type":"list",
   119        "member":{"shape":"Entity"}
   120      },
   121      "InternalFailureException":{
   122        "type":"structure",
   123        "members":{
   124          "Message":{"shape":"String"}
   125        },
   126        "error":{"httpStatusCode":500},
   127        "exception":true,
   128        "fault":true
   129      },
   130      "Item":{
   131        "type":"structure",
   132        "members":{
   133          "StartTime":{"shape":"Double"},
   134          "EndTime":{"shape":"Double"},
   135          "Type":{"shape":"ItemType"},
   136          "Content":{"shape":"String"},
   137          "VocabularyFilterMatch":{"shape":"Boolean"},
   138          "Speaker":{"shape":"String"},
   139          "Confidence":{"shape":"Confidence"},
   140          "Stable":{"shape":"Stable"}
   141        }
   142      },
   143      "ItemList":{
   144        "type":"list",
   145        "member":{"shape":"Item"}
   146      },
   147      "ItemType":{
   148        "type":"string",
   149        "enum":[
   150          "pronunciation",
   151          "punctuation"
   152        ]
   153      },
   154      "LanguageCode":{
   155        "type":"string",
   156        "enum":[
   157          "en-US",
   158          "en-GB",
   159          "es-US",
   160          "fr-CA",
   161          "fr-FR",
   162          "en-AU",
   163          "it-IT",
   164          "de-DE",
   165          "pt-BR",
   166          "ja-JP",
   167          "ko-KR",
   168          "zh-CN"
   169        ]
   170      },
   171      "LimitExceededException":{
   172        "type":"structure",
   173        "members":{
   174          "Message":{"shape":"String"}
   175        },
   176        "error":{"httpStatusCode":429},
   177        "exception":true
   178      },
   179      "MediaEncoding":{
   180        "type":"string",
   181        "enum":[
   182          "pcm",
   183          "ogg-opus",
   184          "flac"
   185        ]
   186      },
   187      "MediaSampleRateHertz":{
   188        "type":"integer",
   189        "max":48000,
   190        "min":8000
   191      },
   192      "MedicalAlternative":{
   193        "type":"structure",
   194        "members":{
   195          "Transcript":{"shape":"String"},
   196          "Items":{"shape":"MedicalItemList"},
   197          "Entities":{"shape":"MedicalEntityList"}
   198        }
   199      },
   200      "MedicalAlternativeList":{
   201        "type":"list",
   202        "member":{"shape":"MedicalAlternative"}
   203      },
   204      "MedicalContentIdentificationType":{
   205        "type":"string",
   206        "enum":["PHI"]
   207      },
   208      "MedicalEntity":{
   209        "type":"structure",
   210        "members":{
   211          "StartTime":{"shape":"Double"},
   212          "EndTime":{"shape":"Double"},
   213          "Category":{"shape":"String"},
   214          "Content":{"shape":"String"},
   215          "Confidence":{"shape":"Confidence"}
   216        }
   217      },
   218      "MedicalEntityList":{
   219        "type":"list",
   220        "member":{"shape":"MedicalEntity"}
   221      },
   222      "MedicalItem":{
   223        "type":"structure",
   224        "members":{
   225          "StartTime":{"shape":"Double"},
   226          "EndTime":{"shape":"Double"},
   227          "Type":{"shape":"ItemType"},
   228          "Content":{"shape":"String"},
   229          "Confidence":{"shape":"Confidence"},
   230          "Speaker":{"shape":"String"}
   231        }
   232      },
   233      "MedicalItemList":{
   234        "type":"list",
   235        "member":{"shape":"MedicalItem"}
   236      },
   237      "MedicalResult":{
   238        "type":"structure",
   239        "members":{
   240          "ResultId":{"shape":"String"},
   241          "StartTime":{"shape":"Double"},
   242          "EndTime":{"shape":"Double"},
   243          "IsPartial":{"shape":"Boolean"},
   244          "Alternatives":{"shape":"MedicalAlternativeList"},
   245          "ChannelId":{"shape":"String"}
   246        }
   247      },
   248      "MedicalResultList":{
   249        "type":"list",
   250        "member":{"shape":"MedicalResult"}
   251      },
   252      "MedicalTranscript":{
   253        "type":"structure",
   254        "members":{
   255          "Results":{"shape":"MedicalResultList"}
   256        }
   257      },
   258      "MedicalTranscriptEvent":{
   259        "type":"structure",
   260        "members":{
   261          "Transcript":{"shape":"MedicalTranscript"}
   262        },
   263        "event":true
   264      },
   265      "MedicalTranscriptResultStream":{
   266        "type":"structure",
   267        "members":{
   268          "TranscriptEvent":{"shape":"MedicalTranscriptEvent"},
   269          "BadRequestException":{"shape":"BadRequestException"},
   270          "LimitExceededException":{"shape":"LimitExceededException"},
   271          "InternalFailureException":{"shape":"InternalFailureException"},
   272          "ConflictException":{"shape":"ConflictException"},
   273          "ServiceUnavailableException":{"shape":"ServiceUnavailableException"}
   274        },
   275        "eventstream":true
   276      },
   277      "NumberOfChannels":{
   278        "type":"integer",
   279        "min":2
   280      },
   281      "PartialResultsStability":{
   282        "type":"string",
   283        "enum":[
   284          "high",
   285          "medium",
   286          "low"
   287        ]
   288      },
   289      "PiiEntityTypes":{
   290        "type":"string",
   291        "max":300,
   292        "min":1,
   293        "pattern":"^[A-Z_, ]+"
   294      },
   295      "RequestId":{"type":"string"},
   296      "Result":{
   297        "type":"structure",
   298        "members":{
   299          "ResultId":{"shape":"String"},
   300          "StartTime":{"shape":"Double"},
   301          "EndTime":{"shape":"Double"},
   302          "IsPartial":{"shape":"Boolean"},
   303          "Alternatives":{"shape":"AlternativeList"},
   304          "ChannelId":{"shape":"String"}
   305        }
   306      },
   307      "ResultList":{
   308        "type":"list",
   309        "member":{"shape":"Result"}
   310      },
   311      "ServiceUnavailableException":{
   312        "type":"structure",
   313        "members":{
   314          "Message":{"shape":"String"}
   315        },
   316        "error":{"httpStatusCode":503},
   317        "exception":true
   318      },
   319      "SessionId":{
   320        "type":"string",
   321        "max":36,
   322        "min":36,
   323        "pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
   324      },
   325      "Specialty":{
   326        "type":"string",
   327        "enum":[
   328          "PRIMARYCARE",
   329          "CARDIOLOGY",
   330          "NEUROLOGY",
   331          "ONCOLOGY",
   332          "RADIOLOGY",
   333          "UROLOGY"
   334        ]
   335      },
   336      "Stable":{"type":"boolean"},
   337      "StartMedicalStreamTranscriptionRequest":{
   338        "type":"structure",
   339        "required":[
   340          "LanguageCode",
   341          "MediaSampleRateHertz",
   342          "MediaEncoding",
   343          "Specialty",
   344          "Type",
   345          "AudioStream"
   346        ],
   347        "members":{
   348          "LanguageCode":{
   349            "shape":"LanguageCode",
   350            "location":"header",
   351            "locationName":"x-amzn-transcribe-language-code"
   352          },
   353          "MediaSampleRateHertz":{
   354            "shape":"MediaSampleRateHertz",
   355            "location":"header",
   356            "locationName":"x-amzn-transcribe-sample-rate"
   357          },
   358          "MediaEncoding":{
   359            "shape":"MediaEncoding",
   360            "location":"header",
   361            "locationName":"x-amzn-transcribe-media-encoding"
   362          },
   363          "VocabularyName":{
   364            "shape":"VocabularyName",
   365            "location":"header",
   366            "locationName":"x-amzn-transcribe-vocabulary-name"
   367          },
   368          "Specialty":{
   369            "shape":"Specialty",
   370            "location":"header",
   371            "locationName":"x-amzn-transcribe-specialty"
   372          },
   373          "Type":{
   374            "shape":"Type",
   375            "location":"header",
   376            "locationName":"x-amzn-transcribe-type"
   377          },
   378          "ShowSpeakerLabel":{
   379            "shape":"Boolean",
   380            "location":"header",
   381            "locationName":"x-amzn-transcribe-show-speaker-label"
   382          },
   383          "SessionId":{
   384            "shape":"SessionId",
   385            "location":"header",
   386            "locationName":"x-amzn-transcribe-session-id"
   387          },
   388          "AudioStream":{"shape":"AudioStream"},
   389          "EnableChannelIdentification":{
   390            "shape":"Boolean",
   391            "location":"header",
   392            "locationName":"x-amzn-transcribe-enable-channel-identification"
   393          },
   394          "NumberOfChannels":{
   395            "shape":"NumberOfChannels",
   396            "location":"header",
   397            "locationName":"x-amzn-transcribe-number-of-channels"
   398          },
   399          "ContentIdentificationType":{
   400            "shape":"MedicalContentIdentificationType",
   401            "location":"header",
   402            "locationName":"x-amzn-transcribe-content-identification-type"
   403          }
   404        },
   405        "payload":"AudioStream"
   406      },
   407      "StartMedicalStreamTranscriptionResponse":{
   408        "type":"structure",
   409        "members":{
   410          "RequestId":{
   411            "shape":"RequestId",
   412            "location":"header",
   413            "locationName":"x-amzn-request-id"
   414          },
   415          "LanguageCode":{
   416            "shape":"LanguageCode",
   417            "location":"header",
   418            "locationName":"x-amzn-transcribe-language-code"
   419          },
   420          "MediaSampleRateHertz":{
   421            "shape":"MediaSampleRateHertz",
   422            "location":"header",
   423            "locationName":"x-amzn-transcribe-sample-rate"
   424          },
   425          "MediaEncoding":{
   426            "shape":"MediaEncoding",
   427            "location":"header",
   428            "locationName":"x-amzn-transcribe-media-encoding"
   429          },
   430          "VocabularyName":{
   431            "shape":"VocabularyName",
   432            "location":"header",
   433            "locationName":"x-amzn-transcribe-vocabulary-name"
   434          },
   435          "Specialty":{
   436            "shape":"Specialty",
   437            "location":"header",
   438            "locationName":"x-amzn-transcribe-specialty"
   439          },
   440          "Type":{
   441            "shape":"Type",
   442            "location":"header",
   443            "locationName":"x-amzn-transcribe-type"
   444          },
   445          "ShowSpeakerLabel":{
   446            "shape":"Boolean",
   447            "location":"header",
   448            "locationName":"x-amzn-transcribe-show-speaker-label"
   449          },
   450          "SessionId":{
   451            "shape":"SessionId",
   452            "location":"header",
   453            "locationName":"x-amzn-transcribe-session-id"
   454          },
   455          "TranscriptResultStream":{"shape":"MedicalTranscriptResultStream"},
   456          "EnableChannelIdentification":{
   457            "shape":"Boolean",
   458            "location":"header",
   459            "locationName":"x-amzn-transcribe-enable-channel-identification"
   460          },
   461          "NumberOfChannels":{
   462            "shape":"NumberOfChannels",
   463            "location":"header",
   464            "locationName":"x-amzn-transcribe-number-of-channels"
   465          },
   466          "ContentIdentificationType":{
   467            "shape":"MedicalContentIdentificationType",
   468            "location":"header",
   469            "locationName":"x-amzn-transcribe-content-identification-type"
   470          }
   471        },
   472        "payload":"TranscriptResultStream"
   473      },
   474      "StartStreamTranscriptionRequest":{
   475        "type":"structure",
   476        "required":[
   477          "LanguageCode",
   478          "MediaSampleRateHertz",
   479          "MediaEncoding",
   480          "AudioStream"
   481        ],
   482        "members":{
   483          "LanguageCode":{
   484            "shape":"LanguageCode",
   485            "location":"header",
   486            "locationName":"x-amzn-transcribe-language-code"
   487          },
   488          "MediaSampleRateHertz":{
   489            "shape":"MediaSampleRateHertz",
   490            "location":"header",
   491            "locationName":"x-amzn-transcribe-sample-rate"
   492          },
   493          "MediaEncoding":{
   494            "shape":"MediaEncoding",
   495            "location":"header",
   496            "locationName":"x-amzn-transcribe-media-encoding"
   497          },
   498          "VocabularyName":{
   499            "shape":"VocabularyName",
   500            "location":"header",
   501            "locationName":"x-amzn-transcribe-vocabulary-name"
   502          },
   503          "SessionId":{
   504            "shape":"SessionId",
   505            "location":"header",
   506            "locationName":"x-amzn-transcribe-session-id"
   507          },
   508          "AudioStream":{"shape":"AudioStream"},
   509          "VocabularyFilterName":{
   510            "shape":"VocabularyFilterName",
   511            "location":"header",
   512            "locationName":"x-amzn-transcribe-vocabulary-filter-name"
   513          },
   514          "VocabularyFilterMethod":{
   515            "shape":"VocabularyFilterMethod",
   516            "location":"header",
   517            "locationName":"x-amzn-transcribe-vocabulary-filter-method"
   518          },
   519          "ShowSpeakerLabel":{
   520            "shape":"Boolean",
   521            "location":"header",
   522            "locationName":"x-amzn-transcribe-show-speaker-label"
   523          },
   524          "EnableChannelIdentification":{
   525            "shape":"Boolean",
   526            "location":"header",
   527            "locationName":"x-amzn-transcribe-enable-channel-identification"
   528          },
   529          "NumberOfChannels":{
   530            "shape":"NumberOfChannels",
   531            "location":"header",
   532            "locationName":"x-amzn-transcribe-number-of-channels"
   533          },
   534          "EnablePartialResultsStabilization":{
   535            "shape":"Boolean",
   536            "location":"header",
   537            "locationName":"x-amzn-transcribe-enable-partial-results-stabilization"
   538          },
   539          "PartialResultsStability":{
   540            "shape":"PartialResultsStability",
   541            "location":"header",
   542            "locationName":"x-amzn-transcribe-partial-results-stability"
   543          },
   544          "ContentIdentificationType":{
   545            "shape":"ContentIdentificationType",
   546            "location":"header",
   547            "locationName":"x-amzn-transcribe-content-identification-type"
   548          },
   549          "ContentRedactionType":{
   550            "shape":"ContentRedactionType",
   551            "location":"header",
   552            "locationName":"x-amzn-transcribe-content-redaction-type"
   553          },
   554          "PiiEntityTypes":{
   555            "shape":"PiiEntityTypes",
   556            "location":"header",
   557            "locationName":"x-amzn-transcribe-pii-entity-types"
   558          }
   559        },
   560        "payload":"AudioStream"
   561      },
   562      "StartStreamTranscriptionResponse":{
   563        "type":"structure",
   564        "members":{
   565          "RequestId":{
   566            "shape":"RequestId",
   567            "location":"header",
   568            "locationName":"x-amzn-request-id"
   569          },
   570          "LanguageCode":{
   571            "shape":"LanguageCode",
   572            "location":"header",
   573            "locationName":"x-amzn-transcribe-language-code"
   574          },
   575          "MediaSampleRateHertz":{
   576            "shape":"MediaSampleRateHertz",
   577            "location":"header",
   578            "locationName":"x-amzn-transcribe-sample-rate"
   579          },
   580          "MediaEncoding":{
   581            "shape":"MediaEncoding",
   582            "location":"header",
   583            "locationName":"x-amzn-transcribe-media-encoding"
   584          },
   585          "VocabularyName":{
   586            "shape":"VocabularyName",
   587            "location":"header",
   588            "locationName":"x-amzn-transcribe-vocabulary-name"
   589          },
   590          "SessionId":{
   591            "shape":"SessionId",
   592            "location":"header",
   593            "locationName":"x-amzn-transcribe-session-id"
   594          },
   595          "TranscriptResultStream":{"shape":"TranscriptResultStream"},
   596          "VocabularyFilterName":{
   597            "shape":"VocabularyFilterName",
   598            "location":"header",
   599            "locationName":"x-amzn-transcribe-vocabulary-filter-name"
   600          },
   601          "VocabularyFilterMethod":{
   602            "shape":"VocabularyFilterMethod",
   603            "location":"header",
   604            "locationName":"x-amzn-transcribe-vocabulary-filter-method"
   605          },
   606          "ShowSpeakerLabel":{
   607            "shape":"Boolean",
   608            "location":"header",
   609            "locationName":"x-amzn-transcribe-show-speaker-label"
   610          },
   611          "EnableChannelIdentification":{
   612            "shape":"Boolean",
   613            "location":"header",
   614            "locationName":"x-amzn-transcribe-enable-channel-identification"
   615          },
   616          "NumberOfChannels":{
   617            "shape":"NumberOfChannels",
   618            "location":"header",
   619            "locationName":"x-amzn-transcribe-number-of-channels"
   620          },
   621          "EnablePartialResultsStabilization":{
   622            "shape":"Boolean",
   623            "location":"header",
   624            "locationName":"x-amzn-transcribe-enable-partial-results-stabilization"
   625          },
   626          "PartialResultsStability":{
   627            "shape":"PartialResultsStability",
   628            "location":"header",
   629            "locationName":"x-amzn-transcribe-partial-results-stability"
   630          },
   631          "ContentIdentificationType":{
   632            "shape":"ContentIdentificationType",
   633            "location":"header",
   634            "locationName":"x-amzn-transcribe-content-identification-type"
   635          },
   636          "ContentRedactionType":{
   637            "shape":"ContentRedactionType",
   638            "location":"header",
   639            "locationName":"x-amzn-transcribe-content-redaction-type"
   640          },
   641          "PiiEntityTypes":{
   642            "shape":"PiiEntityTypes",
   643            "location":"header",
   644            "locationName":"x-amzn-transcribe-pii-entity-types"
   645          }
   646        },
   647        "payload":"TranscriptResultStream"
   648      },
   649      "String":{"type":"string"},
   650      "Transcript":{
   651        "type":"structure",
   652        "members":{
   653          "Results":{"shape":"ResultList"}
   654        }
   655      },
   656      "TranscriptEvent":{
   657        "type":"structure",
   658        "members":{
   659          "Transcript":{"shape":"Transcript"}
   660        },
   661        "event":true
   662      },
   663      "TranscriptResultStream":{
   664        "type":"structure",
   665        "members":{
   666          "TranscriptEvent":{"shape":"TranscriptEvent"},
   667          "BadRequestException":{"shape":"BadRequestException"},
   668          "LimitExceededException":{"shape":"LimitExceededException"},
   669          "InternalFailureException":{"shape":"InternalFailureException"},
   670          "ConflictException":{"shape":"ConflictException"},
   671          "ServiceUnavailableException":{"shape":"ServiceUnavailableException"}
   672        },
   673        "eventstream":true
   674      },
   675      "Type":{
   676        "type":"string",
   677        "enum":[
   678          "CONVERSATION",
   679          "DICTATION"
   680        ]
   681      },
   682      "VocabularyFilterMethod":{
   683        "type":"string",
   684        "enum":[
   685          "remove",
   686          "mask",
   687          "tag"
   688        ]
   689      },
   690      "VocabularyFilterName":{
   691        "type":"string",
   692        "max":200,
   693        "min":1,
   694        "pattern":"^[0-9a-zA-Z._-]+"
   695      },
   696      "VocabularyName":{
   697        "type":"string",
   698        "max":200,
   699        "min":1,
   700        "pattern":"^[0-9a-zA-Z._-]+"
   701      }
   702    }
   703  }