Skip to content

feat: [google-cloud-speech] add API for writing BatchRecognize transcripts in SRT and VTT formats #12344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ohmayr merged 3 commits into from
Feb 21, 2024
Merged

feat: [google-cloud-speech] add API for writing BatchRecognize transcripts in SRT and VTT formats #12344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5915e2f
feat: add API for writing BatchRecognize transcripts in SRT and VTT f…
gcf-owl-bot[bot] Feb 21, 2024
baffe91
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 21, 2024
4b92b55
Merge branch 'main' into owl-bot-copy-packages-google-cloud-speech
ohmayr Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/google-cloud-speech/google/cloud/speech_v2/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@
ListPhraseSetsResponse,
ListRecognizersRequest,
ListRecognizersResponse,
NativeOutputFileFormatConfig,
OperationMetadata,
OutputFormatConfig,
PhraseSet,
RecognitionConfig,
RecognitionFeatures,
Expand All @@ -64,6 +66,7 @@
SpeechAdaptation,
SpeechRecognitionAlternative,
SpeechRecognitionResult,
SrtOutputFileFormatConfig,
StreamingRecognitionConfig,
StreamingRecognitionFeatures,
StreamingRecognitionResult,
Expand All @@ -77,6 +80,7 @@
UpdateCustomClassRequest,
UpdatePhraseSetRequest,
UpdateRecognizerRequest,
VttOutputFileFormatConfig,
WordInfo,
)

Expand Down Expand Up @@ -113,7 +117,9 @@
"ListPhraseSetsResponse",
"ListRecognizersRequest",
"ListRecognizersResponse",
"NativeOutputFileFormatConfig",
"OperationMetadata",
"OutputFormatConfig",
"PhraseSet",
"RecognitionConfig",
"RecognitionFeatures",
Expand All @@ -127,6 +133,7 @@
"SpeechClient",
"SpeechRecognitionAlternative",
"SpeechRecognitionResult",
"SrtOutputFileFormatConfig",
"StreamingRecognitionConfig",
"StreamingRecognitionFeatures",
"StreamingRecognitionResult",
Expand All @@ -140,5 +147,6 @@
"UpdateCustomClassRequest",
"UpdatePhraseSetRequest",
"UpdateRecognizerRequest",
"VttOutputFileFormatConfig",
"WordInfo",
)
8 changes: 8 additions & 0 deletions packages/google-cloud-speech/google/cloud/speech_v2/types/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@
ListPhraseSetsResponse,
ListRecognizersRequest,
ListRecognizersResponse,
NativeOutputFileFormatConfig,
OperationMetadata,
OutputFormatConfig,
PhraseSet,
RecognitionConfig,
RecognitionFeatures,
Expand All @@ -58,6 +60,7 @@
SpeechAdaptation,
SpeechRecognitionAlternative,
SpeechRecognitionResult,
SrtOutputFileFormatConfig,
StreamingRecognitionConfig,
StreamingRecognitionFeatures,
StreamingRecognitionResult,
Expand All @@ -71,6 +74,7 @@
UpdateCustomClassRequest,
UpdatePhraseSetRequest,
UpdateRecognizerRequest,
VttOutputFileFormatConfig,
WordInfo,
)

Expand Down Expand Up @@ -106,7 +110,9 @@
"ListPhraseSetsResponse",
"ListRecognizersRequest",
"ListRecognizersResponse",
"NativeOutputFileFormatConfig",
"OperationMetadata",
"OutputFormatConfig",
"PhraseSet",
"RecognitionConfig",
"RecognitionFeatures",
Expand All @@ -119,6 +125,7 @@
"SpeechAdaptation",
"SpeechRecognitionAlternative",
"SpeechRecognitionResult",
"SrtOutputFileFormatConfig",
"StreamingRecognitionConfig",
"StreamingRecognitionFeatures",
"StreamingRecognitionResult",
Expand All @@ -132,5 +139,6 @@
"UpdateCustomClassRequest",
"UpdatePhraseSetRequest",
"UpdateRecognizerRequest",
"VttOutputFileFormatConfig",
"WordInfo",
)
127 changes: 116 additions & 11 deletions packages/google-cloud-speech/google/cloud/speech_v2/types/cloud_speech.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@
"BatchRecognizeRequest",
"GcsOutputConfig",
"InlineOutputConfig",
"NativeOutputFileFormatConfig",
"VttOutputFileFormatConfig",
"SrtOutputFileFormatConfig",
"OutputFormatConfig",
"RecognitionOutputConfig",
"BatchRecognizeResponse",
"BatchRecognizeResults",
Expand Down Expand Up @@ -581,7 +585,8 @@ class Recognizer(proto.Message):

Attributes:
name (str):
Output only. The resource name of the Recognizer. Format:
Output only. Identifier. The resource name of the
Recognizer. Format:
``projects/{project}/locations/{location}/recognizers/{recognizer}``.
uid (str):
Output only. System-assigned unique
Expand Down Expand Up @@ -1801,6 +1806,64 @@ class InlineOutputConfig(proto.Message):
r"""Output configurations for inline response."""


class NativeOutputFileFormatConfig(proto.Message):
r"""Output configurations for serialized ``BatchRecognizeResults``
protos.

"""


class VttOutputFileFormatConfig(proto.Message):
r"""Output configurations for
`WebVTT <https://www.w3.org/TR/webvtt1/>`__ formatted subtitle file.

"""


class SrtOutputFileFormatConfig(proto.Message):
r"""Output configurations `SubRip
Text <https://www.matroska.org/technical/subtitles.html#srt-subtitles>`__
formatted subtitle file.

"""


