Merge pull request #124 from AssemblyAI/fern-bot/10-03-2024-0606PM

🌿 Fern Regeneration -- October 3, 2024

Author: Swimburger

build.gradle

@@ -47,7 +47,7 @@ publishing {
         maven(MavenPublication) {
             groupId = 'com.assemblyai'
             artifactId = 'assemblyai-java'
-            version = '2.3.1'
+            version = '3.0.0'
             from components.java
             pom {
                 scm {

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -128,7 +128,7 @@ public static void main(String... args) throws IOException, InterruptedException
         System.out.println("Delete transcript. " + transcript);
 
         File file = new File("sample-app/src/main/resources/nZP7pb_t4oA.mp3");
-        UploadedFile uploadedFile = client.files().upload(Files.readAllBytes(file.toPath()));
+        UploadedFile uploadedFile = client.files().upload(file);
         System.out.println("Uploaded file" + uploadedFile);
 
         transcript = client.transcripts().submit(TranscriptParams.builder()

sample-app/src/main/java/sample/App.java

@@ -13,7 +13,7 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.nio.file.Files;
+import java.io.InputStream;
 import java.nio.file.Path;
 import java.util.List;
 
@@ -29,6 +29,58 @@ public PollingTranscriptsClient(ClientOptions clientOptions, AssemblyAI client)
         this.client = client;
     }
 
+    /**
+     * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
+     *
+     * @param file Audio file to transcribe
+     * @return Queued transcript
+     * @throws IOException The file will be read and an IOException may be thrown.
+     */
+    public Transcript submit(InputStream file) throws IOException {
+        return submit(file, EMPTY_PARAMS, null);
+    }
+
+    /**
+     * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
+     *
+     * @param file           Audio file to transcribe
+     * @param requestOptions The HTTP request options
+     * @return Queued transcript
+     * @throws IOException The file will be read and an IOException may be thrown.
+     */
+    public Transcript submit(InputStream file, RequestOptions requestOptions) throws IOException {
+        return submit(file, EMPTY_PARAMS, requestOptions);
+    }
+
+    /**
+     * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
+     *
+     * @param file             Audio file to transcribe
+     * @param transcriptParams The parameters to transcribe an audio file.
+     * @return Queued transcript
+     * @throws IOException The file will be read and an IOException may be thrown.
+     */
+    public Transcript submit(InputStream file, TranscriptOptionalParams transcriptParams) throws IOException {
+        return submit(file, transcriptParams, null);
+    }
+
+    /**
+     * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
+     *
+     * @param file             Audio file to transcribe
+     * @param transcriptParams The parameters to transcribe an audio file.
+     * @param requestOptions   The HTTP request options
+     * @return Queued transcript
+     */
+    public Transcript submit(
+            InputStream file,
+            TranscriptOptionalParams transcriptParams,
+            RequestOptions requestOptions
+    ) {
+        UploadedFile uploadedFile = client.files().upload(file, requestOptions);
+        return submit(uploadedFile.getUploadUrl(), transcriptParams, requestOptions);
+    }
+
     /**
      * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
      *
@@ -245,6 +297,56 @@ public Transcript submit(String url, TranscriptOptionalParams transcriptParams,
         return super.submit(fullTranscriptParams, requestOptions);
     }
 
+    /**
+     * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
+     *
+     * @param file Audio file to transcribe
+     * @return A transcript with status "completed" or "error"
+     * @throws IOException The file will be read and an IOException may be thrown.
+     */
+    public Transcript transcribe(InputStream file) throws IOException {
+        return transcribe(file, EMPTY_PARAMS, null);
+    }
+
+    /**
+     * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
+     *
+     * @param file           Audio file to transcribe
+     * @param requestOptions The HTTP request options
+     * @return A transcript with status "completed" or "error"
+     * @throws IOException The file will be read and an IOException may be thrown.
+     */
+    public Transcript transcribe(InputStream file, RequestOptions requestOptions) throws IOException {
+        return transcribe(file, EMPTY_PARAMS, requestOptions);
+    }
+
+    /**
+     * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
+     *
+     * @param file             Audio file to transcribe
+     * @param transcriptParams The parameters to transcribe an audio file.
+     * @return A transcript with status "completed" or "error"
+     * @throws IOException The file will be read and an IOException may be thrown.
+     */
+    public Transcript transcribe(InputStream file, TranscriptOptionalParams transcriptParams) throws IOException {
+        UploadedFile uploadedFile = client.files().upload(file);
+        return transcribe(uploadedFile.getUploadUrl(), transcriptParams, null);
+    }
+
+    /**
+     * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
+     *
+     * @param file             Audio file to transcribe
+     * @param transcriptParams The parameters to transcribe an audio file.
+     * @param requestOptions   The HTTP request options
+     * @return A transcript with status "completed" or "error"
+     * @throws IOException The file will be read and an IOException may be thrown.
+     */
+    public Transcript transcribe(InputStream file, TranscriptOptionalParams transcriptParams, RequestOptions requestOptions) throws IOException {
+        UploadedFile uploadedFile = client.files().upload(file, requestOptions);
+        return transcribe(uploadedFile.getUploadUrl(), transcriptParams, requestOptions);
+    }
+
     /**
      * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
      *
@@ -344,7 +446,7 @@ public Transcript transcribe(
             TranscriptOptionalParams transcriptParams,
             RequestOptions requestOptions
     ) throws IOException {
-        UploadedFile uploadedFile = client.files().upload(Files.readAllBytes(file.toPath()), requestOptions);
+        UploadedFile uploadedFile = client.files().upload(file, requestOptions);
         return transcribe(uploadedFile.getUploadUrl(), transcriptParams, requestOptions);
     }
 

src/main/java/com/assemblyai/api/PollingTranscriptsClient.java

@@ -1,5 +1,5 @@
 package com.assemblyai.api.core;
 
 public class Constants {
-    public static final String SDK_VERSION = "2.3.1";
+    public static final String SDK_VERSION = "3.0.0";
 }

src/main/java/com/assemblyai/api/core/Constants.java

@@ -0,0 +1,60 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+package com.assemblyai.api.core;
+
+import java.io.InputStream;
+import java.util.Objects;
+import okhttp3.MediaType;
+import okhttp3.RequestBody;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Represents a file stream with associated metadata for file uploads.
+ */
+public class FileStream {
+    private final InputStream inputStream;
+    private final String fileName;
+    private final MediaType contentType;
+
+    /**
+     * Constructs a FileStream with the given input stream and optional metadata.
+     *
+     * @param inputStream The input stream of the file content. Must not be null.
+     * @param fileName The name of the file, or null if unknown.
+     * @param contentType The MIME type of the file content, or null if unknown.
+     * @throws NullPointerException if inputStream is null
+     */
+    public FileStream(InputStream inputStream, @Nullable String fileName, @Nullable MediaType contentType) {
+        this.inputStream = Objects.requireNonNull(inputStream, "Input stream cannot be null");
+        this.fileName = fileName;
+        this.contentType = contentType;
+    }
+
+    public FileStream(InputStream inputStream) {
+        this(inputStream, null, null);
+    }
+
+    public InputStream getInputStream() {
+        return inputStream;
+    }
+
+    @Nullable
+    public String getFileName() {
+        return fileName;
+    }
+
+    @Nullable
+    public MediaType getContentType() {
+        return contentType;
+    }
+
+    /**
+     * Creates a RequestBody suitable for use with OkHttp client.
+     *
+     * @return A RequestBody instance representing this file stream.
+     */
+    public RequestBody toRequestBody() {
+        return new InputStreamRequestBody(contentType, inputStream);
+    }
+}

src/main/java/com/assemblyai/api/core/FileStream.java

@@ -0,0 +1,79 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+package com.assemblyai.api.core;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Objects;
+import okhttp3.MediaType;
+import okhttp3.RequestBody;
+import okhttp3.internal.Util;
+import okio.BufferedSink;
+import okio.Okio;
+import okio.Source;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * A custom implementation of OkHttp's RequestBody that wraps an InputStream.
+ * This class allows streaming of data from an InputStream directly to an HTTP request body,
+ * which is useful for file uploads or sending large amounts of data without loading it all into memory.
+ */
+public class InputStreamRequestBody extends RequestBody {
+    private final InputStream inputStream;
+    private final MediaType contentType;
+
+    /**
+     * Constructs an InputStreamRequestBody with the specified content type and input stream.
+     *
+     * @param contentType the MediaType of the content, or null if not known
+     * @param inputStream the InputStream containing the data to be sent
+     * @throws NullPointerException if inputStream is null
+     */
+    public InputStreamRequestBody(@Nullable MediaType contentType, InputStream inputStream) {
+        this.contentType = contentType;
+        this.inputStream = Objects.requireNonNull(inputStream, "inputStream == null");
+    }
+
+    /**
+     * Returns the content type of this request body.
+     *
+     * @return the MediaType of the content, or null if not specified
+     */
+    @Nullable
+    @Override
+    public MediaType contentType() {
+        return contentType;
+    }
+
+    /**
+     * Returns the content length of this request body, if known.
+     * This method attempts to determine the length using the InputStream's available() method,
+     * which may not always accurately reflect the total length of the stream.
+     *
+     * @return the content length, or -1 if the length is unknown
+     * @throws IOException if an I/O error occurs
+     */
+    @Override
+    public long contentLength() throws IOException {
+        return inputStream.available() == 0 ? -1 : inputStream.available();
+    }
+
+    /**
+     * Writes the content of the InputStream to the given BufferedSink.
+     * This method is responsible for transferring the data from the InputStream to the network request.
+     *
+     * @param sink the BufferedSink to write the content to
+     * @throws IOException if an I/O error occurs during writing
+     */
+    @Override
+    public void writeTo(BufferedSink sink) throws IOException {
+        Source source = null;
+        try {
+            source = Okio.source(inputStream);
+            sink.writeAll(source);
+        } finally {
+            Util.closeQuietly(Objects.requireNonNull(source));
+        }
+    }
+}

src/main/java/com/assemblyai/api/core/InputStreamRequestBody.java

@@ -7,6 +7,7 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
 
 public class ExtendedFilesClient extends FilesClient {
     public ExtendedFilesClient(ClientOptions clientOptions) {
@@ -38,6 +39,6 @@ public UploadedFile upload(Path filePath) throws IOException {
      * Upload a media file to AssemblyAI's servers.
      */
     public UploadedFile upload(Path filePath, RequestOptions requestOptions) throws IOException {
-        return upload(Files.readAllBytes(filePath), requestOptions);
+        return upload(Files.newInputStream(filePath, StandardOpenOption.READ), requestOptions);
     }
 }

src/main/java/com/assemblyai/api/resources/files/ExtendedFilesClient.java

@@ -6,6 +6,7 @@
 import com.assemblyai.api.core.AssemblyAIApiException;
 import com.assemblyai.api.core.AssemblyAIException;
 import com.assemblyai.api.core.ClientOptions;
+import com.assemblyai.api.core.InputStreamRequestBody;
 import com.assemblyai.api.core.ObjectMappers;
 import com.assemblyai.api.core.RequestOptions;
 import com.assemblyai.api.errors.BadRequestError;
@@ -18,9 +19,12 @@
 import com.assemblyai.api.resources.files.types.UploadedFile;
 import com.assemblyai.api.types.Error;
 import com.fasterxml.jackson.core.JsonProcessingException;
+import java.io.ByteArrayInputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import okhttp3.Headers;
 import okhttp3.HttpUrl;
+import okhttp3.MediaType;
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
 import okhttp3.RequestBody;
@@ -37,24 +41,23 @@ public FilesClient(ClientOptions clientOptions) {
     /**
      * Upload a media file to AssemblyAI's servers.
      */
-    public UploadedFile upload(byte[] request) {
+    public UploadedFile upload(InputStream request) {
         return upload(request, null);
     }
 
     /**
      * Upload a media file to AssemblyAI's servers.
      */
-    public UploadedFile upload(byte[] request, RequestOptions requestOptions) {
+    public UploadedFile upload(InputStream request, RequestOptions requestOptions) {
         HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl())
                 .newBuilder()
                 .addPathSegments("v2/upload")
                 .build();
-        RequestBody body = RequestBody.create(request);
+        RequestBody body = new InputStreamRequestBody(MediaType.parse("application/octet-stream"), request);
         Request okhttpRequest = new Request.Builder()
                 .url(httpUrl)
                 .method("POST", body)
                 .headers(Headers.of(clientOptions.headers(requestOptions)))
-                .addHeader("Content-Type", "application/octet-stream")
                 .build();
         OkHttpClient client = clientOptions.httpClient();
         if (requestOptions != null && requestOptions.getTimeout().isPresent()) {
@@ -99,4 +102,18 @@ public UploadedFile upload(byte[] request, RequestOptions requestOptions) {
             throw new AssemblyAIException("Network error executing HTTP request", e);
         }
     }
+
+    /**
+     * Upload a media file to AssemblyAI's servers.
+     */
+    public UploadedFile upload(byte[] request) {
+        return upload(new ByteArrayInputStream(request));
+    }
+
+    /**
+     * Upload a media file to AssemblyAI's servers.
+     */
+    public UploadedFile upload(byte[] request, RequestOptions requestOptions) {
+        return upload(new ByteArrayInputStream(request), requestOptions);
+    }
 }