Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add default RequestOptions.timeout of 300 seconds #170

Merged
merged 2 commits into from
May 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions Sources/GoogleAI/GenerativeAIRequest.swift
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@ public struct RequestOptions {
/// Initializes a request options object.
///
/// - Parameters:
/// - timeout The request’s timeout interval in seconds; if not specified uses the default value
/// for a `URLRequest`.
/// - apiVersion The API version to use in requests to the backend; defaults to "v1beta".
public init(timeout: TimeInterval? = nil, apiVersion: String = "v1beta") {
/// - timeout: The request’s timeout interval in seconds; defaults to 300 seconds (5 minutes).
/// - apiVersion: The API version to use in requests to the backend; defaults to "v1beta".
public init(timeout: TimeInterval? = 300.0, apiVersion: String = "v1beta") {
andrewheard marked this conversation as resolved.
Show resolved Hide resolved
self.timeout = timeout
self.apiVersion = apiVersion
}
Expand Down
78 changes: 75 additions & 3 deletions Tests/GoogleAITests/GenerativeModelTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -611,6 +611,27 @@ final class GenerativeModelTests: XCTestCase {
XCTAssertEqual(response.candidates.count, 1)
}

func testGenerateContent_requestOptions_nilTimeout() async throws {
let expectedTimeout: TimeInterval? = nil
MockURLProtocol
.requestHandler = try httpRequestHandler(
forResource: "unary-success-basic-reply-short",
withExtension: "json",
timeout: expectedTimeout
)
let requestOptions = RequestOptions(timeout: expectedTimeout)
model = GenerativeModel(
name: "my-model",
apiKey: "API_KEY",
requestOptions: requestOptions,
urlSession: urlSession
)

let response = try await model.generateContent(testPrompt)

XCTAssertEqual(response.candidates.count, 1)
}

// MARK: - Generate Content (Streaming)

func testGenerateContentStream_failureInvalidAPIKey() async throws {
Expand Down Expand Up @@ -967,6 +988,32 @@ final class GenerativeModelTests: XCTestCase {
XCTAssertEqual(responses, 1)
}

func testGenerateContentStream_requestOptions_nilTimeout() async throws {
let expectedTimeout: TimeInterval? = nil
MockURLProtocol
.requestHandler = try httpRequestHandler(
forResource: "streaming-success-basic-reply-short",
withExtension: "txt",
timeout: expectedTimeout
)
let requestOptions = RequestOptions(timeout: expectedTimeout)
model = GenerativeModel(
name: "my-model",
apiKey: "API_KEY",
requestOptions: requestOptions,
urlSession: urlSession
)

var responses = 0
let stream = model.generateContentStream(testPrompt)
for try await content in stream {
XCTAssertNotNil(content.text)
responses += 1
}

XCTAssertEqual(responses, 1)
}

// MARK: - Count Tokens

func testCountTokens_succeeds() async throws {
Expand Down Expand Up @@ -1019,6 +1066,27 @@ final class GenerativeModelTests: XCTestCase {
XCTAssertEqual(response.totalTokens, 6)
}

func testCountTokens_requestOptions_nilTimeout() async throws {
let expectedTimeout: TimeInterval? = nil
MockURLProtocol
.requestHandler = try httpRequestHandler(
forResource: "success-total-tokens",
withExtension: "json",
timeout: expectedTimeout
)
let requestOptions = RequestOptions(timeout: expectedTimeout)
model = GenerativeModel(
name: "my-model",
apiKey: "API_KEY",
requestOptions: requestOptions,
urlSession: urlSession
)

let response = try await model.countTokens(testPrompt)

XCTAssertEqual(response.totalTokens, 6)
}

// MARK: - Model Resource Name

func testModelResourceName_noPrefix() async throws {
Expand Down Expand Up @@ -1067,16 +1135,20 @@ final class GenerativeModelTests: XCTestCase {
private func httpRequestHandler(forResource name: String,
withExtension ext: String,
statusCode: Int = 200,
timeout: TimeInterval = URLRequest
.defaultTimeoutInterval()) throws -> ((URLRequest) throws -> (
timeout: TimeInterval? = RequestOptions()
.timeout) throws -> ((URLRequest) throws -> (
URLResponse,
AsyncLineSequence<URL.AsyncBytes>?
)) {
let fileURL = try XCTUnwrap(Bundle.module.url(forResource: name, withExtension: ext))
return { request in
let requestURL = try XCTUnwrap(request.url)
XCTAssertEqual(requestURL.path.occurrenceCount(of: "models/"), 1)
XCTAssertEqual(request.timeoutInterval, timeout)
if let timeout {
XCTAssertEqual(request.timeoutInterval, timeout)
} else {
XCTAssertEqual(request.timeoutInterval, URLRequest.defaultTimeoutInterval())
}
let response = try XCTUnwrap(HTTPURLResponse(
url: requestURL,
statusCode: statusCode,
Expand Down
Loading