# Service enfonica.voice.v1beta1.Transcriptions

## Methods

| DeleteTranscription |
| -- |
| <span class="e-code">rpc DeleteTranscription(<span class="e-code">[DeleteTranscriptionRequest](#deletetranscriptionrequest)</span>) returns (<span class="e-code"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty" target="_blank">google.protobuf.Empty</a></span>)</span><br/><br/>Deletes a transcription.<br/><br/>The caller must have `voice.transcriptions.delete` permission on the project. |

| GetTranscription |
| -- |
| <span class="e-code">rpc GetTranscription(<span class="e-code">[GetTranscriptionRequest](#gettranscriptionrequest)</span>) returns (<span class="e-code">[Transcription](#resource-transcription)</span>)</span><br/><br/>Retrieves a Transcription identified by the supplied resource name.<br/><br/>The caller must have `voice.transcriptions.get` permission on the project. |

| ListTranscriptions |
| -- |
| <span class="e-code">rpc ListTranscriptions(<span class="e-code">[ListTranscriptionsRequest](#listtranscriptionsrequest)</span>) returns (<span class="e-code">[ListTranscriptionsResponse](#listtranscriptionsresponse)</span>)</span><br/><br/>Lists the Transcriptions of the specified project. List returns Transcriptions sorted by create_time descending.<br/><br/>The caller must have `voice.transcriptions.list` permission on the project. |

## Resource: Transcription

The Transcription resource.

Fields | &nbsp;
--|--
<span class="e-code">name</span> | <span class="e-code">string</span><br/>Resource name of the transcription. It must match the pattern `projects/*/calls/*/transcriptions/*`. The call will always refer to the parent leg of a two-leg call.
<span class="e-code">recording</span> | <span class="e-code">string</span><br/>The recording that this transcription was created from, of the form `projects/*/calls/*/recordings/*`.
<span class="e-code">state</span> | <span class="e-code">[State](#transcriptionstate)</span><br/>Output only. The state of the transcription.
<span class="e-code">duration</span> | <span class="e-code"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration" target="_blank">google.protobuf.Duration</a></span><br/>Output only. The duration of the audio (of one channel). The total duration that is billable is `duration * channel_count`.
<span class="e-code">channel_count</span> | <span class="e-code">int32</span><br/>Output only. The number of channels included in the transcription.
<span class="e-code">create_time</span> | <span class="e-code"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp" target="_blank">google.protobuf.Timestamp</a></span><br/>Output only. The creation time of the transcription. This is the time that the transcription resource was created.
<span class="e-code">update_time</span> | <span class="e-code"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp" target="_blank">google.protobuf.Timestamp</a></span><br/>Output only. The last time this resource was modified. If state is COMPLETED or FAILED, this will be the time that the resource transitioned into that state.
<span class="e-code">ready_uri</span> | <span class="e-code">string</span><br/>The URI to send the transcription ready webhook to when the state transitions to a terminal state (SUCCEEDED, FAILED). Must be an absolute URI.
<span class="e-code">utterances[]</span> | <span class="e-code">[Utterance](#utterance)</span><br/>Output only. The spoken utterances, ordered by when they were spoken in the recording.

## Transcription.State

The state of the transcription.

Enums | &nbsp;
--|--
<span class="e-code">STATE_UNSPECIFIED</span> | Unspecified state.
<span class="e-code">PENDING</span> | The audio has not yet been transcribed.
<span class="e-code">COMPLETED</span> | The audio has been transcribed.
<span class="e-code">FAILED</span> | The transcription failed.

## Utterance

An utterance that was spoken.

Fields | &nbsp;
--|--
<span class="e-code">channel</span> | <span class="e-code">int32</span><br/>Which channel this utterance was spoken on. For dual channel recordings, 0 is the parent call and 1 is the child call.
<span class="e-code">offset</span> | <span class="e-code"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration" target="_blank">google.protobuf.Duration</a></span><br/>The offset from the start of the recording that this utterance was spoken.
<span class="e-code">duration</span> | <span class="e-code"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration" target="_blank">google.protobuf.Duration</a></span><br/>The duration of this utterance.
<span class="e-code">text</span> | <span class="e-code">string</span><br/>What was spoken. This includes punctuation.

## GetTranscriptionRequest

The GetTranscription request transcription.

Fields | &nbsp;
--|--
<span class="e-code">name</span> | <span class="e-code">string</span><br/>Required. The resource name of the Transcription to retrieve. Must be of the form `projects/*/calls/*/transcriptions/*`.
<span class="e-code">view</span> | <span class="e-code">[TranscriptionView](#transcriptionview)</span><br/>Configuration of partial responses. Defaults to FULL.

## TranscriptionView

Configuration of partial responses for the Transcription resource.

Enums | &nbsp;
--|--
<span class="e-code">TRANSCRIPTION_VIEW_UNSPECIFIED</span> | The default / unset value. The API will default to BASIC for ListTranscriptions and FULL for GetTranscription.
<span class="e-code">TRANSCRIPTION_VIEW_BASIC</span> | Includes all fields except [utterances][enfonica.voice.v1beta1.Transcription.utterances]. This is the default for ListTranscriptions.
<span class="e-code">TRANSCRIPTION_VIEW_FULL</span> | Includes all fields. This is the default for GetTranscription.

## ListTranscriptionsRequest

The ListTranscriptions request transcription.

Fields | &nbsp;
--|--
<span class="e-code">parent</span> | <span class="e-code">string</span><br/>Required. The resource name of the parent of which to list transcriptions. May be of the form `projects/*/calls/*` to list the transcriptions of that specific call, or `projects/*` to list transcriptions across the entire project, which maps to `projects/*/calls/-`.
<span class="e-code">page_size</span> | <span class="e-code">int32</span><br/>The maximum number of Transcriptions to return in the response. Default value of 10 and maximum value of 100.
<span class="e-code">page_token</span> | <span class="e-code">string</span><br/>A pagination token returned from a previous transcription to `ListTranscriptions` that indicates where this listing should continue from.
<span class="e-code">view</span> | <span class="e-code">[TranscriptionView](#transcriptionview)</span><br/>Configuration of partial responses. Defaults to BASIC.

## ListTranscriptionsResponse

The ListTranscriptions response transcription.

Fields | &nbsp;
--|--
<span class="e-code">transcriptions[]</span> | <span class="e-code">[Transcription](#resource-transcription)</span><br/>A possibly paginated list of Transcriptions that are direct descendants of the specified parent resource.
<span class="e-code">next_page_token</span> | <span class="e-code">string</span><br/>A pagination token returned from a previous transcription to `ListTranscriptions` that indicates from where listing should continue.

## DeleteTranscriptionRequest

The DeleteTranscription request message.

Fields | &nbsp;
--|--
<span class="e-code">name</span> | <span class="e-code">string</span><br/>Required. The resource name of the Transcription to be deleted. Must be of the form `projects/*/calls/*/transcriptions/*`.

