-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.ai.openai.models.AudioTranslation.yml
112 lines (112 loc) · 8.07 KB
/
com.azure.ai.openai.models.AudioTranslation.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
### YamlMime:JavaType
uid: "com.azure.ai.openai.models.AudioTranslation"
fullName: "com.azure.ai.openai.models.AudioTranslation"
name: "AudioTranslation"
nameWithType: "AudioTranslation"
summary: "Result information for an operation that translated spoken audio into written text."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **AudioTranslation**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.openai.models.AudioTranslation?alt=com.azure.ai.openai.models.AudioTranslation&text=AudioTranslation\" data-throw-if-not-resolved=\"False\" />>"
methods:
- uid: "com.azure.ai.openai.models.AudioTranslation.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.ai.openai.models.AudioTranslation.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "AudioTranslation.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Audio<wbr>Translation from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static AudioTranslation fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of AudioTranslation from the JsonReader."
returns:
description: "An instance of AudioTranslation if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.ai.openai.models.AudioTranslation?alt=com.azure.ai.openai.models.AudioTranslation&text=AudioTranslation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.AudioTranslation.getDuration()"
fullName: "com.azure.ai.openai.models.AudioTranslation.getDuration()"
name: "getDuration()"
nameWithType: "AudioTranslation.getDuration()"
summary: "Get the duration property: The total duration of the audio processed to produce accompanying translation information."
syntax: "public Duration getDuration()"
desc: "Get the duration property: The total duration of the audio processed to produce accompanying translation information."
returns:
description: "the duration value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.ai.openai.models.AudioTranslation.getLanguage()"
fullName: "com.azure.ai.openai.models.AudioTranslation.getLanguage()"
name: "getLanguage()"
nameWithType: "AudioTranslation.getLanguage()"
summary: "Get the language property: The spoken language that was detected in the translated audio data."
syntax: "public String getLanguage()"
desc: "Get the language property: The spoken language that was detected in the translated audio data. This is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'."
returns:
description: "the language value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.openai.models.AudioTranslation.getSegments()"
fullName: "com.azure.ai.openai.models.AudioTranslation.getSegments()"
name: "getSegments()"
nameWithType: "AudioTranslation.getSegments()"
summary: "Get the segments property: A collection of information about the timing, probabilities, and other detail of each processed audio segment."
syntax: "public List<AudioTranslationSegment> getSegments()"
desc: "Get the segments property: A collection of information about the timing, probabilities, and other detail of each processed audio segment."
returns:
description: "the segments value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.openai.models.AudioTranslationSegment?alt=com.azure.ai.openai.models.AudioTranslationSegment&text=AudioTranslationSegment\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.ai.openai.models.AudioTranslation.getTask()"
fullName: "com.azure.ai.openai.models.AudioTranslation.getTask()"
name: "getTask()"
nameWithType: "AudioTranslation.getTask()"
summary: "Get the task property: The label that describes which operation type generated the accompanying response data."
syntax: "public AudioTaskLabel getTask()"
desc: "Get the task property: The label that describes which operation type generated the accompanying response data."
returns:
description: "the task value."
type: "<xref href=\"com.azure.ai.openai.models.AudioTaskLabel?alt=com.azure.ai.openai.models.AudioTaskLabel&text=AudioTaskLabel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.AudioTranslation.getText()"
fullName: "com.azure.ai.openai.models.AudioTranslation.getText()"
name: "getText()"
nameWithType: "AudioTranslation.getText()"
summary: "Get the text property: The translated text for the provided audio data."
syntax: "public String getText()"
desc: "Get the text property: The translated text for the provided audio data."
returns:
description: "the text value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.openai.models.AudioTranslation.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.ai.openai.models.AudioTranslation.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "AudioTranslation.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Result information for an operation that translated spoken audio into written text."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.openai.models.AudioTranslation?alt=com.azure.ai.openai.models.AudioTranslation&text=AudioTranslation\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.ai.openai.models"
artifact: com.azure:azure-ai-openai:1.0.0-beta.10