/** * @license * Copyright 2025 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. */ /** * Role is the producer of the content. * @public */ export type Role = (typeof POSSIBLE_ROLES)[number]; /** * Possible roles. * @public */ export declare const POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]; /** * Harm categories that would cause prompts or candidates to be blocked. * @public */ export declare enum HarmCategory { HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH", HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT", HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT", HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT" } /** * Threshold above which a prompt or candidate will be blocked. * @public */ export declare enum HarmBlockThreshold { /** * Content with `NEGLIGIBLE` will be allowed. */ BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE", /** * Content with `NEGLIGIBLE` and `LOW` will be allowed. */ BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE", /** * Content with `NEGLIGIBLE`, `LOW`, and `MEDIUM` will be allowed. */ BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH", /** * All content will be allowed. */ BLOCK_NONE = "BLOCK_NONE", /** * All content will be allowed. This is the same as `BLOCK_NONE`, but the metadata corresponding * to the {@link HarmCategory} will not be present in the response. */ OFF = "OFF" } /** * This property is not supported in the Gemini Developer API ({@link GoogleAIBackend}). * * @public */ export declare enum HarmBlockMethod { /** * The harm block method uses both probability and severity scores. */ SEVERITY = "SEVERITY", /** * The harm block method uses the probability score. */ PROBABILITY = "PROBABILITY" } /** * Probability that a prompt or candidate matches a harm category. * @public */ export declare enum HarmProbability { /** * Content has a negligible chance of being unsafe. */ NEGLIGIBLE = "NEGLIGIBLE", /** * Content has a low chance of being unsafe. */ LOW = "LOW", /** * Content has a medium chance of being unsafe. */ MEDIUM = "MEDIUM", /** * Content has a high chance of being unsafe. */ HIGH = "HIGH" } /** * Harm severity levels. * @public */ export declare enum HarmSeverity { /** * Negligible level of harm severity. */ HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE", /** * Low level of harm severity. */ HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW", /** * Medium level of harm severity. */ HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM", /** * High level of harm severity. */ HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH", /** * Harm severity is not supported. * * @remarks * The GoogleAI backend does not support `HarmSeverity`, so this value is used as a fallback. */ HARM_SEVERITY_UNSUPPORTED = "HARM_SEVERITY_UNSUPPORTED" } /** * Reason that a prompt was blocked. * @public */ export declare enum BlockReason { /** * Content was blocked by safety settings. */ SAFETY = "SAFETY", /** * Content was blocked, but the reason is uncategorized. */ OTHER = "OTHER", /** * Content was blocked because it contained terms from the terminology blocklist. */ BLOCKLIST = "BLOCKLIST", /** * Content was blocked due to prohibited content. */ PROHIBITED_CONTENT = "PROHIBITED_CONTENT" } /** * Reason that a candidate finished. * @public */ export declare enum FinishReason { /** * Natural stop point of the model or provided stop sequence. */ STOP = "STOP", /** * The maximum number of tokens as specified in the request was reached. */ MAX_TOKENS = "MAX_TOKENS", /** * The candidate content was flagged for safety reasons. */ SAFETY = "SAFETY", /** * The candidate content was flagged for recitation reasons. */ RECITATION = "RECITATION", /** * Unknown reason. */ OTHER = "OTHER", /** * The candidate content contained forbidden terms. */ BLOCKLIST = "BLOCKLIST", /** * The candidate content potentially contained prohibited content. */ PROHIBITED_CONTENT = "PROHIBITED_CONTENT", /** * The candidate content potentially contained Sensitive Personally Identifiable Information (SPII). */ SPII = "SPII", /** * The function call generated by the model was invalid. */ MALFORMED_FUNCTION_CALL = "MALFORMED_FUNCTION_CALL", /** * Token generation stopped because generated images contain safety violations. */ IMAGE_SAFETY = "IMAGE_SAFETY", /** * Image generation stopped because generated images have other prohibited content. */ IMAGE_PROHIBITED_CONTENT = "IMAGE_PROHIBITED_CONTENT", /** * Image generation stopped because of other miscellaneous issue. */ IMAGE_OTHER = "IMAGE_OTHER", /** * The model was expected to generate an image, but none was generated. */ NO_IMAGE = "NO_IMAGE", /** * Image generation stopped due to recitation. */ IMAGE_RECITATION = "IMAGE_RECITATION", /** * The response candidate content was flagged for using an unsupported language. */ LANGUAGE = "LANGUAGE", /** * Model generated a tool call but no tools were enabled in the request. */ UNEXPECTED_TOOL_CALL = "UNEXPECTED_TOOL_CALL", /** * Model called too many tools consecutively, thus the system exited execution. */ TOO_MANY_TOOL_CALLS = "TOO_MANY_TOOL_CALLS", /** * Request has at least one thought signature missing. */ MISSING_THOUGHT_SIGNATURE = "MISSING_THOUGHT_SIGNATURE", /** * Finished due to malformed response. */ MALFORMED_RESPONSE = "MALFORMED_RESPONSE" } /** * Function calling mode for the model. * * @public */ export declare enum FunctionCallingMode { /** * Default model behavior; model decides to predict either a function call * or a natural language response. */ AUTO = "AUTO", /** * Model is constrained to always predicting a function call only. * If `allowed_function_names` is set, the predicted function call will be * limited to any one of `allowed_function_names`, else the predicted * function call will be any one of the provided `function_declarations`. */ ANY = "ANY", /** * Model will not predict any function call. Model behavior is same as when * not passing any function declarations. */ NONE = "NONE" } /** * Content part modality. * @public */ export declare enum Modality { /** * Unspecified modality. */ MODALITY_UNSPECIFIED = "MODALITY_UNSPECIFIED", /** * Plain text. */ TEXT = "TEXT", /** * Image. */ IMAGE = "IMAGE", /** * Video. */ VIDEO = "VIDEO", /** * Audio. */ AUDIO = "AUDIO", /** * Document (for example, PDF). */ DOCUMENT = "DOCUMENT" } /** * Generation modalities to be returned in generation responses. * * @beta */ export declare const ResponseModality: { /** * Text. * @beta */ readonly TEXT: "TEXT"; /** * Image. * @beta */ readonly IMAGE: "IMAGE"; /** * Audio. * @beta */ readonly AUDIO: "AUDIO"; }; /** * Generation modalities to be returned in generation responses. * * @beta */ export type ResponseModality = (typeof ResponseModality)[keyof typeof ResponseModality]; /** * (EXPERIMENTAL) * Determines whether inference happens on-device or in-cloud. * @public */ export declare const InferenceMode: { readonly PREFER_ON_DEVICE: "prefer_on_device"; readonly ONLY_ON_DEVICE: "only_on_device"; readonly ONLY_IN_CLOUD: "only_in_cloud"; }; /** * (EXPERIMENTAL) * Determines whether inference happens on-device or in-cloud. * @public */ export type InferenceMode = (typeof InferenceMode)[keyof typeof InferenceMode]; /** * Represents the result of the code execution. * * @beta */ export declare const Outcome: { UNSPECIFIED: string; OK: string; FAILED: string; DEADLINE_EXCEEDED: string; }; /** * Represents the result of the code execution. * * @beta */ export type Outcome = (typeof Outcome)[keyof typeof Outcome]; /** * The programming language of the code. * * @beta */ export declare const Language: { UNSPECIFIED: string; PYTHON: string; }; /** * The programming language of the code. * * @beta */ export type Language = (typeof Language)[keyof typeof Language]; /** * A preset that controls the model's "thinking" process. Use * `ThinkingLevel.LOW` for faster responses on less complex tasks, and * `ThinkingLevel.HIGH` for better reasoning on more complex tasks. * * @public */ export declare const ThinkingLevel: { MINIMAL: string; LOW: string; MEDIUM: string; HIGH: string; }; /** * A preset that controls the model's "thinking" process. Use * `ThinkingLevel.LOW` for faster responses on less complex tasks, and * `ThinkingLevel.HIGH` for better reasoning on more complex tasks. * * @public */ export type ThinkingLevel = (typeof ThinkingLevel)[keyof typeof ThinkingLevel]; //# sourceMappingURL=enums.d.ts.map