class OutputFormatConfig(proto.Message):
r"""Configuration for the format of the results stored to ``output``.

Attributes:
native (google.cloud.speech_v2.types.NativeOutputFileFormatConfig):
Configuration for the native output format.
If this field is set or if no other output
format field is set then transcripts will be
written to the sink in the native format.
vtt (google.cloud.speech_v2.types.VttOutputFileFormatConfig):
Configuration for the vtt output format. If
this field is set then transcripts will be
written to the sink in the vtt format.
srt (google.cloud.speech_v2.types.SrtOutputFileFormatConfig):
Configuration for the srt output format. If
this field is set then transcripts will be
written to the sink in the srt format.
"""

native: "NativeOutputFileFormatConfig" = proto.Field(
proto.MESSAGE,
number=1,
message="NativeOutputFileFormatConfig",
)
vtt: "VttOutputFileFormatConfig" = proto.Field(
proto.MESSAGE,
number=2,
message="VttOutputFileFormatConfig",
)
srt: "SrtOutputFileFormatConfig" = proto.Field(
proto.MESSAGE,
number=3,
message="SrtOutputFileFormatConfig",
)


class RecognitionOutputConfig(proto.Message):
r"""Configuration options for the output(s) of recognition.

Expand Down Expand Up @@ -1828,6 +1891,10 @@ class RecognitionOutputConfig(proto.Message):
with just one audio file.

This field is a member of `oneof`_ ``output``.
output_format_config (google.cloud.speech_v2.types.OutputFormatConfig):
Optional. Configuration for the format of the results stored
to ``output``. If unspecified transcripts will be written in
the ``NATIVE`` format only.
"""

gcs_output_config: "GcsOutputConfig" = proto.Field(
Expand All @@ -1842,6 +1909,11 @@ class RecognitionOutputConfig(proto.Message):
oneof="output",
message="InlineOutputConfig",
)
output_format_config: "OutputFormatConfig" = proto.Field(
proto.MESSAGE,
number=3,
message="OutputFormatConfig",
)


class BatchRecognizeResponse(proto.Message):
Expand Down Expand Up @@ -1905,12 +1977,28 @@ class CloudStorageResult(proto.Message):
uri (str):
The Cloud Storage URI to which recognition
results were written.
vtt_format_uri (str):
The Cloud Storage URI to which recognition results were
written as VTT formatted captions. This is populated only
when ``VTT`` output is requested.
srt_format_uri (str):
The Cloud Storage URI to which recognition results were
written as SRT formatted captions. This is populated only
when ``SRT`` output is requested.
"""

uri: str = proto.Field(
proto.STRING,
number=1,
)
vtt_format_uri: str = proto.Field(
proto.STRING,
number=2,
)
srt_format_uri: str = proto.Field(
proto.STRING,
number=3,
)


class InlineResult(proto.Message):
Expand All @@ -1919,13 +2007,27 @@ class InlineResult(proto.Message):
Attributes:
transcript (google.cloud.speech_v2.types.BatchRecognizeResults):
The transcript for the audio file.
vtt_captions (str):
The transcript for the audio file as VTT formatted captions.
This is populated only when ``VTT`` output is requested.
srt_captions (str):
The transcript for the audio file as SRT formatted captions.
This is populated only when ``SRT`` output is requested.
"""

transcript: "BatchRecognizeResults" = proto.Field(
proto.MESSAGE,
number=1,
message="BatchRecognizeResults",
)
vtt_captions: str = proto.Field(
proto.STRING,
number=2,
)
srt_captions: str = proto.Field(
proto.STRING,
number=3,
)


class BatchRecognizeFileResult(proto.Message):
Expand Down Expand Up @@ -2308,9 +2410,9 @@ class Config(proto.Message):

Attributes:
name (str):
Output only. The name of the config resource. There is
exactly one config resource per project per location. The
expected format is
Output only. Identifier. The name of the config resource.
There is exactly one config resource per project per
location. The expected format is
``projects/{project}/locations/{location}/config``.
kms_key_name (str):
Optional. An optional `KMS key
Expand Down Expand Up @@ -2393,14 +2495,16 @@ class CustomClass(proto.Message):

Attributes:
name (str):
Output only. The resource name of the CustomClass. Format:
Output only. Identifier. The resource name of the
CustomClass. Format:
``projects/{project}/locations/{location}/customClasses/{custom_class}``.
uid (str):
Output only. System-assigned unique
identifier for the CustomClass.
display_name (str):
User-settable, human-readable name for the
CustomClass. Must be 63 characters or less.
Optional. User-settable, human-readable name
for the CustomClass. Must be 63 characters or
less.
items (MutableSequence[google.cloud.speech_v2.types.CustomClass.ClassItem]):
A collection of class items.
state (google.cloud.speech_v2.types.CustomClass.State):
Expand All @@ -2417,9 +2521,9 @@ class CustomClass(proto.Message):
Output only. The time at which this resource
will be purged.
annotations (MutableMapping[str, str]):
Allows users to store small amounts of
arbitrary data. Both the key and the value must
be 63 characters or less each. At most 100
Optional. Allows users to store small amounts
of arbitrary data. Both the key and the value
must be 63 characters or less each. At most 100
annotations.
etag (str):
Output only. This checksum is computed by the
Expand Down Expand Up @@ -2545,7 +2649,8 @@ class PhraseSet(proto.Message):

Attributes:
name (str):
Output only. The resource name of the PhraseSet. Format:
Output only. Identifier. The resource name of the PhraseSet.
Format:
``projects/{project}/locations/{location}/phraseSets/{phrase_set}``.
uid (str):
Output only. System-assigned unique
Expand Down