Skip to content

ai.safetyrating.md

Latest commit

 

History

History
90 lines (60 loc) · 3.8 KB

ai.safetyrating.md

File metadata and controls

90 lines (60 loc) · 3.8 KB

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

SafetyRating interface

A safety rating associated with a GenerateContentCandidate

Signature:

export interface SafetyRating

Properties

Property Type Description
blocked boolean
category HarmCategory
probability HarmProbability
probabilityScore number The probability score of the harm category.This property is only supported when using the Vertex AI Gemini API (VertexAIBackend). When using the Gemini Developer API (GoogleAIBackend), this property is not supported and will default to 0.
severity HarmSeverity The harm severity level.This property is only supported when using the Vertex AI Gemini API (VertexAIBackend). When using the Gemini Developer API (GoogleAIBackend), this property is not supported and will default to HarmSeverity.UNSUPPORTED.
severityScore number The severity score of the harm category.This property is only supported when using the Vertex AI Gemini API (VertexAIBackend). When using the Gemini Developer API (GoogleAIBackend), this property is not supported and will default to 0.

SafetyRating.blocked

Signature:

blocked: boolean;

SafetyRating.category

Signature:

category: HarmCategory;

SafetyRating.probability

Signature:

probability: HarmProbability;

SafetyRating.probabilityScore

The probability score of the harm category.

This property is only supported when using the Vertex AI Gemini API (VertexAIBackend). When using the Gemini Developer API (GoogleAIBackend), this property is not supported and will default to 0.

Signature:

probabilityScore: number;

SafetyRating.severity

The harm severity level.

This property is only supported when using the Vertex AI Gemini API (VertexAIBackend). When using the Gemini Developer API (GoogleAIBackend), this property is not supported and will default to HarmSeverity.UNSUPPORTED.

Signature:

severity: HarmSeverity;

SafetyRating.severityScore

The severity score of the harm category.

This property is only supported when using the Vertex AI Gemini API (VertexAIBackend). When using the Gemini Developer API (GoogleAIBackend), this property is not supported and will default to 0.

Signature:

severityScore: number;