Module: google.generativeai.types#

A collection of type definitions used throughout the library.

Classes#

class AsyncGenerateContentResponse: This is the async version of genai.GenerateContentResponse.

class BlobDict

class BlockedPromptException: Common base class for all non-exit exceptions.

class BlockedReason: A list of reasons why content may have been blocked.

class BrokenResponseError: Common base class for all non-exit exceptions.

class CallableFunctionDeclaration: An extension of FunctionDeclaration that can be built from a python function, and is callable.

class CitationMetadataDict: A collection of source attributions for a piece of content.

class CitationSourceDict: A citation to a source for a portion of a specific response.

class ContentDict

class ContentFilterDict: Content filtering metadata associated with processing a single request.

class File

class FileDataDict

class FunctionDeclaration

class FunctionLibrary: A container for a set of Tool objects, manages lookup and execution of their functions.

class GenerateContentResponse: Instances of this class manage the response of the generate_content method.

class GenerationConfig: A simple dataclass used to configure the generation parameters of GenerativeModel.generate_content.

class GenerationConfigDict

class HarmBlockThreshold: Block at and beyond a specified harm probability.

class HarmCategory: Harm Categories supported by the gemini-family model

class HarmProbability: The probability that a piece of content is harmful.

class IncompleteIterationError: Common base class for all non-exit exceptions.

class Model: A dataclass representation of a protos.Model.

class PartDict

class Permission: A permission to access a resource.

class Permissions

class RequestOptions: Request options

class SafetyFeedbackDict: Safety feedback for an entire request.

class SafetyRatingDict: Safety rating for a piece of content.

class SafetySettingDict: Safety setting, affecting the safety-blocking behavior.

class Status: A ProtocolMessage

class StopCandidateException: Common base class for all non-exit exceptions.

class Tool: A wrapper for protos.Tool, Contains a collection of related FunctionDeclaration objects, protos.CodeExecution object, and protos.GoogleSearchRetrieval object.

class ToolDict

class TunedModel: A dataclass representation of a protos.TunedModel.

class TunedModelState: The state of the tuned model.

Functions#

TypedDict(...): A simple typed namespace. At runtime it is equivalent to a plain dict.

get_default_file_client(...)

to_file_data(...)

Type Aliases#

AnyModelNameOptions

BaseModelNameOptions

BlobType

ContentType

ContentsType

FileDataType

FunctionDeclarationType

FunctionLibraryType

GenerationConfigType

ModelNameOptions

ModelsIterable

PartType

RequestOptionsType

StrictContentType

ToolsType

TunedModelNameOptions

annotations

Instance of __future__._Feature