Skip to content

Commit 0099de6

Browse files
committed
feat: extend descs for speech-to-text resposne
1 parent ada93f2 commit 0099de6

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

packages/openapi/descriptions/speech-to-text.response.js

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,64 @@ export default {
3838
status: {
3939
desc: `The current status of the generation task.`,
4040
},
41+
channels: {
42+
desc: `The top-level results object containing per-channel transcription alternatives.`,
43+
},
44+
alternatives: {
45+
desc: `List of possible transcription hypotheses (“alternatives”) for each channel.`,
46+
},
47+
transcript: {
48+
desc: `The full transcript text for this alternative.`,
49+
},
50+
confidence: {
51+
desc: `Overall confidence score (0-1) that assigns to this transcript alternative.`,
52+
},
53+
words: {
54+
desc: `List of word-level timing, confidence, and punctuation details.`,
55+
word: {
56+
desc: `The raw recognized word, without punctuation or capitalization.`,
57+
},
58+
start: {
59+
desc: `Start timestamp of the word (in seconds, from beginning of audio).`,
60+
},
61+
end: {
62+
desc: `End timestamp of the word (in seconds).`,
63+
},
64+
confidence: {
65+
desc: `Confidence score (0-1) for this individual word.`,
66+
},
67+
punctuated_word: {
68+
desc: `The same word but with punctuation/capitalization applied (if smart_format is enabled).`,
69+
},
70+
},
71+
paragraphs: {
72+
desc: `An array of paragraph objects, present when the paragraphs feature is enabled.`,
73+
transcript: {
74+
desc: `The transcript split into paragraphs (with line breaks), when paragraphing is enabled.`,
75+
},
76+
paragraphs: {
77+
desc: `Structure describing each paragraph: its timespan, word count, and sentence breakdown.`,
78+
sentences: {
79+
desc: `List of sentences in this paragraph, with start/end times.`,
80+
text: {
81+
desc: `Text of a single sentence in the paragraph.`,
82+
},
83+
start: {
84+
desc: `Start time of the sentence (in seconds).`,
85+
},
86+
end: {
87+
desc: `End time of the sentence (in seconds).`,
88+
},
89+
},
90+
num_words: {
91+
desc: `Number of words in this paragraph.`,
92+
},
93+
start: {
94+
desc: `Start time of the paragraph (in seconds).`,
95+
},
96+
end: {
97+
desc: `End time of the paragraph (in seconds).`,
98+
},
99+
},
100+
},
41101
};

0 commit comments

Comments
 (0)