Files
firebase-ios-sdk/GeminiLanguageModel/Sources/GeminiAPIDataModels/GenerateContent/SearchEntryPoint.swift
T

78 lines
2.8 KiB
Swift

// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import Foundation
/// An internal data model for `SearchEntryPoint`.
///
/// ### Gemini Developer API
///
/// Type: `GoogleAiGenerativelanguageV1betaSearchEntryPoint`
///
/// Google search entry point.
///
/// ### Gemini Enterprise API
///
/// Type: `GoogleCloudAiplatformV1beta1SearchEntryPoint`
///
/// An entry point for displaying Google Search results.
///
/// A `SearchEntryPoint` is populated when the grounding source for a model's
/// response is Google Search. It provides information that you can use to
/// display the search results in your application.
package struct SearchEntryPoint: Codable, Sendable, Equatable, Hashable {
/// Optional. Web content snippet that can be embedded in a web page or an app webview.
///
/// ### Gemini Developer API
///
/// Optional. Web content snippet that can be embedded in a web page or an app webview.
///
/// ### Gemini Enterprise API
///
/// Optional. An HTML snippet that can be embedded in a web page or an
/// application's webview. This snippet displays a search result, including the
/// title, URL, and a brief description of the search result.
package let renderedContent: String?
/// Optional. Base64 encoded JSON representing array of tuple.
///
/// ### Gemini Developer API
///
/// Optional. Base64 encoded JSON representing array of tuple.
///
/// ### Gemini Enterprise API
///
/// Optional. A base64-encoded JSON object that contains a list of search
/// queries and their corresponding search URLs. This information can be used
/// to build a custom search UI.
package let sdkBlob: Data?
/// Creates a new `SearchEntryPoint`.
///
/// - Parameters:
/// - renderedContent: Optional. Web content snippet that can be embedded in a web page or an app webview. (behavior varies by backend). For more details, see ``renderedContent``.
/// - sdkBlob: Optional. Base64 encoded JSON representing array of tuple. (behavior varies by backend). For more details, see ``sdkBlob``.
package init(
renderedContent: String? = nil,
sdkBlob: Data? = nil
) {
self.renderedContent = renderedContent
self.sdkBlob = sdkBlob
}
enum CodingKeys: String, CodingKey {
case renderedContent = "renderedContent"
case sdkBlob = "sdkBlob"
}
}