mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Add function calling (tool calling) support to GeminiLanguageModel
conforming to Apple's FoundationModels framework.
* Add .toolCalling capability to GeminiLanguageModel.
* Translate FoundationModels ToolDefinition into Gemini Tool and
FunctionDeclaration using OpenAPI parametersJsonSchema.
* Map GenerationOptions.ToolCallingMode (.allowed, .required,
.disallowed) to Gemini FunctionCallingConfig.Mode.
* Stream function calls in GeminiLanguageModelExecutor, forwarding
JSON-encoded arguments or empty fallback "{}" into channel actions.
* Translate Transcript tool calls and tool outputs into Gemini Content
parts, preserving thought signatures from reasoning models and
flushing buffered reasoning thoughts cleanly.
* Unpack structured tool responses and wrap scalar text tool outputs
under the result field.
* Support parameterless tools with empty arguments across request
schema translation, model response handling, and transcript history.
* Add unit tests across GeminiLanguageModel, GeminiRequestTranslator,
and GeminiTranscriptTranslator.
* Add end-to-end integration tests covering single-turn, sequential,
parallel, disallowed, parameterless, and reasoning tool calling
across all supported backends.
GeminiLanguageModel Integration Tests
End-to-end integration tests validating GeminiLanguageModel sessions against
remote Gemini and Firebase AI Logic backends.
Quick Start
# Run integration tests (using environment variables or GoogleService-Info.plist)
swift test --filter IntegrationTests
# Run a specific integration test suite
swift test --filter ToolCallingIntegrationTests
# Run all unit tests (fast, skips all integration tests)
swift test --skip Integration
Running Integration Tests
Integration tests in this directory connect to Google Cloud or Firebase endpoints when credentials are configured:
- Gemini Developer API:
Set
GEMINI_API_KEYorGOOGLE_API_KEYin your environment. - Firebase AI Logic:
Provide credentials via a configuration file or individual variables:
- Set
FIREBASE_PLIST_PATHpointing to a validGoogleService-Info.plistfile, along withAppCheckDebugToken. - Alternatively, supply
FIREBASE_PROJECT_ID,FIREBASE_APP_ID,FIREBASE_API_KEY, andAppCheckDebugToken.
- Set
Automatic Skipping
If credentials are not present in the environment, integration tests marked with
.requireIntegrationTestingBackend are automatically and cleanly skipped
without failing test execution.
Supported Backends
All integration tests are parameterized across
IntegrationTestingBackend.availableBackends:
.developerAPI: Direct Gemini Developer API (generativelanguage.googleapis.com)..firebaseAILogicDeveloperAPI: Firebase AI Logic proxy to Gemini Developer API (firebasevertexai.googleapis.com)..firebaseAILogicAgentPlatform(location:): Firebase AI Logic proxy to Gemini Enterprise Agent Platform (defaulting tolocation: "global").
Files in this Directory
BasicContentGenerationIntegrationTests.swift: Parameterized integration tests for single-turn prompt response, multi-turn chat sessions, and streaming chunk responses.GuidedGenerationIntegrationTests.swift: Parameterized integration tests for guided generation (structured outputs) using@Generabletypes, including single-turn and streaming generation, enum classification, and rich multi-type recursive hierarchies.ToolCallingIntegrationTests.swift: Parameterized integration tests for tool calling (function calling) using FoundationModelsTooldefinitions, covering single-turn tool calls, sequential tool calls, parallel tool calls, tool calling mode configuration, parameterless tools with empty arguments, and reasoning models.IntegrationTestingBackend+GeminiLanguageModel.swift: Convenience extension providingbackend.makeModel()to instantiate a pre-configuredGeminiLanguageModel.
Writing New Integration Tests
To add a new integration test suite, parameterize on
IntegrationTestingBackend:
@Suite("My New Feature Integration Tests", .requireFoundationModels)
struct MyNewFeatureIntegrationTests {
@Test(
.tags(.integration),
.requireIntegrationTestingBackend,
arguments: IntegrationTestingBackend.availableBackends
)
@available(macOS 27.0, iOS 27.0, watchOS 27.0, visionOS 27.0, *)
func testFeature(backend: IntegrationTestingBackend) async throws {
let model = try await backend.makeModel()
let session = LanguageModelSession(model: model)
// Execute test assertions...
}
}