Structured representation of a function declaration.

ThisFunctionDeclaration is a representation of a block of code that can be used as aToolby the model and executed by the client.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructFunctionDeclaration:Sendable

extensionFunctionDeclaration:Encodable

A helper tool that the model may use when generating responses.

ATool is a piece of code that enables the system to interact with external systems to performan action, or set of actions, outside of knowledge and scope of the model.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructTool:Sendable

extensionTool:Encodable

Configuration for specifying function calling behavior.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructFunctionCallingConfig:Sendable

extensionFunctionCallingConfig:Encodable

Tool configuration for anyTool specified in the request.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructToolConfig:Sendable

extensionToolConfig:Encodable

The model’s response to a generate content request.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructGenerateContentResponse:Sendable

extensionGenerateContentResponse:Decodable

A struct representing a possible reply to a content generation prompt. Each content generationprompt may produce multiple candidate responses.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructCandidate:Sendable

extensionCandidate:Decodable

A collection of source attributions for a piece of content.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructCitationMetadata:Sendable

extensionCitationMetadata:Decodable

A struct describing a source attribution.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructCitation:Sendable

extensionCitation:Decodable

A value enumerating possible reasons for a model to terminate a content generation request.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructFinishReason:DecodableProtoEnum,Hashable,Sendable

A metadata struct containing any feedback the model had on the prompt it was provided.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructPromptFeedback:Sendable

extensionPromptFeedback:Decodable

A struct defining model parameters to be used when sending generative AIrequests to the backend model.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructGenerationConfig:Sendable

extensionGenerationConfig:Encodable

Configuration parameters for sending requests to the backend.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructRequestOptions:Sendable

extensionRequestOptions:Equatable

Represents token counting info for a single modality.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructModalityTokenCount:Sendable

extensionModalityTokenCount:Decodable

Content part modality.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructContentModality:DecodableProtoEnum,Hashable,Sendable

A type describing data in media formats interpretable by an AI model. Each generative AIrequest or response contains anArray ofModelContents, and eachModelContent valuemay comprise multiple heterogeneousParts.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructModelContent:Equatable,Sendable

extensionModelContent:Codable

A type defining potentially harmful media categories and their model-assigned ratings. A valueof this type may be assigned to a category for every model-generated response, not justresponses that exceed a certain threshold.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructSafetyRating:Equatable,Hashable,Sendable

extensionSafetyRating:Decodable

A type used to specify a threshold for harmful content, beyond which the model will return afallback response instead of generated content.

Seesafety settings for Geminimodels formore details.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructSafetySetting:Sendable

extensionSafetySetting:Encodable

Categories describing the potential harm a piece of content may pose.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructHarmCategory:CodableProtoEnum,Hashable,Sendable

The model’s response to a count tokens request.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructCountTokensResponse

extensionCountTokensResponse:Decodable

An aspect ratio for images generated by Imagen.

To specify an aspect ratio for generated images, setaspectRatio inyourImagenGenerationConfig. See theClouddocumentationfor more details and examples of the supported aspect ratios.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructImagenAspectRatio:Sendable

Configuration options for generating images with Imagen.

SeeParameters for Imagenmodels tolearn about parameters available for use with Imagen models, including how to configure them.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructImagenGenerationConfig

A response from a request to generate images with Imagen.

The type placeholderT is an image type; this is currently always anImagenInlineImage.

This type is returned from:

• generateImages(prompt:) whereT isImagenInlineImage

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructImagenGenerationResponse<T>

extensionImagenGenerationResponse:DecodablewhereT:Decodable

An image format for images generated by Imagen.

To specify an image format for generated images, setimageFormat inyourImagenGenerationConfig. See theClouddocumentationfor more details.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructImagenImageFormat

An error that occurs when image generation fails due to all generated images being blocked.

The images may have been blocked due to the specifiedImagenSafetyFilterLevel, theImagenPersonFilterLevel, or filtering included in the model. These filter levels may beadjusted in yourImagenSafetySettings. See theResponsible AI and usage guidelines forImagenfor more details.

Declaration

publicstructImagenImagesBlockedError:Error

extensionImagenImagesBlockedError:CustomNSError

An image generated by Imagen, represented as inline data.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructImagenInlineImage

extensionImagenInlineImage:Equatable

extensionImagenInlineImage:Decodable

A filter level controlling whether generation of images containing people or faces is allowed.

See thepersonGenerationdocumentation for more details.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructImagenPersonFilterLevel:ProtoEnum

A filter level controlling how aggressively to filter sensitive content.

Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AIare assessed against a list of safety filters, which include ‘harmful categories’ (for example,violence,sexual,derogatory, andtoxic). This filter level controls how aggressively tofilter out potentially harmful content from responses. See thesafetySettingdocumentation and theResponsible AI and usageguidelinesfor more details.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructImagenSafetyFilterLevel:ProtoEnum,Sendable

Settings for controlling the aggressiveness of filtering out sensitive content.

See theResponsible AI and usageguidelinesfor more details.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructImagenSafetySettings

A text part containing a string value.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructTextPart:Part

A data part that is provided inline in requests.

Data provided as an inline data part is encoded as base64 and included directly (inline) in therequest. For large files, seeFileDataPart which references content by URI instead ofincluding the data in the request.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructInlineDataPart:Part

File data stored in Cloud Storage for Firebase, referenced by URI.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructFileDataPart:Part

A predicted function call returned from the model.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructFunctionCallPart:Part

Result output from a function call.

Contains a string representing theFunctionDeclaration.name and a structured JSON objectcontaining any output from the function is used as context to the model. This should contain theresult of aFunctionCallPart made based on model prediction.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructFunctionResponsePart:Part

Represents the different types, or modalities, of data that a model can produce as output.

To configure the desired output modalities for model requests, set theresponseModalitiesparameter when initializing aGenerationConfig. See themultimodalresponsesdocumentation for more details.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructResponseModality:EncodableProtoEnum,Sendable