Skip to content

Commit c806736

Browse files
authoredNov 16, 2023
Merge pull request #25 from AssemblyAI/fern-bot/11-16-2023-0526PM
🌿 Fern Regeneration -- November 16, 2023
2 parents e7496fd + efd64c8 commit c806736

33 files changed

+475
-367
lines changed
 

‎build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ publishing {
4747
maven(MavenPublication) {
4848
groupId = 'com.assemblyai'
4949
artifactId = 'assemblyai-java'
50-
version = '0.0.5-beta4'
50+
version = '0.0.5-beta5'
5151
from components.java
5252
}
5353
}

‎src/main/java/com/assemblyai/api/core/ClientOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ private ClientOptions(
2929
"X-Fern-SDK-Name",
3030
"com.assemblyai.fern:api-sdk",
3131
"X-Fern-SDK-Version",
32-
"0.0.5-beta4",
32+
"0.0.5-beta5",
3333
"X-Fern-Language",
3434
"JAVA"));
3535
this.headerSuppliers = headerSuppliers;

‎src/main/java/com/assemblyai/api/resources/files/FilesClient.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public FilesClient(ClientOptions clientOptions) {
2323
}
2424

2525
/**
26-
* Upload your audio or video file directly to the AssemblyAI API if it isn't accessible via a URL already.
26+
* Upload your media file directly to the AssemblyAI API if it isn't accessible via a URL already.
2727
*/
2828
public UploadedFile upload(byte[] request, RequestOptions requestOptions) {
2929
HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
@@ -52,7 +52,7 @@ public UploadedFile upload(byte[] request, RequestOptions requestOptions) {
5252
}
5353

5454
/**
55-
* Upload your audio or video file directly to the AssemblyAI API if it isn't accessible via a URL already.
55+
* Upload your media file directly to the AssemblyAI API if it isn't accessible via a URL already.
5656
*/
5757
public UploadedFile upload(byte[] request) {
5858
return upload(request, null);

‎src/main/java/com/assemblyai/api/resources/lemur/LemurClient.java

+16-2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ public LemurClient(ClientOptions clientOptions) {
3131
this.clientOptions = clientOptions;
3232
}
3333

34+
/**
35+
* Custom Summary allows you to distill a piece of audio into a few impactful sentences. You can give the model context to obtain more targeted results while outputting the results in a variety of formats described in human language.
36+
*/
37+
public LemurSummaryResponse summary() {
38+
return summary(LemurSummaryParameters.builder().build());
39+
}
40+
3441
/**
3542
* Custom Summary allows you to distill a piece of audio into a few impactful sentences. You can give the model context to obtain more targeted results while outputting the results in a variety of formats described in human language.
3643
*/
@@ -116,6 +123,13 @@ public LemurQuestionAnswerResponse questionAnswer(LemurQuestionAnswerParameters
116123
return questionAnswer(request, null);
117124
}
118125

126+
/**
127+
* Use LeMUR to generate a list of Action Items from a transcript
128+
*/
129+
public LemurActionItemsResponse actionItems() {
130+
return actionItems(LemurBaseParameters.builder().build());
131+
}
132+
119133
/**
120134
* Use LeMUR to generate a list of Action Items from a transcript
121135
*/
@@ -159,7 +173,7 @@ public LemurActionItemsResponse actionItems(LemurBaseParameters request) {
159173
}
160174

161175
/**
162-
* Use LeMUR to ask anything with Custom Task
176+
* Use your own prompt to run a Custom Task to handle your specialized task.
163177
*/
164178
public LemurTaskResponse task(LemurTaskParameters request, RequestOptions requestOptions) {
165179
HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
@@ -194,7 +208,7 @@ public LemurTaskResponse task(LemurTaskParameters request, RequestOptions reques
194208
}
195209

196210
/**
197-
* Use LeMUR to ask anything with Custom Task
211+
* Use your own prompt to run a Custom Task to handle your specialized task.
198212
*/
199213
public LemurTaskResponse task(LemurTaskParameters request) {
200214
return task(request, null);

‎src/main/java/com/assemblyai/api/resources/lemur/requests/LemurQuestionAnswerParameters.java

+46-14
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@
2626
@JsonInclude(JsonInclude.Include.NON_EMPTY)
2727
@JsonDeserialize(builder = LemurQuestionAnswerParameters.Builder.class)
2828
public final class LemurQuestionAnswerParameters implements ILemurBaseParameters {
29-
private final List<String> transcriptIds;
29+
private final Optional<List<String>> transcriptIds;
30+
31+
private final Optional<String> inputText;
3032

3133
private final Optional<LemurBaseParametersContext> context;
3234

@@ -41,14 +43,16 @@ public final class LemurQuestionAnswerParameters implements ILemurBaseParameters
4143
private final Map<String, Object> additionalProperties;
4244

4345
private LemurQuestionAnswerParameters(
44-
List<String> transcriptIds,
46+
Optional<List<String>> transcriptIds,
47+
Optional<String> inputText,
4548
Optional<LemurBaseParametersContext> context,
4649
Optional<LemurModel> finalModel,
4750
Optional<Integer> maxOutputSize,
4851
Optional<Double> temperature,
4952
List<LemurQuestion> questions,
5053
Map<String, Object> additionalProperties) {
5154
this.transcriptIds = transcriptIds;
55+
this.inputText = inputText;
5256
this.context = context;
5357
this.finalModel = finalModel;
5458
this.maxOutputSize = maxOutputSize;
@@ -58,14 +62,25 @@ private LemurQuestionAnswerParameters(
5862
}
5963

6064
/**
61-
* @return A list of completed transcripts with text. Up to 100 files max, or 100 hours max. Whichever is lower.
65+
* @return A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.
66+
* Use either transcript_ids or input_text as input into LeMUR.
6267
*/
6368
@JsonProperty("transcript_ids")
6469
@Override
65-
public List<String> getTranscriptIds() {
70+
public Optional<List<String>> getTranscriptIds() {
6671
return transcriptIds;
6772
}
6873

74+
/**
75+
* @return Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.
76+
* Use either transcript_ids or input_text as input into LeMUR.
77+
*/
78+
@JsonProperty("input_text")
79+
@Override
80+
public Optional<String> getInputText() {
81+
return inputText;
82+
}
83+
6984
/**
7085
* @return Context to provide the model. This can be a string or a free-form JSON value.
7186
*/
@@ -82,7 +97,7 @@ public Optional<LemurModel> getFinalModel() {
8297
}
8398

8499
/**
85-
* @return Max output size in tokens. Up to 4000 allowed.
100+
* @return Max output size in tokens, up to 4000
86101
*/
87102
@JsonProperty("max_output_size")
88103
@Override
@@ -102,7 +117,7 @@ public Optional<Double> getTemperature() {
102117
}
103118

104119
/**
105-
* @return A list of questions to ask.
120+
* @return A list of questions to ask
106121
*/
107122
@JsonProperty("questions")
108123
public List<LemurQuestion> getQuestions() {
@@ -122,6 +137,7 @@ public Map<String, Object> getAdditionalProperties() {
122137

123138
private boolean equalTo(LemurQuestionAnswerParameters other) {
124139
return transcriptIds.equals(other.transcriptIds)
140+
&& inputText.equals(other.inputText)
125141
&& context.equals(other.context)
126142
&& finalModel.equals(other.finalModel)
127143
&& maxOutputSize.equals(other.maxOutputSize)
@@ -133,6 +149,7 @@ private boolean equalTo(LemurQuestionAnswerParameters other) {
133149
public int hashCode() {
134150
return Objects.hash(
135151
this.transcriptIds,
152+
this.inputText,
136153
this.context,
137154
this.finalModel,
138155
this.maxOutputSize,
@@ -151,7 +168,9 @@ public static Builder builder() {
151168

152169
@JsonIgnoreProperties(ignoreUnknown = true)
153170
public static final class Builder {
154-
private List<String> transcriptIds = new ArrayList<>();
171+
private Optional<List<String>> transcriptIds = Optional.empty();
172+
173+
private Optional<String> inputText = Optional.empty();
155174

156175
private Optional<LemurBaseParametersContext> context = Optional.empty();
157176

@@ -170,6 +189,7 @@ private Builder() {}
170189

171190
public Builder from(LemurQuestionAnswerParameters other) {
172191
transcriptIds(other.getTranscriptIds());
192+
inputText(other.getInputText());
173193
context(other.getContext());
174194
finalModel(other.getFinalModel());
175195
maxOutputSize(other.getMaxOutputSize());
@@ -179,19 +199,24 @@ public Builder from(LemurQuestionAnswerParameters other) {
179199
}
180200

181201
@JsonSetter(value = "transcript_ids", nulls = Nulls.SKIP)
202+
public Builder transcriptIds(Optional<List<String>> transcriptIds) {
203+
this.transcriptIds = transcriptIds;
204+
return this;
205+
}
206+
182207
public Builder transcriptIds(List<String> transcriptIds) {
183-
this.transcriptIds.clear();
184-
this.transcriptIds.addAll(transcriptIds);
208+
this.transcriptIds = Optional.of(transcriptIds);
185209
return this;
186210
}
187211

188-
public Builder addTranscriptIds(String transcriptIds) {
189-
this.transcriptIds.add(transcriptIds);
212+
@JsonSetter(value = "input_text", nulls = Nulls.SKIP)
213+
public Builder inputText(Optional<String> inputText) {
214+
this.inputText = inputText;
190215
return this;
191216
}
192217

193-
public Builder addAllTranscriptIds(List<String> transcriptIds) {
194-
this.transcriptIds.addAll(transcriptIds);
218+
public Builder inputText(String inputText) {
219+
this.inputText = Optional.of(inputText);
195220
return this;
196221
}
197222

@@ -258,7 +283,14 @@ public Builder addAllQuestions(List<LemurQuestion> questions) {
258283

259284
public LemurQuestionAnswerParameters build() {
260285
return new LemurQuestionAnswerParameters(
261-
transcriptIds, context, finalModel, maxOutputSize, temperature, questions, additionalProperties);
286+
transcriptIds,
287+
inputText,
288+
context,
289+
finalModel,
290+
maxOutputSize,
291+
temperature,
292+
questions,
293+
additionalProperties);
262294
}
263295
}
264296
}

‎src/main/java/com/assemblyai/api/resources/lemur/requests/LemurSummaryParameters.java

+45-14
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import com.fasterxml.jackson.annotation.JsonSetter;
1616
import com.fasterxml.jackson.annotation.Nulls;
1717
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
18-
import java.util.ArrayList;
1918
import java.util.HashMap;
2019
import java.util.List;
2120
import java.util.Map;
@@ -25,7 +24,9 @@
2524
@JsonInclude(JsonInclude.Include.NON_EMPTY)
2625
@JsonDeserialize(builder = LemurSummaryParameters.Builder.class)
2726
public final class LemurSummaryParameters implements ILemurBaseParameters {
28-
private final List<String> transcriptIds;
27+
private final Optional<List<String>> transcriptIds;
28+
29+
private final Optional<String> inputText;
2930

3031
private final Optional<LemurBaseParametersContext> context;
3132

@@ -40,14 +41,16 @@ public final class LemurSummaryParameters implements ILemurBaseParameters {
4041
private final Map<String, Object> additionalProperties;
4142

4243
private LemurSummaryParameters(
43-
List<String> transcriptIds,
44+
Optional<List<String>> transcriptIds,
45+
Optional<String> inputText,
4446
Optional<LemurBaseParametersContext> context,
4547
Optional<LemurModel> finalModel,
4648
Optional<Integer> maxOutputSize,
4749
Optional<Double> temperature,
4850
Optional<String> answerFormat,
4951
Map<String, Object> additionalProperties) {
5052
this.transcriptIds = transcriptIds;
53+
this.inputText = inputText;
5154
this.context = context;
5255
this.finalModel = finalModel;
5356
this.maxOutputSize = maxOutputSize;
@@ -57,14 +60,25 @@ private LemurSummaryParameters(
5760
}
5861

5962
/**
60-
* @return A list of completed transcripts with text. Up to 100 files max, or 100 hours max. Whichever is lower.
63+
* @return A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.
64+
* Use either transcript_ids or input_text as input into LeMUR.
6165
*/
6266
@JsonProperty("transcript_ids")
6367
@Override
64-
public List<String> getTranscriptIds() {
68+
public Optional<List<String>> getTranscriptIds() {
6569
return transcriptIds;
6670
}
6771

72+
/**
73+
* @return Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.
74+
* Use either transcript_ids or input_text as input into LeMUR.
75+
*/
76+
@JsonProperty("input_text")
77+
@Override
78+
public Optional<String> getInputText() {
79+
return inputText;
80+
}
81+
6882
/**
6983
* @return Context to provide the model. This can be a string or a free-form JSON value.
7084
*/
@@ -81,7 +95,7 @@ public Optional<LemurModel> getFinalModel() {
8195
}
8296

8397
/**
84-
* @return Max output size in tokens. Up to 4000 allowed.
98+
* @return Max output size in tokens, up to 4000
8599
*/
86100
@JsonProperty("max_output_size")
87101
@Override
@@ -121,6 +135,7 @@ public Map<String, Object> getAdditionalProperties() {
121135

122136
private boolean equalTo(LemurSummaryParameters other) {
123137
return transcriptIds.equals(other.transcriptIds)
138+
&& inputText.equals(other.inputText)
124139
&& context.equals(other.context)
125140
&& finalModel.equals(other.finalModel)
126141
&& maxOutputSize.equals(other.maxOutputSize)
@@ -132,6 +147,7 @@ private boolean equalTo(LemurSummaryParameters other) {
132147
public int hashCode() {
133148
return Objects.hash(
134149
this.transcriptIds,
150+
this.inputText,
135151
this.context,
136152
this.finalModel,
137153
this.maxOutputSize,
@@ -150,7 +166,9 @@ public static Builder builder() {
150166

151167
@JsonIgnoreProperties(ignoreUnknown = true)
152168
public static final class Builder {
153-
private List<String> transcriptIds = new ArrayList<>();
169+
private Optional<List<String>> transcriptIds = Optional.empty();
170+
171+
private Optional<String> inputText = Optional.empty();
154172

155173
private Optional<LemurBaseParametersContext> context = Optional.empty();
156174

@@ -169,6 +187,7 @@ private Builder() {}
169187

170188
public Builder from(LemurSummaryParameters other) {
171189
transcriptIds(other.getTranscriptIds());
190+
inputText(other.getInputText());
172191
context(other.getContext());
173192
finalModel(other.getFinalModel());
174193
maxOutputSize(other.getMaxOutputSize());
@@ -178,19 +197,24 @@ public Builder from(LemurSummaryParameters other) {
178197
}
179198

180199
@JsonSetter(value = "transcript_ids", nulls = Nulls.SKIP)
200+
public Builder transcriptIds(Optional<List<String>> transcriptIds) {
201+
this.transcriptIds = transcriptIds;
202+
return this;
203+
}
204+
181205
public Builder transcriptIds(List<String> transcriptIds) {
182-
this.transcriptIds.clear();
183-
this.transcriptIds.addAll(transcriptIds);
206+
this.transcriptIds = Optional.of(transcriptIds);
184207
return this;
185208
}
186209

187-
public Builder addTranscriptIds(String transcriptIds) {
188-
this.transcriptIds.add(transcriptIds);
210+
@JsonSetter(value = "input_text", nulls = Nulls.SKIP)
211+
public Builder inputText(Optional<String> inputText) {
212+
this.inputText = inputText;
189213
return this;
190214
}
191215

192-
public Builder addAllTranscriptIds(List<String> transcriptIds) {
193-
this.transcriptIds.addAll(transcriptIds);
216+
public Builder inputText(String inputText) {
217+
this.inputText = Optional.of(inputText);
194218
return this;
195219
}
196220

@@ -251,7 +275,14 @@ public Builder answerFormat(String answerFormat) {
251275

252276
public LemurSummaryParameters build() {
253277
return new LemurSummaryParameters(
254-
transcriptIds, context, finalModel, maxOutputSize, temperature, answerFormat, additionalProperties);
278+
transcriptIds,
279+
inputText,
280+
context,
281+
finalModel,
282+
maxOutputSize,
283+
temperature,
284+
answerFormat,
285+
additionalProperties);
255286
}
256287
}
257288
}

‎src/main/java/com/assemblyai/api/resources/lemur/requests/LemurTaskParameters.java

+62-21
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import com.fasterxml.jackson.annotation.JsonSetter;
1616
import com.fasterxml.jackson.annotation.Nulls;
1717
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
18-
import java.util.ArrayList;
1918
import java.util.HashMap;
2019
import java.util.List;
2120
import java.util.Map;
@@ -25,7 +24,9 @@
2524
@JsonInclude(JsonInclude.Include.NON_EMPTY)
2625
@JsonDeserialize(builder = LemurTaskParameters.Builder.class)
2726
public final class LemurTaskParameters implements ILemurBaseParameters {
28-
private final List<String> transcriptIds;
27+
private final Optional<List<String>> transcriptIds;
28+
29+
private final Optional<String> inputText;
2930

3031
private final Optional<LemurBaseParametersContext> context;
3132

@@ -40,14 +41,16 @@ public final class LemurTaskParameters implements ILemurBaseParameters {
4041
private final Map<String, Object> additionalProperties;
4142

4243
private LemurTaskParameters(
43-
List<String> transcriptIds,
44+
Optional<List<String>> transcriptIds,
45+
Optional<String> inputText,
4446
Optional<LemurBaseParametersContext> context,
4547
Optional<LemurModel> finalModel,
4648
Optional<Integer> maxOutputSize,
4749
Optional<Double> temperature,
4850
String prompt,
4951
Map<String, Object> additionalProperties) {
5052
this.transcriptIds = transcriptIds;
53+
this.inputText = inputText;
5154
this.context = context;
5255
this.finalModel = finalModel;
5356
this.maxOutputSize = maxOutputSize;
@@ -57,14 +60,25 @@ private LemurTaskParameters(
5760
}
5861

5962
/**
60-
* @return A list of completed transcripts with text. Up to 100 files max, or 100 hours max. Whichever is lower.
63+
* @return A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.
64+
* Use either transcript_ids or input_text as input into LeMUR.
6165
*/
6266
@JsonProperty("transcript_ids")
6367
@Override
64-
public List<String> getTranscriptIds() {
68+
public Optional<List<String>> getTranscriptIds() {
6569
return transcriptIds;
6670
}
6771

72+
/**
73+
* @return Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.
74+
* Use either transcript_ids or input_text as input into LeMUR.
75+
*/
76+
@JsonProperty("input_text")
77+
@Override
78+
public Optional<String> getInputText() {
79+
return inputText;
80+
}
81+
6882
/**
6983
* @return Context to provide the model. This can be a string or a free-form JSON value.
7084
*/
@@ -81,7 +95,7 @@ public Optional<LemurModel> getFinalModel() {
8195
}
8296

8397
/**
84-
* @return Max output size in tokens. Up to 4000 allowed.
98+
* @return Max output size in tokens, up to 4000
8599
*/
86100
@JsonProperty("max_output_size")
87101
@Override
@@ -121,6 +135,7 @@ public Map<String, Object> getAdditionalProperties() {
121135

122136
private boolean equalTo(LemurTaskParameters other) {
123137
return transcriptIds.equals(other.transcriptIds)
138+
&& inputText.equals(other.inputText)
124139
&& context.equals(other.context)
125140
&& finalModel.equals(other.finalModel)
126141
&& maxOutputSize.equals(other.maxOutputSize)
@@ -131,7 +146,13 @@ private boolean equalTo(LemurTaskParameters other) {
131146
@Override
132147
public int hashCode() {
133148
return Objects.hash(
134-
this.transcriptIds, this.context, this.finalModel, this.maxOutputSize, this.temperature, this.prompt);
149+
this.transcriptIds,
150+
this.inputText,
151+
this.context,
152+
this.finalModel,
153+
this.maxOutputSize,
154+
this.temperature,
155+
this.prompt);
135156
}
136157

137158
@Override
@@ -152,11 +173,13 @@ public interface PromptStage {
152173
public interface _FinalStage {
153174
LemurTaskParameters build();
154175

176+
_FinalStage transcriptIds(Optional<List<String>> transcriptIds);
177+
155178
_FinalStage transcriptIds(List<String> transcriptIds);
156179

157-
_FinalStage addTranscriptIds(String transcriptIds);
180+
_FinalStage inputText(Optional<String> inputText);
158181

159-
_FinalStage addAllTranscriptIds(List<String> transcriptIds);
182+
_FinalStage inputText(String inputText);
160183

161184
_FinalStage context(Optional<LemurBaseParametersContext> context);
162185

@@ -187,7 +210,9 @@ public static final class Builder implements PromptStage, _FinalStage {
187210

188211
private Optional<LemurBaseParametersContext> context = Optional.empty();
189212

190-
private List<String> transcriptIds = new ArrayList<>();
213+
private Optional<String> inputText = Optional.empty();
214+
215+
private Optional<List<String>> transcriptIds = Optional.empty();
191216

192217
@JsonAnySetter
193218
private Map<String, Object> additionalProperties = new HashMap<>();
@@ -197,6 +222,7 @@ private Builder() {}
197222
@Override
198223
public Builder from(LemurTaskParameters other) {
199224
transcriptIds(other.getTranscriptIds());
225+
inputText(other.getInputText());
200226
context(other.getContext());
201227
finalModel(other.getFinalModel());
202228
maxOutputSize(other.getMaxOutputSize());
@@ -236,7 +262,7 @@ public _FinalStage temperature(Optional<Double> temperature) {
236262
}
237263

238264
/**
239-
* <p>Max output size in tokens. Up to 4000 allowed.</p>
265+
* <p>Max output size in tokens, up to 4000</p>
240266
* @return Reference to {@code this} so that method calls can be chained together.
241267
*/
242268
@Override
@@ -283,37 +309,52 @@ public _FinalStage context(Optional<LemurBaseParametersContext> context) {
283309
}
284310

285311
/**
286-
* <p>A list of completed transcripts with text. Up to 100 files max, or 100 hours max. Whichever is lower.</p>
312+
* <p>Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.
313+
* Use either transcript_ids or input_text as input into LeMUR.</p>
287314
* @return Reference to {@code this} so that method calls can be chained together.
288315
*/
289316
@Override
290-
public _FinalStage addAllTranscriptIds(List<String> transcriptIds) {
291-
this.transcriptIds.addAll(transcriptIds);
317+
public _FinalStage inputText(String inputText) {
318+
this.inputText = Optional.of(inputText);
319+
return this;
320+
}
321+
322+
@Override
323+
@JsonSetter(value = "input_text", nulls = Nulls.SKIP)
324+
public _FinalStage inputText(Optional<String> inputText) {
325+
this.inputText = inputText;
292326
return this;
293327
}
294328

295329
/**
296-
* <p>A list of completed transcripts with text. Up to 100 files max, or 100 hours max. Whichever is lower.</p>
330+
* <p>A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.
331+
* Use either transcript_ids or input_text as input into LeMUR.</p>
297332
* @return Reference to {@code this} so that method calls can be chained together.
298333
*/
299334
@Override
300-
public _FinalStage addTranscriptIds(String transcriptIds) {
301-
this.transcriptIds.add(transcriptIds);
335+
public _FinalStage transcriptIds(List<String> transcriptIds) {
336+
this.transcriptIds = Optional.of(transcriptIds);
302337
return this;
303338
}
304339

305340
@Override
306341
@JsonSetter(value = "transcript_ids", nulls = Nulls.SKIP)
307-
public _FinalStage transcriptIds(List<String> transcriptIds) {
308-
this.transcriptIds.clear();
309-
this.transcriptIds.addAll(transcriptIds);
342+
public _FinalStage transcriptIds(Optional<List<String>> transcriptIds) {
343+
this.transcriptIds = transcriptIds;
310344
return this;
311345
}
312346

313347
@Override
314348
public LemurTaskParameters build() {
315349
return new LemurTaskParameters(
316-
transcriptIds, context, finalModel, maxOutputSize, temperature, prompt, additionalProperties);
350+
transcriptIds,
351+
inputText,
352+
context,
353+
finalModel,
354+
maxOutputSize,
355+
temperature,
356+
prompt,
357+
additionalProperties);
317358
}
318359
}
319360
}

‎src/main/java/com/assemblyai/api/resources/realtime/requests/CreateRealtimeTemporaryTokenParameters.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ private CreateRealtimeTemporaryTokenParameters(int expiresIn, Map<String, Object
2828
}
2929

3030
/**
31-
* @return The amount of time until the token expires in seconds.
31+
* @return The amount of time until the token expires in seconds
3232
*/
3333
@JsonProperty("expires_in")
3434
public int getExpiresIn() {
@@ -91,7 +91,7 @@ public Builder from(CreateRealtimeTemporaryTokenParameters other) {
9191
}
9292

9393
/**
94-
* <p>The amount of time until the token expires in seconds.</p>
94+
* <p>The amount of time until the token expires in seconds</p>
9595
* @return Reference to {@code this} so that method calls can be chained together.
9696
*/
9797
@Override

‎src/main/java/com/assemblyai/api/resources/transcript/TranscriptClient.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ public TranscriptClient(ClientOptions clientOptions) {
3434
}
3535

3636
/**
37-
* Retrieve a list of transcripts you have created.
37+
* Retrieve a list of transcripts you created
3838
*/
3939
public TranscriptList list() {
4040
return list(TranscriptListRequest.builder().build());
4141
}
4242

4343
/**
44-
* Retrieve a list of transcripts you have created.
44+
* Retrieve a list of transcripts you created
4545
*/
4646
public TranscriptList list(TranscriptListRequest request, RequestOptions requestOptions) {
4747
HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
@@ -87,7 +87,7 @@ public TranscriptList list(TranscriptListRequest request, RequestOptions request
8787
}
8888

8989
/**
90-
* Retrieve a list of transcripts you have created.
90+
* Retrieve a list of transcripts you created
9191
*/
9292
public TranscriptList list(TranscriptListRequest request) {
9393
return list(request, null);
@@ -384,7 +384,7 @@ public WordSearchResponse wordSearch(String transcriptId, TranscriptWordSearchRe
384384
}
385385

386386
/**
387-
* Retrieves the redacted audio object containing the status and URL to the redacted audio.
387+
* Retrieve the redacted audio object containing the status and URL to the redacted audio.
388388
*/
389389
public RedactedAudioResponse getRedactedAudio(String transcriptId, RequestOptions requestOptions) {
390390
HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
@@ -414,7 +414,7 @@ public RedactedAudioResponse getRedactedAudio(String transcriptId, RequestOption
414414
}
415415

416416
/**
417-
* Retrieves the redacted audio object containing the status and URL to the redacted audio.
417+
* Retrieve the redacted audio object containing the status and URL to the redacted audio.
418418
*/
419419
public RedactedAudioResponse getRedactedAudio(String transcriptId) {
420420
return getRedactedAudio(transcriptId, null);

‎src/main/java/com/assemblyai/api/resources/transcript/requests/CreateTranscriptParameters.java

+32-48
Original file line numberDiff line numberDiff line change
@@ -176,18 +176,14 @@ private CreateTranscriptParameters(
176176
this.additionalProperties = additionalProperties;
177177
}
178178

179-
/**
180-
* @return The language of your audio file. Possible values are found in <a href="https://www.assemblyai.com/docs/Concepts/supported_languages">Supported Languages</a>.
181-
* The default value is 'en_us'.
182-
*/
183179
@JsonProperty("language_code")
184180
@Override
185181
public Optional<TranscriptLanguageCode> getLanguageCode() {
186182
return languageCode;
187183
}
188184

189185
/**
190-
* @return Enable Automatic Punctuation, can be true or false.
186+
* @return Enable Automatic Punctuation, can be true or false
191187
*/
192188
@JsonProperty("punctuate")
193189
@Override
@@ -196,7 +192,7 @@ public Optional<Boolean> getPunctuate() {
196192
}
197193

198194
/**
199-
* @return Enable Text Formatting, can be true or false.
195+
* @return Enable Text Formatting, can be true or false
200196
*/
201197
@JsonProperty("format_text")
202198
@Override
@@ -205,7 +201,7 @@ public Optional<Boolean> getFormatText() {
205201
}
206202

207203
/**
208-
* @return Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false.
204+
* @return Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false
209205
*/
210206
@JsonProperty("dual_channel")
211207
@Override
@@ -214,7 +210,7 @@ public Optional<Boolean> getDualChannel() {
214210
}
215211

216212
/**
217-
* @return The URL to which we send webhooks upon trancription completion, if provided in the transcription request.
213+
* @return The URL to which AssemblyAI send webhooks upon trancription completion
218214
*/
219215
@JsonProperty("webhook_url")
220216
@Override
@@ -223,7 +219,7 @@ public Optional<String> getWebhookUrl() {
223219
}
224220

225221
/**
226-
* @return The header name which should be sent back with webhook calls, if provided in the transcription request.
222+
* @return The header name which should be sent back with webhook calls
227223
*/
228224
@JsonProperty("webhook_auth_header_name")
229225
@Override
@@ -232,7 +228,7 @@ public Optional<String> getWebhookAuthHeaderName() {
232228
}
233229

234230
/**
235-
* @return Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.
231+
* @return Specify a header name and value to send back with a webhook call for added security
236232
*/
237233
@JsonProperty("webhook_auth_header_value")
238234
@Override
@@ -241,7 +237,7 @@ public Optional<String> getWebhookAuthHeaderValue() {
241237
}
242238

243239
/**
244-
* @return Whether Key Phrases was enabled in the transcription request, either true or false
240+
* @return Whether Key Phrases is enabled, either true or false
245241
*/
246242
@JsonProperty("auto_highlights")
247243
@Override
@@ -250,7 +246,7 @@ public Optional<Boolean> getAutoHighlights() {
250246
}
251247

252248
/**
253-
* @return The point in time, in milliseconds, to begin transcription from in your media file
249+
* @return The point in time, in milliseconds, to begin transcribing in your media file
254250
*/
255251
@JsonProperty("audio_start_from")
256252
@Override
@@ -268,7 +264,7 @@ public Optional<Integer> getAudioEndAt() {
268264
}
269265

270266
/**
271-
* @return The list of custom vocabulary to boost transcription probability for, if provided in the transcription request.
267+
* @return The list of custom vocabulary to boost transcription probability for
272268
*/
273269
@JsonProperty("word_boost")
274270
@Override
@@ -277,7 +273,7 @@ public Optional<List<String>> getWordBoost() {
277273
}
278274

279275
/**
280-
* @return The word boost parameter value, if provided in the transcription request.
276+
* @return The word boost parameter value
281277
*/
282278
@JsonProperty("boost_param")
283279
@Override
@@ -286,7 +282,7 @@ public Optional<TranscriptBoostParam> getBoostParam() {
286282
}
287283

288284
/**
289-
* @return Filter profanity from the transcribed text, can be true or false.
285+
* @return Filter profanity from the transcribed text, can be true or false
290286
*/
291287
@JsonProperty("filter_profanity")
292288
@Override
@@ -330,9 +326,6 @@ public Optional<List<PiiPolicy>> getRedactPiiPolicies() {
330326
return redactPiiPolicies;
331327
}
332328

333-
/**
334-
* @return The replacement logic for detected PII, can be &quot;entity_type&quot; or &quot;hash&quot;. See <a href="https://www.assemblyai.com/docs/Models/pii_redaction">PII redaction</a> for more details.
335-
*/
336329
@JsonProperty("redact_pii_sub")
337330
@Override
338331
public Optional<SubstitutionPolicy> getRedactPiiSub() {
@@ -349,7 +342,7 @@ public Optional<Boolean> getSpeakerLabels() {
349342
}
350343

351344
/**
352-
* @return Tells the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.
345+
* @return Tell the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.
353346
*/
354347
@JsonProperty("speakers_expected")
355348
@Override
@@ -376,7 +369,7 @@ public Optional<Boolean> getIabCategories() {
376369
}
377370

378371
/**
379-
* @return Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> was enabled in the transcription request, either true or false.
372+
* @return Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> is enabled, either true or false
380373
*/
381374
@JsonProperty("language_detection")
382375
@Override
@@ -394,7 +387,7 @@ public Optional<List<TranscriptCustomSpelling>> getCustomSpelling() {
394387
}
395388

396389
/**
397-
* @return Transcribe Filler Words, like &quot;umm&quot;, in your media file; can be true or false.
390+
* @return Transcribe Filler Words, like &quot;umm&quot;, in your media file; can be true or false
398391
*/
399392
@JsonProperty("disfluencies")
400393
@Override
@@ -467,7 +460,7 @@ public Optional<SummaryType> getSummaryType() {
467460
}
468461

469462
/**
470-
* @return Whether custom topics was enabled in the transcription request, either true or false
463+
* @return Whether custom topics is enabled, either true or false
471464
*/
472465
@JsonProperty("custom_topics")
473466
@Override
@@ -476,7 +469,7 @@ public Optional<Boolean> getCustomTopics() {
476469
}
477470

478471
/**
479-
* @return The list of custom topics provided if custom topics was enabled in the transcription request
472+
* @return The list of custom topics provided, if custom topics is enabled
480473
*/
481474
@JsonProperty("topics")
482475
@Override
@@ -865,7 +858,7 @@ public _FinalStage audioUrl(String audioUrl) {
865858
}
866859

867860
/**
868-
* <p>The list of custom topics provided if custom topics was enabled in the transcription request</p>
861+
* <p>The list of custom topics provided, if custom topics is enabled</p>
869862
* @return Reference to {@code this} so that method calls can be chained together.
870863
*/
871864
@Override
@@ -882,7 +875,7 @@ public _FinalStage topics(Optional<List<String>> topics) {
882875
}
883876

884877
/**
885-
* <p>Whether custom topics was enabled in the transcription request, either true or false</p>
878+
* <p>Whether custom topics is enabled, either true or false</p>
886879
* @return Reference to {@code this} so that method calls can be chained together.
887880
*/
888881
@Override
@@ -1019,7 +1012,7 @@ public _FinalStage sentimentAnalysis(Optional<Boolean> sentimentAnalysis) {
10191012
}
10201013

10211014
/**
1022-
* <p>Transcribe Filler Words, like &quot;umm&quot;, in your media file; can be true or false.</p>
1015+
* <p>Transcribe Filler Words, like &quot;umm&quot;, in your media file; can be true or false</p>
10231016
* @return Reference to {@code this} so that method calls can be chained together.
10241017
*/
10251018
@Override
@@ -1053,7 +1046,7 @@ public _FinalStage customSpelling(Optional<List<TranscriptCustomSpelling>> custo
10531046
}
10541047

10551048
/**
1056-
* <p>Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> was enabled in the transcription request, either true or false.</p>
1049+
* <p>Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> is enabled, either true or false</p>
10571050
* @return Reference to {@code this} so that method calls can be chained together.
10581051
*/
10591052
@Override
@@ -1104,7 +1097,7 @@ public _FinalStage contentSafety(Optional<Boolean> contentSafety) {
11041097
}
11051098

11061099
/**
1107-
* <p>Tells the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.</p>
1100+
* <p>Tell the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.</p>
11081101
* @return Reference to {@code this} so that method calls can be chained together.
11091102
*/
11101103
@Override
@@ -1137,10 +1130,6 @@ public _FinalStage speakerLabels(Optional<Boolean> speakerLabels) {
11371130
return this;
11381131
}
11391132

1140-
/**
1141-
* <p>The replacement logic for detected PII, can be &quot;entity_type&quot; or &quot;hash&quot;. See <a href="https://www.assemblyai.com/docs/Models/pii_redaction">PII redaction</a> for more details.</p>
1142-
* @return Reference to {@code this} so that method calls can be chained together.
1143-
*/
11441133
@Override
11451134
public _FinalStage redactPiiSub(SubstitutionPolicy redactPiiSub) {
11461135
this.redactPiiSub = Optional.of(redactPiiSub);
@@ -1223,7 +1212,7 @@ public _FinalStage redactPii(Optional<Boolean> redactPii) {
12231212
}
12241213

12251214
/**
1226-
* <p>Filter profanity from the transcribed text, can be true or false.</p>
1215+
* <p>Filter profanity from the transcribed text, can be true or false</p>
12271216
* @return Reference to {@code this} so that method calls can be chained together.
12281217
*/
12291218
@Override
@@ -1240,7 +1229,7 @@ public _FinalStage filterProfanity(Optional<Boolean> filterProfanity) {
12401229
}
12411230

12421231
/**
1243-
* <p>The word boost parameter value, if provided in the transcription request.</p>
1232+
* <p>The word boost parameter value</p>
12441233
* @return Reference to {@code this} so that method calls can be chained together.
12451234
*/
12461235
@Override
@@ -1257,7 +1246,7 @@ public _FinalStage boostParam(Optional<TranscriptBoostParam> boostParam) {
12571246
}
12581247

12591248
/**
1260-
* <p>The list of custom vocabulary to boost transcription probability for, if provided in the transcription request.</p>
1249+
* <p>The list of custom vocabulary to boost transcription probability for</p>
12611250
* @return Reference to {@code this} so that method calls can be chained together.
12621251
*/
12631252
@Override
@@ -1291,7 +1280,7 @@ public _FinalStage audioEndAt(Optional<Integer> audioEndAt) {
12911280
}
12921281

12931282
/**
1294-
* <p>The point in time, in milliseconds, to begin transcription from in your media file</p>
1283+
* <p>The point in time, in milliseconds, to begin transcribing in your media file</p>
12951284
* @return Reference to {@code this} so that method calls can be chained together.
12961285
*/
12971286
@Override
@@ -1308,7 +1297,7 @@ public _FinalStage audioStartFrom(Optional<Integer> audioStartFrom) {
13081297
}
13091298

13101299
/**
1311-
* <p>Whether Key Phrases was enabled in the transcription request, either true or false</p>
1300+
* <p>Whether Key Phrases is enabled, either true or false</p>
13121301
* @return Reference to {@code this} so that method calls can be chained together.
13131302
*/
13141303
@Override
@@ -1325,7 +1314,7 @@ public _FinalStage autoHighlights(Optional<Boolean> autoHighlights) {
13251314
}
13261315

13271316
/**
1328-
* <p>Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.</p>
1317+
* <p>Specify a header name and value to send back with a webhook call for added security</p>
13291318
* @return Reference to {@code this} so that method calls can be chained together.
13301319
*/
13311320
@Override
@@ -1342,7 +1331,7 @@ public _FinalStage webhookAuthHeaderValue(Optional<String> webhookAuthHeaderValu
13421331
}
13431332

13441333
/**
1345-
* <p>The header name which should be sent back with webhook calls, if provided in the transcription request.</p>
1334+
* <p>The header name which should be sent back with webhook calls</p>
13461335
* @return Reference to {@code this} so that method calls can be chained together.
13471336
*/
13481337
@Override
@@ -1359,7 +1348,7 @@ public _FinalStage webhookAuthHeaderName(Optional<String> webhookAuthHeaderName)
13591348
}
13601349

13611350
/**
1362-
* <p>The URL to which we send webhooks upon trancription completion, if provided in the transcription request.</p>
1351+
* <p>The URL to which AssemblyAI send webhooks upon trancription completion</p>
13631352
* @return Reference to {@code this} so that method calls can be chained together.
13641353
*/
13651354
@Override
@@ -1376,7 +1365,7 @@ public _FinalStage webhookUrl(Optional<String> webhookUrl) {
13761365
}
13771366

13781367
/**
1379-
* <p>Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false.</p>
1368+
* <p>Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false</p>
13801369
* @return Reference to {@code this} so that method calls can be chained together.
13811370
*/
13821371
@Override
@@ -1393,7 +1382,7 @@ public _FinalStage dualChannel(Optional<Boolean> dualChannel) {
13931382
}
13941383

13951384
/**
1396-
* <p>Enable Text Formatting, can be true or false.</p>
1385+
* <p>Enable Text Formatting, can be true or false</p>
13971386
* @return Reference to {@code this} so that method calls can be chained together.
13981387
*/
13991388
@Override
@@ -1410,7 +1399,7 @@ public _FinalStage formatText(Optional<Boolean> formatText) {
14101399
}
14111400

14121401
/**
1413-
* <p>Enable Automatic Punctuation, can be true or false.</p>
1402+
* <p>Enable Automatic Punctuation, can be true or false</p>
14141403
* @return Reference to {@code this} so that method calls can be chained together.
14151404
*/
14161405
@Override
@@ -1426,11 +1415,6 @@ public _FinalStage punctuate(Optional<Boolean> punctuate) {
14261415
return this;
14271416
}
14281417

1429-
/**
1430-
* <p>The language of your audio file. Possible values are found in <a href="https://www.assemblyai.com/docs/Concepts/supported_languages">Supported Languages</a>.
1431-
* The default value is 'en_us'.</p>
1432-
* @return Reference to {@code this} so that method calls can be chained together.
1433-
*/
14341418
@Override
14351419
public _FinalStage languageCode(TranscriptLanguageCode languageCode) {
14361420
this.languageCode = Optional.of(languageCode);

‎src/main/java/com/assemblyai/api/types/AudioData.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ private AudioData(String audioData, Map<String, Object> additionalProperties) {
2828
}
2929

3030
/**
31-
* @return Raw audio data, base64 encoded. This can be the raw data recorded directly from a microphone or read from an audio file.
31+
* @return Base64 encoded raw audio data
3232
*/
3333
@JsonProperty("audio_data")
3434
public String getAudioData() {
@@ -90,7 +90,7 @@ public Builder from(AudioData other) {
9090
}
9191

9292
/**
93-
* <p>Raw audio data, base64 encoded. This can be the raw data recorded directly from a microphone or read from an audio file.</p>
93+
* <p>Base64 encoded raw audio data</p>
9494
* @return Reference to {@code this} so that method calls can be chained together.
9595
*/
9696
@Override

‎src/main/java/com/assemblyai/api/types/ContentSafetyLabelResult.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public String getText() {
5757
}
5858

5959
/**
60-
* @return An array of objects, one per sensitive topic that was detected in the section
60+
* @return An array of safety labels, one per sensitive topic that was detected in the section
6161
*/
6262
@JsonProperty("labels")
6363
public List<ContentSafetyLabel> getLabels() {
@@ -222,7 +222,7 @@ public _FinalStage timestamp(Timestamp timestamp) {
222222
}
223223

224224
/**
225-
* <p>An array of objects, one per sensitive topic that was detected in the section</p>
225+
* <p>An array of safety labels, one per sensitive topic that was detected in the section</p>
226226
* @return Reference to {@code this} so that method calls can be chained together.
227227
*/
228228
@Override
@@ -232,7 +232,7 @@ public _FinalStage addAllLabels(List<ContentSafetyLabel> labels) {
232232
}
233233

234234
/**
235-
* <p>An array of objects, one per sensitive topic that was detected in the section</p>
235+
* <p>An array of safety labels, one per sensitive topic that was detected in the section</p>
236236
* @return Reference to {@code this} so that method calls can be chained together.
237237
*/
238238
@Override

‎src/main/java/com/assemblyai/api/types/ContentSafetyLabelsResult.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ private ContentSafetyLabelsResult(
4646
}
4747

4848
/**
49-
* @return Will be either success, or unavailable in the rare case that the Content Moderation model failed.
49+
* @return The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.
5050
*/
5151
@JsonProperty("status")
5252
public AudioIntelligenceModelStatus getStatus() {
@@ -159,7 +159,7 @@ public Builder from(ContentSafetyLabelsResult other) {
159159
}
160160

161161
/**
162-
* <p>Will be either success, or unavailable in the rare case that the Content Moderation model failed.</p>
162+
* <p>The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.</p>
163163
* @return Reference to {@code this} so that method calls can be chained together.
164164
*/
165165
@Override

‎src/main/java/com/assemblyai/api/types/CreateTranscriptOptionalParameters.java

+16-23
Original file line numberDiff line numberDiff line change
@@ -164,18 +164,14 @@ private CreateTranscriptOptionalParameters(
164164
this.additionalProperties = additionalProperties;
165165
}
166166

167-
/**
168-
* @return The language of your audio file. Possible values are found in <a href="https://www.assemblyai.com/docs/Concepts/supported_languages">Supported Languages</a>.
169-
* The default value is 'en_us'.
170-
*/
171167
@JsonProperty("language_code")
172168
@Override
173169
public Optional<TranscriptLanguageCode> getLanguageCode() {
174170
return languageCode;
175171
}
176172

177173
/**
178-
* @return Enable Automatic Punctuation, can be true or false.
174+
* @return Enable Automatic Punctuation, can be true or false
179175
*/
180176
@JsonProperty("punctuate")
181177
@Override
@@ -184,7 +180,7 @@ public Optional<Boolean> getPunctuate() {
184180
}
185181

186182
/**
187-
* @return Enable Text Formatting, can be true or false.
183+
* @return Enable Text Formatting, can be true or false
188184
*/
189185
@JsonProperty("format_text")
190186
@Override
@@ -193,7 +189,7 @@ public Optional<Boolean> getFormatText() {
193189
}
194190

195191
/**
196-
* @return Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false.
192+
* @return Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false
197193
*/
198194
@JsonProperty("dual_channel")
199195
@Override
@@ -202,7 +198,7 @@ public Optional<Boolean> getDualChannel() {
202198
}
203199

204200
/**
205-
* @return The URL to which we send webhooks upon trancription completion, if provided in the transcription request.
201+
* @return The URL to which AssemblyAI send webhooks upon trancription completion
206202
*/
207203
@JsonProperty("webhook_url")
208204
@Override
@@ -211,7 +207,7 @@ public Optional<String> getWebhookUrl() {
211207
}
212208

213209
/**
214-
* @return The header name which should be sent back with webhook calls, if provided in the transcription request.
210+
* @return The header name which should be sent back with webhook calls
215211
*/
216212
@JsonProperty("webhook_auth_header_name")
217213
@Override
@@ -220,7 +216,7 @@ public Optional<String> getWebhookAuthHeaderName() {
220216
}
221217

222218
/**
223-
* @return Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.
219+
* @return Specify a header name and value to send back with a webhook call for added security
224220
*/
225221
@JsonProperty("webhook_auth_header_value")
226222
@Override
@@ -229,7 +225,7 @@ public Optional<String> getWebhookAuthHeaderValue() {
229225
}
230226

231227
/**
232-
* @return Whether Key Phrases was enabled in the transcription request, either true or false
228+
* @return Whether Key Phrases is enabled, either true or false
233229
*/
234230
@JsonProperty("auto_highlights")
235231
@Override
@@ -238,7 +234,7 @@ public Optional<Boolean> getAutoHighlights() {
238234
}
239235

240236
/**
241-
* @return The point in time, in milliseconds, to begin transcription from in your media file
237+
* @return The point in time, in milliseconds, to begin transcribing in your media file
242238
*/
243239
@JsonProperty("audio_start_from")
244240
@Override
@@ -256,7 +252,7 @@ public Optional<Integer> getAudioEndAt() {
256252
}
257253

258254
/**
259-
* @return The list of custom vocabulary to boost transcription probability for, if provided in the transcription request.
255+
* @return The list of custom vocabulary to boost transcription probability for
260256
*/
261257
@JsonProperty("word_boost")
262258
@Override
@@ -265,7 +261,7 @@ public Optional<List<String>> getWordBoost() {
265261
}
266262

267263
/**
268-
* @return The word boost parameter value, if provided in the transcription request.
264+
* @return The word boost parameter value
269265
*/
270266
@JsonProperty("boost_param")
271267
@Override
@@ -274,7 +270,7 @@ public Optional<TranscriptBoostParam> getBoostParam() {
274270
}
275271

276272
/**
277-
* @return Filter profanity from the transcribed text, can be true or false.
273+
* @return Filter profanity from the transcribed text, can be true or false
278274
*/
279275
@JsonProperty("filter_profanity")
280276
@Override
@@ -318,9 +314,6 @@ public Optional<List<PiiPolicy>> getRedactPiiPolicies() {
318314
return redactPiiPolicies;
319315
}
320316

321-
/**
322-
* @return The replacement logic for detected PII, can be &quot;entity_type&quot; or &quot;hash&quot;. See <a href="https://www.assemblyai.com/docs/Models/pii_redaction">PII redaction</a> for more details.
323-
*/
324317
@JsonProperty("redact_pii_sub")
325318
@Override
326319
public Optional<SubstitutionPolicy> getRedactPiiSub() {
@@ -337,7 +330,7 @@ public Optional<Boolean> getSpeakerLabels() {
337330
}
338331

339332
/**
340-
* @return Tells the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.
333+
* @return Tell the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.
341334
*/
342335
@JsonProperty("speakers_expected")
343336
@Override
@@ -364,7 +357,7 @@ public Optional<Boolean> getIabCategories() {
364357
}
365358

366359
/**
367-
* @return Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> was enabled in the transcription request, either true or false.
360+
* @return Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> is enabled, either true or false
368361
*/
369362
@JsonProperty("language_detection")
370363
@Override
@@ -382,7 +375,7 @@ public Optional<List<TranscriptCustomSpelling>> getCustomSpelling() {
382375
}
383376

384377
/**
385-
* @return Transcribe Filler Words, like &quot;umm&quot;, in your media file; can be true or false.
378+
* @return Transcribe Filler Words, like &quot;umm&quot;, in your media file; can be true or false
386379
*/
387380
@JsonProperty("disfluencies")
388381
@Override
@@ -455,7 +448,7 @@ public Optional<SummaryType> getSummaryType() {
455448
}
456449

457450
/**
458-
* @return Whether custom topics was enabled in the transcription request, either true or false
451+
* @return Whether custom topics is enabled, either true or false
459452
*/
460453
@JsonProperty("custom_topics")
461454
@Override
@@ -464,7 +457,7 @@ public Optional<Boolean> getCustomTopics() {
464457
}
465458

466459
/**
467-
* @return The list of custom topics provided if custom topics was enabled in the transcription request
460+
* @return The list of custom topics provided, if custom topics is enabled
468461
*/
469462
@JsonProperty("topics")
470463
@Override

‎src/main/java/com/assemblyai/api/types/FinalTranscript.java

+20-17
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ private FinalTranscript(
6161
}
6262

6363
/**
64-
* @return Start time of audio sample relative to session start, in milliseconds.
64+
* @return Start time of audio sample relative to session start, in milliseconds
6565
*/
6666
@JsonProperty("audio_start")
6767
@Override
@@ -70,7 +70,7 @@ public int getAudioStart() {
7070
}
7171

7272
/**
73-
* @return End time of audio sample relative to session start, in milliseconds.
73+
* @return End time of audio sample relative to session start, in milliseconds
7474
*/
7575
@JsonProperty("audio_end")
7676
@Override
@@ -79,7 +79,7 @@ public int getAudioEnd() {
7979
}
8080

8181
/**
82-
* @return The confidence score of the entire transcription, between 0 and 1.
82+
* @return The confidence score of the entire transcription, between 0 and 1
8383
*/
8484
@JsonProperty("confidence")
8585
@Override
@@ -88,7 +88,7 @@ public double getConfidence() {
8888
}
8989

9090
/**
91-
* @return The partial transcript for your audio.
91+
* @return The partial transcript for your audio
9292
*/
9393
@JsonProperty("text")
9494
@Override
@@ -97,7 +97,8 @@ public String getText() {
9797
}
9898

9999
/**
100-
* @return An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).
100+
* @return An array of objects, with the information for each word in the transcription text.
101+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
101102
*/
102103
@JsonProperty("words")
103104
@Override
@@ -106,7 +107,7 @@ public List<Word> getWords() {
106107
}
107108

108109
/**
109-
* @return The timestamp for the partial transcript.
110+
* @return The timestamp for the partial transcript
110111
*/
111112
@JsonProperty("created")
112113
@Override
@@ -120,15 +121,15 @@ public String getMessageType() {
120121
}
121122

122123
/**
123-
* @return Whether the text has been punctuated and cased.
124+
* @return Whether the text is punctuated and cased
124125
*/
125126
@JsonProperty("punctuated")
126127
public boolean getPunctuated() {
127128
return punctuated;
128129
}
129130

130131
/**
131-
* @return Whether the text has been formatted (e.g. Dollar -&gt; $)
132+
* @return Whether the text is formatted, for example Dollar -&gt; $
132133
*/
133134
@JsonProperty("text_formatted")
134135
public boolean getTextFormatted() {
@@ -264,7 +265,7 @@ public Builder from(FinalTranscript other) {
264265
}
265266

266267
/**
267-
* <p>Start time of audio sample relative to session start, in milliseconds.</p>
268+
* <p>Start time of audio sample relative to session start, in milliseconds</p>
268269
* @return Reference to {@code this} so that method calls can be chained together.
269270
*/
270271
@Override
@@ -275,7 +276,7 @@ public AudioEndStage audioStart(int audioStart) {
275276
}
276277

277278
/**
278-
* <p>End time of audio sample relative to session start, in milliseconds.</p>
279+
* <p>End time of audio sample relative to session start, in milliseconds</p>
279280
* @return Reference to {@code this} so that method calls can be chained together.
280281
*/
281282
@Override
@@ -286,7 +287,7 @@ public ConfidenceStage audioEnd(int audioEnd) {
286287
}
287288

288289
/**
289-
* <p>The confidence score of the entire transcription, between 0 and 1.</p>
290+
* <p>The confidence score of the entire transcription, between 0 and 1</p>
290291
* @return Reference to {@code this} so that method calls can be chained together.
291292
*/
292293
@Override
@@ -297,7 +298,7 @@ public TextStage confidence(double confidence) {
297298
}
298299

299300
/**
300-
* <p>The partial transcript for your audio.</p>
301+
* <p>The partial transcript for your audio</p>
301302
* @return Reference to {@code this} so that method calls can be chained together.
302303
*/
303304
@Override
@@ -308,7 +309,7 @@ public CreatedStage text(String text) {
308309
}
309310

310311
/**
311-
* <p>The timestamp for the partial transcript.</p>
312+
* <p>The timestamp for the partial transcript</p>
312313
* @return Reference to {@code this} so that method calls can be chained together.
313314
*/
314315
@Override
@@ -319,7 +320,7 @@ public PunctuatedStage created(String created) {
319320
}
320321

321322
/**
322-
* <p>Whether the text has been punctuated and cased.</p>
323+
* <p>Whether the text is punctuated and cased</p>
323324
* @return Reference to {@code this} so that method calls can be chained together.
324325
*/
325326
@Override
@@ -330,7 +331,7 @@ public TextFormattedStage punctuated(boolean punctuated) {
330331
}
331332

332333
/**
333-
* <p>Whether the text has been formatted (e.g. Dollar -&gt; $)</p>
334+
* <p>Whether the text is formatted, for example Dollar -&gt; $</p>
334335
* @return Reference to {@code this} so that method calls can be chained together.
335336
*/
336337
@Override
@@ -341,7 +342,8 @@ public _FinalStage textFormatted(boolean textFormatted) {
341342
}
342343

343344
/**
344-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
345+
* <p>An array of objects, with the information for each word in the transcription text.
346+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
345347
* @return Reference to {@code this} so that method calls can be chained together.
346348
*/
347349
@Override
@@ -351,7 +353,8 @@ public _FinalStage addAllWords(List<Word> words) {
351353
}
352354

353355
/**
354-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
356+
* <p>An array of objects, with the information for each word in the transcription text.
357+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
355358
* @return Reference to {@code this} so that method calls can be chained together.
356359
*/
357360
@Override

‎src/main/java/com/assemblyai/api/types/ILemurBaseParameters.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
import java.util.Optional;
88

99
public interface ILemurBaseParameters {
10-
List<String> getTranscriptIds();
10+
Optional<List<String>> getTranscriptIds();
11+
12+
Optional<String> getInputText();
1113

1214
Optional<LemurBaseParametersContext> getContext();
1315

‎src/main/java/com/assemblyai/api/types/LemurActionItemsResponse.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public String getRequestId() {
4040
}
4141

4242
/**
43-
* @return The response generated by LeMUR.
43+
* @return The response generated by LeMUR
4444
*/
4545
@JsonProperty("response")
4646
public String getResponse() {
@@ -120,7 +120,7 @@ public ResponseStage requestId(String requestId) {
120120
}
121121

122122
/**
123-
* <p>The response generated by LeMUR.</p>
123+
* <p>The response generated by LeMUR</p>
124124
* @return Reference to {@code this} so that method calls can be chained together.
125125
*/
126126
@Override

‎src/main/java/com/assemblyai/api/types/LemurBaseParameters.java

+44-15
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
import com.fasterxml.jackson.annotation.JsonSetter;
1313
import com.fasterxml.jackson.annotation.Nulls;
1414
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
15-
import java.util.ArrayList;
1615
import java.util.HashMap;
1716
import java.util.List;
1817
import java.util.Map;
@@ -22,7 +21,9 @@
2221
@JsonInclude(JsonInclude.Include.NON_EMPTY)
2322
@JsonDeserialize(builder = LemurBaseParameters.Builder.class)
2423
public final class LemurBaseParameters implements ILemurBaseParameters {
25-
private final List<String> transcriptIds;
24+
private final Optional<List<String>> transcriptIds;
25+
26+
private final Optional<String> inputText;
2627

2728
private final Optional<LemurBaseParametersContext> context;
2829

@@ -35,13 +36,15 @@ public final class LemurBaseParameters implements ILemurBaseParameters {
3536
private final Map<String, Object> additionalProperties;
3637

3738
private LemurBaseParameters(
38-
List<String> transcriptIds,
39+
Optional<List<String>> transcriptIds,
40+
Optional<String> inputText,
3941
Optional<LemurBaseParametersContext> context,
4042
Optional<LemurModel> finalModel,
4143
Optional<Integer> maxOutputSize,
4244
Optional<Double> temperature,
4345
Map<String, Object> additionalProperties) {
4446
this.transcriptIds = transcriptIds;
47+
this.inputText = inputText;
4548
this.context = context;
4649
this.finalModel = finalModel;
4750
this.maxOutputSize = maxOutputSize;
@@ -50,14 +53,25 @@ private LemurBaseParameters(
5053
}
5154

5255
/**
53-
* @return A list of completed transcripts with text. Up to 100 files max, or 100 hours max. Whichever is lower.
56+
* @return A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.
57+
* Use either transcript_ids or input_text as input into LeMUR.
5458
*/
5559
@JsonProperty("transcript_ids")
5660
@Override
57-
public List<String> getTranscriptIds() {
61+
public Optional<List<String>> getTranscriptIds() {
5862
return transcriptIds;
5963
}
6064

65+
/**
66+
* @return Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.
67+
* Use either transcript_ids or input_text as input into LeMUR.
68+
*/
69+
@JsonProperty("input_text")
70+
@Override
71+
public Optional<String> getInputText() {
72+
return inputText;
73+
}
74+
6175
/**
6276
* @return Context to provide the model. This can be a string or a free-form JSON value.
6377
*/
@@ -74,7 +88,7 @@ public Optional<LemurModel> getFinalModel() {
7488
}
7589

7690
/**
77-
* @return Max output size in tokens. Up to 4000 allowed.
91+
* @return Max output size in tokens, up to 4000
7892
*/
7993
@JsonProperty("max_output_size")
8094
@Override
@@ -106,6 +120,7 @@ public Map<String, Object> getAdditionalProperties() {
106120

107121
private boolean equalTo(LemurBaseParameters other) {
108122
return transcriptIds.equals(other.transcriptIds)
123+
&& inputText.equals(other.inputText)
109124
&& context.equals(other.context)
110125
&& finalModel.equals(other.finalModel)
111126
&& maxOutputSize.equals(other.maxOutputSize)
@@ -114,7 +129,13 @@ private boolean equalTo(LemurBaseParameters other) {
114129

115130
@Override
116131
public int hashCode() {
117-
return Objects.hash(this.transcriptIds, this.context, this.finalModel, this.maxOutputSize, this.temperature);
132+
return Objects.hash(
133+
this.transcriptIds,
134+
this.inputText,
135+
this.context,
136+
this.finalModel,
137+
this.maxOutputSize,
138+
this.temperature);
118139
}
119140

120141
@Override
@@ -128,7 +149,9 @@ public static Builder builder() {
128149

129150
@JsonIgnoreProperties(ignoreUnknown = true)
130151
public static final class Builder {
131-
private List<String> transcriptIds = new ArrayList<>();
152+
private Optional<List<String>> transcriptIds = Optional.empty();
153+
154+
private Optional<String> inputText = Optional.empty();
132155

133156
private Optional<LemurBaseParametersContext> context = Optional.empty();
134157

@@ -145,6 +168,7 @@ private Builder() {}
145168

146169
public Builder from(LemurBaseParameters other) {
147170
transcriptIds(other.getTranscriptIds());
171+
inputText(other.getInputText());
148172
context(other.getContext());
149173
finalModel(other.getFinalModel());
150174
maxOutputSize(other.getMaxOutputSize());
@@ -153,19 +177,24 @@ public Builder from(LemurBaseParameters other) {
153177
}
154178

155179
@JsonSetter(value = "transcript_ids", nulls = Nulls.SKIP)
180+
public Builder transcriptIds(Optional<List<String>> transcriptIds) {
181+
this.transcriptIds = transcriptIds;
182+
return this;
183+
}
184+
156185
public Builder transcriptIds(List<String> transcriptIds) {
157-
this.transcriptIds.clear();
158-
this.transcriptIds.addAll(transcriptIds);
186+
this.transcriptIds = Optional.of(transcriptIds);
159187
return this;
160188
}
161189

162-
public Builder addTranscriptIds(String transcriptIds) {
163-
this.transcriptIds.add(transcriptIds);
190+
@JsonSetter(value = "input_text", nulls = Nulls.SKIP)
191+
public Builder inputText(Optional<String> inputText) {
192+
this.inputText = inputText;
164193
return this;
165194
}
166195

167-
public Builder addAllTranscriptIds(List<String> transcriptIds) {
168-
this.transcriptIds.addAll(transcriptIds);
196+
public Builder inputText(String inputText) {
197+
this.inputText = Optional.of(inputText);
169198
return this;
170199
}
171200

@@ -215,7 +244,7 @@ public Builder temperature(Double temperature) {
215244

216245
public LemurBaseParameters build() {
217246
return new LemurBaseParameters(
218-
transcriptIds, context, finalModel, maxOutputSize, temperature, additionalProperties);
247+
transcriptIds, inputText, context, finalModel, maxOutputSize, temperature, additionalProperties);
219248
}
220249
}
221250
}

‎src/main/java/com/assemblyai/api/types/LemurQuestion.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public String getQuestion() {
5353
}
5454

5555
/**
56-
* @return Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
56+
* @return Any context about the transcripts you wish to provide. This can be a string or any object.
5757
*/
5858
@JsonProperty("context")
5959
public Optional<LemurQuestionContext> getContext() {
@@ -200,7 +200,7 @@ public _FinalStage answerFormat(Optional<String> answerFormat) {
200200
}
201201

202202
/**
203-
* <p>Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.</p>
203+
* <p>Any context about the transcripts you wish to provide. This can be a string or any object.</p>
204204
* @return Reference to {@code this} so that method calls can be chained together.
205205
*/
206206
@Override

‎src/main/java/com/assemblyai/api/types/LemurQuestionAnswer.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ private LemurQuestionAnswer(String question, String answer, Map<String, Object>
3131
}
3232

3333
/**
34-
* @return The question for LeMUR to answer.
34+
* @return The question for LeMUR to answer
3535
*/
3636
@JsonProperty("question")
3737
public String getQuestion() {
3838
return question;
3939
}
4040

4141
/**
42-
* @return The answer generated by LeMUR.
42+
* @return The answer generated by LeMUR
4343
*/
4444
@JsonProperty("answer")
4545
public String getAnswer() {
@@ -108,7 +108,7 @@ public Builder from(LemurQuestionAnswer other) {
108108
}
109109

110110
/**
111-
* <p>The question for LeMUR to answer.</p>
111+
* <p>The question for LeMUR to answer</p>
112112
* @return Reference to {@code this} so that method calls can be chained together.
113113
*/
114114
@Override
@@ -119,7 +119,7 @@ public AnswerStage question(String question) {
119119
}
120120

121121
/**
122-
* <p>The answer generated by LeMUR.</p>
122+
* <p>The answer generated by LeMUR</p>
123123
* @return Reference to {@code this} so that method calls can be chained together.
124124
*/
125125
@Override

‎src/main/java/com/assemblyai/api/types/LemurQuestionAnswerResponse.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public String getRequestId() {
4444
}
4545

4646
/**
47-
* @return The answers generated by LeMUR and their questions.
47+
* @return The answers generated by LeMUR and their questions
4848
*/
4949
@JsonProperty("response")
5050
public List<LemurQuestionAnswer> getResponse() {
@@ -126,7 +126,7 @@ public _FinalStage requestId(String requestId) {
126126
}
127127

128128
/**
129-
* <p>The answers generated by LeMUR and their questions.</p>
129+
* <p>The answers generated by LeMUR and their questions</p>
130130
* @return Reference to {@code this} so that method calls can be chained together.
131131
*/
132132
@Override
@@ -136,7 +136,7 @@ public _FinalStage addAllResponse(List<LemurQuestionAnswer> response) {
136136
}
137137

138138
/**
139-
* <p>The answers generated by LeMUR and their questions.</p>
139+
* <p>The answers generated by LeMUR and their questions</p>
140140
* @return Reference to {@code this} so that method calls can be chained together.
141141
*/
142142
@Override

‎src/main/java/com/assemblyai/api/types/LemurSummaryResponse.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public String getRequestId() {
4040
}
4141

4242
/**
43-
* @return The response generated by LeMUR.
43+
* @return The response generated by LeMUR
4444
*/
4545
@JsonProperty("response")
4646
public String getResponse() {
@@ -120,7 +120,7 @@ public ResponseStage requestId(String requestId) {
120120
}
121121

122122
/**
123-
* <p>The response generated by LeMUR.</p>
123+
* <p>The response generated by LeMUR</p>
124124
* @return Reference to {@code this} so that method calls can be chained together.
125125
*/
126126
@Override

‎src/main/java/com/assemblyai/api/types/LemurTaskResponse.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public String getRequestId() {
4040
}
4141

4242
/**
43-
* @return The response generated by LeMUR.
43+
* @return The response generated by LeMUR
4444
*/
4545
@JsonProperty("response")
4646
public String getResponse() {
@@ -120,7 +120,7 @@ public ResponseStage requestId(String requestId) {
120120
}
121121

122122
/**
123-
* <p>The response generated by LeMUR.</p>
123+
* <p>The response generated by LeMUR</p>
124124
* @return Reference to {@code this} so that method calls can be chained together.
125125
*/
126126
@Override

‎src/main/java/com/assemblyai/api/types/PartialTranscript.java

+16-13
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ private PartialTranscript(
5353
}
5454

5555
/**
56-
* @return Start time of audio sample relative to session start, in milliseconds.
56+
* @return Start time of audio sample relative to session start, in milliseconds
5757
*/
5858
@JsonProperty("audio_start")
5959
@Override
@@ -62,7 +62,7 @@ public int getAudioStart() {
6262
}
6363

6464
/**
65-
* @return End time of audio sample relative to session start, in milliseconds.
65+
* @return End time of audio sample relative to session start, in milliseconds
6666
*/
6767
@JsonProperty("audio_end")
6868
@Override
@@ -71,7 +71,7 @@ public int getAudioEnd() {
7171
}
7272

7373
/**
74-
* @return The confidence score of the entire transcription, between 0 and 1.
74+
* @return The confidence score of the entire transcription, between 0 and 1
7575
*/
7676
@JsonProperty("confidence")
7777
@Override
@@ -80,7 +80,7 @@ public double getConfidence() {
8080
}
8181

8282
/**
83-
* @return The partial transcript for your audio.
83+
* @return The partial transcript for your audio
8484
*/
8585
@JsonProperty("text")
8686
@Override
@@ -89,7 +89,8 @@ public String getText() {
8989
}
9090

9191
/**
92-
* @return An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).
92+
* @return An array of objects, with the information for each word in the transcription text.
93+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
9394
*/
9495
@JsonProperty("words")
9596
@Override
@@ -98,7 +99,7 @@ public List<Word> getWords() {
9899
}
99100

100101
/**
101-
* @return The timestamp for the partial transcript.
102+
* @return The timestamp for the partial transcript
102103
*/
103104
@JsonProperty("created")
104105
@Override
@@ -209,7 +210,7 @@ public Builder from(PartialTranscript other) {
209210
}
210211

211212
/**
212-
* <p>Start time of audio sample relative to session start, in milliseconds.</p>
213+
* <p>Start time of audio sample relative to session start, in milliseconds</p>
213214
* @return Reference to {@code this} so that method calls can be chained together.
214215
*/
215216
@Override
@@ -220,7 +221,7 @@ public AudioEndStage audioStart(int audioStart) {
220221
}
221222

222223
/**
223-
* <p>End time of audio sample relative to session start, in milliseconds.</p>
224+
* <p>End time of audio sample relative to session start, in milliseconds</p>
224225
* @return Reference to {@code this} so that method calls can be chained together.
225226
*/
226227
@Override
@@ -231,7 +232,7 @@ public ConfidenceStage audioEnd(int audioEnd) {
231232
}
232233

233234
/**
234-
* <p>The confidence score of the entire transcription, between 0 and 1.</p>
235+
* <p>The confidence score of the entire transcription, between 0 and 1</p>
235236
* @return Reference to {@code this} so that method calls can be chained together.
236237
*/
237238
@Override
@@ -242,7 +243,7 @@ public TextStage confidence(double confidence) {
242243
}
243244

244245
/**
245-
* <p>The partial transcript for your audio.</p>
246+
* <p>The partial transcript for your audio</p>
246247
* @return Reference to {@code this} so that method calls can be chained together.
247248
*/
248249
@Override
@@ -253,7 +254,7 @@ public CreatedStage text(String text) {
253254
}
254255

255256
/**
256-
* <p>The timestamp for the partial transcript.</p>
257+
* <p>The timestamp for the partial transcript</p>
257258
* @return Reference to {@code this} so that method calls can be chained together.
258259
*/
259260
@Override
@@ -264,7 +265,8 @@ public _FinalStage created(String created) {
264265
}
265266

266267
/**
267-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
268+
* <p>An array of objects, with the information for each word in the transcription text.
269+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
268270
* @return Reference to {@code this} so that method calls can be chained together.
269271
*/
270272
@Override
@@ -274,7 +276,8 @@ public _FinalStage addAllWords(List<Word> words) {
274276
}
275277

276278
/**
277-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
279+
* <p>An array of objects, with the information for each word in the transcription text.
280+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
278281
* @return Reference to {@code this} so that method calls can be chained together.
279282
*/
280283
@Override

‎src/main/java/com/assemblyai/api/types/PurgeLemurRequestDataResponse.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,23 @@ private PurgeLemurRequestDataResponse(
3535
}
3636

3737
/**
38-
* @return The ID of the LeMUR request
38+
* @return The ID of the deletion request of the LeMUR request
3939
*/
4040
@JsonProperty("request_id")
4141
public String getRequestId() {
4242
return requestId;
4343
}
4444

4545
/**
46-
* @return The ID of the deletion request of the LeMUR request
46+
* @return The ID of the LeMUR request to purge the data for
4747
*/
4848
@JsonProperty("request_id_to_purge")
4949
public String getRequestIdToPurge() {
5050
return requestIdToPurge;
5151
}
5252

5353
/**
54-
* @return Whether the request data was deleted.
54+
* @return Whether the request data was deleted
5555
*/
5656
@JsonProperty("deleted")
5757
public boolean getDeleted() {
@@ -129,7 +129,7 @@ public Builder from(PurgeLemurRequestDataResponse other) {
129129
}
130130

131131
/**
132-
* <p>The ID of the LeMUR request</p>
132+
* <p>The ID of the deletion request of the LeMUR request</p>
133133
* @return Reference to {@code this} so that method calls can be chained together.
134134
*/
135135
@Override
@@ -140,7 +140,7 @@ public RequestIdToPurgeStage requestId(String requestId) {
140140
}
141141

142142
/**
143-
* <p>The ID of the deletion request of the LeMUR request</p>
143+
* <p>The ID of the LeMUR request to purge the data for</p>
144144
* @return Reference to {@code this} so that method calls can be chained together.
145145
*/
146146
@Override
@@ -151,7 +151,7 @@ public DeletedStage requestIdToPurge(String requestIdToPurge) {
151151
}
152152

153153
/**
154-
* <p>Whether the request data was deleted.</p>
154+
* <p>Whether the request data was deleted</p>
155155
* @return Reference to {@code this} so that method calls can be chained together.
156156
*/
157157
@Override

‎src/main/java/com/assemblyai/api/types/RealtimeBaseMessage.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ private RealtimeBaseMessage(MessageType messageType, Map<String, Object> additio
2828
}
2929

3030
/**
31-
* @return Describes the type of the message.
31+
* @return Describes the type of the message
3232
*/
3333
@JsonProperty("message_type")
3434
@Override
@@ -91,7 +91,7 @@ public Builder from(RealtimeBaseMessage other) {
9191
}
9292

9393
/**
94-
* <p>Describes the type of the message.</p>
94+
* <p>Describes the type of the message</p>
9595
* @return Reference to {@code this} so that method calls can be chained together.
9696
*/
9797
@Override

‎src/main/java/com/assemblyai/api/types/RealtimeBaseTranscript.java

+16-13
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ private RealtimeBaseTranscript(
5353
}
5454

5555
/**
56-
* @return Start time of audio sample relative to session start, in milliseconds.
56+
* @return Start time of audio sample relative to session start, in milliseconds
5757
*/
5858
@JsonProperty("audio_start")
5959
@Override
@@ -62,7 +62,7 @@ public int getAudioStart() {
6262
}
6363

6464
/**
65-
* @return End time of audio sample relative to session start, in milliseconds.
65+
* @return End time of audio sample relative to session start, in milliseconds
6666
*/
6767
@JsonProperty("audio_end")
6868
@Override
@@ -71,7 +71,7 @@ public int getAudioEnd() {
7171
}
7272

7373
/**
74-
* @return The confidence score of the entire transcription, between 0 and 1.
74+
* @return The confidence score of the entire transcription, between 0 and 1
7575
*/
7676
@JsonProperty("confidence")
7777
@Override
@@ -80,7 +80,7 @@ public double getConfidence() {
8080
}
8181

8282
/**
83-
* @return The partial transcript for your audio.
83+
* @return The partial transcript for your audio
8484
*/
8585
@JsonProperty("text")
8686
@Override
@@ -89,7 +89,8 @@ public String getText() {
8989
}
9090

9191
/**
92-
* @return An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).
92+
* @return An array of objects, with the information for each word in the transcription text.
93+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
9394
*/
9495
@JsonProperty("words")
9596
@Override
@@ -98,7 +99,7 @@ public List<Word> getWords() {
9899
}
99100

100101
/**
101-
* @return The timestamp for the partial transcript.
102+
* @return The timestamp for the partial transcript
102103
*/
103104
@JsonProperty("created")
104105
@Override
@@ -204,7 +205,7 @@ public Builder from(RealtimeBaseTranscript other) {
204205
}
205206

206207
/**
207-
* <p>Start time of audio sample relative to session start, in milliseconds.</p>
208+
* <p>Start time of audio sample relative to session start, in milliseconds</p>
208209
* @return Reference to {@code this} so that method calls can be chained together.
209210
*/
210211
@Override
@@ -215,7 +216,7 @@ public AudioEndStage audioStart(int audioStart) {
215216
}
216217

217218
/**
218-
* <p>End time of audio sample relative to session start, in milliseconds.</p>
219+
* <p>End time of audio sample relative to session start, in milliseconds</p>
219220
* @return Reference to {@code this} so that method calls can be chained together.
220221
*/
221222
@Override
@@ -226,7 +227,7 @@ public ConfidenceStage audioEnd(int audioEnd) {
226227
}
227228

228229
/**
229-
* <p>The confidence score of the entire transcription, between 0 and 1.</p>
230+
* <p>The confidence score of the entire transcription, between 0 and 1</p>
230231
* @return Reference to {@code this} so that method calls can be chained together.
231232
*/
232233
@Override
@@ -237,7 +238,7 @@ public TextStage confidence(double confidence) {
237238
}
238239

239240
/**
240-
* <p>The partial transcript for your audio.</p>
241+
* <p>The partial transcript for your audio</p>
241242
* @return Reference to {@code this} so that method calls can be chained together.
242243
*/
243244
@Override
@@ -248,7 +249,7 @@ public CreatedStage text(String text) {
248249
}
249250

250251
/**
251-
* <p>The timestamp for the partial transcript.</p>
252+
* <p>The timestamp for the partial transcript</p>
252253
* @return Reference to {@code this} so that method calls can be chained together.
253254
*/
254255
@Override
@@ -259,7 +260,8 @@ public _FinalStage created(String created) {
259260
}
260261

261262
/**
262-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
263+
* <p>An array of objects, with the information for each word in the transcription text.
264+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
263265
* @return Reference to {@code this} so that method calls can be chained together.
264266
*/
265267
@Override
@@ -269,7 +271,8 @@ public _FinalStage addAllWords(List<Word> words) {
269271
}
270272

271273
/**
272-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
274+
* <p>An array of objects, with the information for each word in the transcription text.
275+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
273276
* @return Reference to {@code this} so that method calls can be chained together.
274277
*/
275278
@Override

‎src/main/java/com/assemblyai/api/types/SessionBegins.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ public String getMessageType() {
3636
}
3737

3838
/**
39-
* @return Unique identifier for the established session.
39+
* @return Unique identifier for the established session
4040
*/
4141
@JsonProperty("session_id")
4242
public String getSessionId() {
4343
return sessionId;
4444
}
4545

4646
/**
47-
* @return Timestamp when this session will expire.
47+
* @return Timestamp when this session will expire
4848
*/
4949
@JsonProperty("expires_at")
5050
public String getExpiresAt() {
@@ -113,7 +113,7 @@ public Builder from(SessionBegins other) {
113113
}
114114

115115
/**
116-
* <p>Unique identifier for the established session.</p>
116+
* <p>Unique identifier for the established session</p>
117117
* @return Reference to {@code this} so that method calls can be chained together.
118118
*/
119119
@Override
@@ -124,7 +124,7 @@ public ExpiresAtStage sessionId(String sessionId) {
124124
}
125125

126126
/**
127-
* <p>Timestamp when this session will expire.</p>
127+
* <p>Timestamp when this session will expire</p>
128128
* @return Reference to {@code this} so that method calls can be chained together.
129129
*/
130130
@Override

‎src/main/java/com/assemblyai/api/types/TerminateSession.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ private TerminateSession(
3232
}
3333

3434
/**
35-
* @return Describes the type of the message.
35+
* @return Describes the type of the message
3636
*/
3737
@JsonProperty("message_type")
3838
@Override
@@ -41,7 +41,7 @@ public MessageType getMessageType() {
4141
}
4242

4343
/**
44-
* @return A boolean value to communicate that you wish to end your real-time session forever.
44+
* @return Set to true to end your real-time session forever
4545
*/
4646
@JsonProperty("terminate_session")
4747
public boolean getTerminateSession() {
@@ -110,7 +110,7 @@ public Builder from(TerminateSession other) {
110110
}
111111

112112
/**
113-
* <p>Describes the type of the message.</p>
113+
* <p>Describes the type of the message</p>
114114
* @return Reference to {@code this} so that method calls can be chained together.
115115
*/
116116
@Override
@@ -121,7 +121,7 @@ public TerminateSessionStage messageType(MessageType messageType) {
121121
}
122122

123123
/**
124-
* <p>A boolean value to communicate that you wish to end your real-time session forever.</p>
124+
* <p>Set to true to end your real-time session forever</p>
125125
* @return Reference to {@code this} so that method calls can be chained together.
126126
*/
127127
@Override

‎src/main/java/com/assemblyai/api/types/TranscriptIabCategoriesResult.java ‎src/main/java/com/assemblyai/api/types/TopicDetectionModelResult.java

+15-15
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
import java.util.Objects;
2121

2222
@JsonInclude(JsonInclude.Include.NON_EMPTY)
23-
@JsonDeserialize(builder = TranscriptIabCategoriesResult.Builder.class)
24-
public final class TranscriptIabCategoriesResult {
23+
@JsonDeserialize(builder = TopicDetectionModelResult.Builder.class)
24+
public final class TopicDetectionModelResult {
2525
private final AudioIntelligenceModelStatus status;
2626

2727
private final List<TopicDetectionResult> results;
@@ -30,7 +30,7 @@ public final class TranscriptIabCategoriesResult {
3030

3131
private final Map<String, Object> additionalProperties;
3232

33-
private TranscriptIabCategoriesResult(
33+
private TopicDetectionModelResult(
3434
AudioIntelligenceModelStatus status,
3535
List<TopicDetectionResult> results,
3636
Map<String, Double> summary,
@@ -42,15 +42,15 @@ private TranscriptIabCategoriesResult(
4242
}
4343

4444
/**
45-
* @return Will be either success, or unavailable in the rare case that the Content Moderation model failed.
45+
* @return The status of the Topic Detection model. Either success, or unavailable in the rare case that the model failed.
4646
*/
4747
@JsonProperty("status")
4848
public AudioIntelligenceModelStatus getStatus() {
4949
return status;
5050
}
5151

5252
/**
53-
* @return An array of results for the Topic Detection model.
53+
* @return An array of results for the Topic Detection model
5454
*/
5555
@JsonProperty("results")
5656
public List<TopicDetectionResult> getResults() {
@@ -68,15 +68,15 @@ public Map<String, Double> getSummary() {
6868
@Override
6969
public boolean equals(Object other) {
7070
if (this == other) return true;
71-
return other instanceof TranscriptIabCategoriesResult && equalTo((TranscriptIabCategoriesResult) other);
71+
return other instanceof TopicDetectionModelResult && equalTo((TopicDetectionModelResult) other);
7272
}
7373

7474
@JsonAnyGetter
7575
public Map<String, Object> getAdditionalProperties() {
7676
return this.additionalProperties;
7777
}
7878

79-
private boolean equalTo(TranscriptIabCategoriesResult other) {
79+
private boolean equalTo(TopicDetectionModelResult other) {
8080
return status.equals(other.status) && results.equals(other.results) && summary.equals(other.summary);
8181
}
8282

@@ -97,11 +97,11 @@ public static StatusStage builder() {
9797
public interface StatusStage {
9898
_FinalStage status(AudioIntelligenceModelStatus status);
9999

100-
Builder from(TranscriptIabCategoriesResult other);
100+
Builder from(TopicDetectionModelResult other);
101101
}
102102

103103
public interface _FinalStage {
104-
TranscriptIabCategoriesResult build();
104+
TopicDetectionModelResult build();
105105

106106
_FinalStage results(List<TopicDetectionResult> results);
107107

@@ -130,15 +130,15 @@ public static final class Builder implements StatusStage, _FinalStage {
130130
private Builder() {}
131131

132132
@Override
133-
public Builder from(TranscriptIabCategoriesResult other) {
133+
public Builder from(TopicDetectionModelResult other) {
134134
status(other.getStatus());
135135
results(other.getResults());
136136
summary(other.getSummary());
137137
return this;
138138
}
139139

140140
/**
141-
* <p>Will be either success, or unavailable in the rare case that the Content Moderation model failed.</p>
141+
* <p>The status of the Topic Detection model. Either success, or unavailable in the rare case that the model failed.</p>
142142
* @return Reference to {@code this} so that method calls can be chained together.
143143
*/
144144
@Override
@@ -177,7 +177,7 @@ public _FinalStage summary(Map<String, Double> summary) {
177177
}
178178

179179
/**
180-
* <p>An array of results for the Topic Detection model.</p>
180+
* <p>An array of results for the Topic Detection model</p>
181181
* @return Reference to {@code this} so that method calls can be chained together.
182182
*/
183183
@Override
@@ -187,7 +187,7 @@ public _FinalStage addAllResults(List<TopicDetectionResult> results) {
187187
}
188188

189189
/**
190-
* <p>An array of results for the Topic Detection model.</p>
190+
* <p>An array of results for the Topic Detection model</p>
191191
* @return Reference to {@code this} so that method calls can be chained together.
192192
*/
193193
@Override
@@ -205,8 +205,8 @@ public _FinalStage results(List<TopicDetectionResult> results) {
205205
}
206206

207207
@Override
208-
public TranscriptIabCategoriesResult build() {
209-
return new TranscriptIabCategoriesResult(status, results, summary, additionalProperties);
208+
public TopicDetectionModelResult build() {
209+
return new TopicDetectionModelResult(status, results, summary, additionalProperties);
210210
}
211211
}
212212
}

‎src/main/java/com/assemblyai/api/types/Transcript.java

+82-109
Large diffs are not rendered by default.

‎src/main/java/com/assemblyai/api/types/TranscriptListRequestStatus.java

+7-7
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ public final class TranscriptListRequestStatus {
1111

1212
public static final TranscriptListRequestStatus QUEUED = new TranscriptListRequestStatus(Value.QUEUED, "queued");
1313

14-
public static final TranscriptListRequestStatus PROCESSING =
15-
new TranscriptListRequestStatus(Value.PROCESSING, "processing");
16-
1714
public static final TranscriptListRequestStatus COMPLETED =
1815
new TranscriptListRequestStatus(Value.COMPLETED, "completed");
1916

17+
public static final TranscriptListRequestStatus PROCESSING =
18+
new TranscriptListRequestStatus(Value.PROCESSING, "processing");
19+
2020
private final Value value;
2121

2222
private final String string;
@@ -54,10 +54,10 @@ public <T> T visit(Visitor<T> visitor) {
5454
return visitor.visitError();
5555
case QUEUED:
5656
return visitor.visitQueued();
57-
case PROCESSING:
58-
return visitor.visitProcessing();
5957
case COMPLETED:
6058
return visitor.visitCompleted();
59+
case PROCESSING:
60+
return visitor.visitProcessing();
6161
case UNKNOWN:
6262
default:
6363
return visitor.visitUnknown(string);
@@ -71,10 +71,10 @@ public static TranscriptListRequestStatus valueOf(String value) {
7171
return ERROR;
7272
case "queued":
7373
return QUEUED;
74-
case "processing":
75-
return PROCESSING;
7674
case "completed":
7775
return COMPLETED;
76+
case "processing":
77+
return PROCESSING;
7878
default:
7979
return new TranscriptListRequestStatus(Value.UNKNOWN, value);
8080
}

‎src/main/java/com/assemblyai/api/types/TranscriptStatus.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ public final class TranscriptStatus {
1111

1212
public static final TranscriptStatus QUEUED = new TranscriptStatus(Value.QUEUED, "queued");
1313

14-
public static final TranscriptStatus PROCESSING = new TranscriptStatus(Value.PROCESSING, "processing");
15-
1614
public static final TranscriptStatus COMPLETED = new TranscriptStatus(Value.COMPLETED, "completed");
1715

16+
public static final TranscriptStatus PROCESSING = new TranscriptStatus(Value.PROCESSING, "processing");
17+
1818
private final Value value;
1919

2020
private final String string;
@@ -51,10 +51,10 @@ public <T> T visit(Visitor<T> visitor) {
5151
return visitor.visitError();
5252
case QUEUED:
5353
return visitor.visitQueued();
54-
case PROCESSING:
55-
return visitor.visitProcessing();
5654
case COMPLETED:
5755
return visitor.visitCompleted();
56+
case PROCESSING:
57+
return visitor.visitProcessing();
5858
case UNKNOWN:
5959
default:
6060
return visitor.visitUnknown(string);
@@ -68,10 +68,10 @@ public static TranscriptStatus valueOf(String value) {
6868
return ERROR;
6969
case "queued":
7070
return QUEUED;
71-
case "processing":
72-
return PROCESSING;
7371
case "completed":
7472
return COMPLETED;
73+
case "processing":
74+
return PROCESSING;
7575
default:
7676
return new TranscriptStatus(Value.UNKNOWN, value);
7777
}

0 commit comments

Comments
 (0)
Please sign in to comment.