vertexai-preview package

El SDK web de Vertex AI para Firebase

Funciones

Función	Descripción
function(app, ...)
getVertexAI(app, opciones)	Muestra una instancia de Vertex AI para la app determinada.
function(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)	Muestra una clase GenerativeModel con métodos para inferencia y otras funcionalidades.

Clases

Clase	Descripción
Sesión de chat	ChatSession que permite enviar mensajes de chat y almacena un historial de los mensajes enviados y recibidos hasta el momento.
Modelo generativo	Clase para APIs de modelos generativos.
VertexAIError	Clase de error del SDK de Vertex AI para Firebase.

Enumeraciones

Enumeration	Descripción
BlockReason	Motivo por el que se bloqueó un mensaje.
FinishReason	Motivo por el que un candidato finalizó.
Modo de llamada de función
FunctionDeclarationSchemaType	Contiene la lista de tipos de datos de OpenAPI, como se define en https://swagger.io/docs/specification/data-models/data-types/.
HarmBlockMethod
HarmBlockThreshold	Umbral por encima del cual se bloqueará una instrucción o un candidato.
Categoría de daño	Categorías de daños que podrían bloquear mensajes o candidatos
Probabilidad de daño	Probabilidad de que una instrucción o un candidato coincidan con una categoría de perjuicio.
Daños graves	Niveles de gravedad del daño.
VertexAIErrorCode	Códigos de error estandarizados que puede tener VertexAIError

Interfaces

Interfaz	Descripción
BaseParams	Parámetros base para varios métodos
Cita	Una sola cita.
CitationMetadata	Metadatos de citas que se pueden encontrar en GenerateContentCandidate.
Contenido	Tipo de contenido para instrucciones y candidatos de respuesta.
CountTokensRequest	Parámetros para llamar a GenerativeModel.countTokens()
CountTokensResponse	Respuesta de la llamada a GenerativeModel.countTokens().
CustomErrorData	Detalla un objeto que contiene datos que se originan de una respuesta HTTP incorrecta.
Fecha_2	Protobuf google.type.Date
EnhancedGenerateContentResponse	Objeto de respuesta unido con métodos auxiliares.
ErrorDetails	Detalles del objeto que se puede incluir en una respuesta de error.
Datos de archivo	Datos que apuntan a un archivo subido a Google Cloud Storage.
FileDataPart	Interfaz de la parte de contenido si la parte representa FileData
Llamada a función	El modelo muestra una FunctionCall predicha que contiene una cadena que representa el FunctionDeclaration.name y un objeto JSON estructurado que contiene los parámetros y sus valores.
FunctionCallingConfig
FunctionCallPart	Interfaz de la parte de contenido si la parte representa una FunctionCall.
FunctionDeclaration	Representación estructurada de una declaración de función, como se define en la especificación de OpenAPI 3.0. En esta declaración, se incluyen el nombre y los parámetros de la función. Este FunctionDeclaration es una representación de un bloque de código que el modelo puede usar como herramienta y que el cliente puede ejecutar.
FunctionDeclarationSchema	Esquema para los parámetros pasados a FunctionDeclaration.Parameters.
FunctionDeclarationSchemaProperty	El esquema se usa para definir el formato de los datos de entrada y salida. Representa un subconjunto seleccionado de un objeto de esquema de OpenAPI 3.0. Es posible que se agreguen más campos según sea necesario.
FunctionDeclarationsTool	Un FunctionDeclarationsTool es un fragmento de código que permite que el sistema interactúe con sistemas externos para realizar una acción, o un conjunto de acciones, fuera del conocimiento y el alcance del modelo.
FunctionResponse	El resultado de una FunctionCall que contiene una cadena que representa el FunctionDeclaration.name y un objeto JSON estructurado que contiene cualquier resultado de la función se usa como contexto para el modelo. Debe contener el resultado de una FunctionCall basada en la predicción del modelo.
FunctionResponsePart	Interfaz de la parte de contenido si la parte representa FunctionResponse.
GenerateContentCandidate	Un candidato que se muestra como parte de una GenerateContentResponse.
GenerateContentRequest.	Solicitud enviada a través de GenerativeModel.generateContent().
GenerateContentResponse	Respuesta individual de GenerativeModel.generateContent() y GenerativeModel.generateContentStream(). generateContentStream() mostrará una respuesta en cada fragmento hasta que finalice la transmisión.
GenerateContentResult.	Objeto de resultado que se muestra desde la llamada GenerativeModel.generateContent().
GenerateContentStreamResult	Objeto de resultado que se muestra desde la llamada GenerativeModel.generateContentStream(). Itera en stream para obtener fragmentos a medida que ingresan o usa la promesa response para obtener la respuesta agregada cuando finalice la transmisión.
GenerationConfig	Opciones de configuración para solicitudes relacionadas con el contenido
GenerativeContentBlob	Interfaz para enviar una imagen.
GroundingAttribution
GroundingMetadata	Metadatos que se muestran al cliente cuando la conexión a tierra está habilitada.
InlineDataPart	Es la interfaz de la parte de contenido si la parte representa una imagen.
ModelParams.	Parámetros que se pasan a getGenerativeModel().
PromptFeedback	Si se bloqueó el mensaje, se propagará con blockReason y el safetyRatings relevante.
Opciones de solicitud	Parámetros que se pasan a getGenerativeModel().
RetrievedContextAttribution
Clasificación de seguridad	Una calificación de seguridad asociada con un GenerateContentCandidate
Configuración de seguridad	Es la configuración de seguridad que se puede enviar como parte de los parámetros de la solicitud.
Segmento
Params StartChat	Parámetros para GenerativeModel.startChat().
Parte de texto	Es la interfaz de la parte de contenido si la parte representa una string de texto.
Configuración de herramientas	Configuración de la herramienta Esta configuración se comparte para todas las herramientas proporcionadas en la solicitud.
UsageMetadata (disponible en inglés)	Metadatos de uso sobre una GenerateContentResponse.
VertexAI	Una instancia del SDK de Vertex AI para Firebase.
VertexAIOptions	Opciones cuando se inicializa el SDK de Vertex AI para Firebase.
VideoMetadata	Describe el contenido del video de entrada.
Atribución web

Variables

Variable	Descripción
POSSIBLE_ROLES	Roles posibles.

Escribe alias

Alias de tipo	Descripción
Parte	Parte de contenido: incluye tipos de partes de texto, imagen o video, o llamada a función o respuesta.
Rol	El rol es el productor del contenido.
Herramienta	Define una herramienta a la que el modelo puede llamar para acceder a conocimiento externo.

función(app, ...)

getVertexAI(app, opciones)

Muestra una instancia de Vertex AI para la app determinada.

Firma:

export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;

Parámetros

Parámetro	Tipo	Descripción
app	App de Firebase	La FirebaseApp que se usará.
opciones	VertexAIOptions

Devuelve:

VertexAI

función(vertexAI, ...)

getGenerativeModel(vertexAI, modelParams, requestOptions)

Muestra una clase GenerativeModel con métodos para inferencia y otras funcionalidades.

Firma:

export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;

Parámetros

Parámetro	Tipo	Descripción
VertexAI	VertexAI
modelParams	ModelParams.
requestOptions	Opciones de solicitud

Devuelve:

Modelo generativo

POSIBLES_ROLES

Roles posibles.

Firma:

POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]

Part

Parte de contenido: incluye tipos de partes de texto, imagen o video, o llamada a función o respuesta.

Firma:

export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;

Rol

El rol es el productor del contenido.

Firma:

export declare type Role = (typeof POSSIBLE_ROLES)[number];

Herramienta

Define una herramienta a la que el modelo puede llamar para acceder a conocimiento externo.

Firma:

export declare type Tool = FunctionDeclarationsTool;

Motivo del bloqueo

Motivo por el que se bloqueó un mensaje.

Firma:

export declare enum BlockReason 

Miembros de enumeración

Miembro	Valor	Descripción
BLOQUEADO_REASON_UNSPECIFIED	"BLOCKED_REASON_UNSPECIFIED"
OTRO	"OTHER"
SEGURIDAD	"SAFETY"

FinishReason

Motivo por el que un candidato finalizó.

Firma:

export declare enum FinishReason 

Miembros de enumeración

Miembro	Valor	Descripción
FINISH_REASON_UNSPECIFIED	"FINISH_REASON_UNSPECIFIED"
MAX_TOKENS	"MAX_TOKENS"
OTRO	"OTHER"
RECITACIÓN	"RECITATION"
SEGURIDAD	"SAFETY"
DETENER	"STOP"

Modo de llamada

Firma:

export declare enum FunctionCallingMode 

Miembros de enumeración

Miembro	Valor	Descripción
CUALQUIERA	"ANY"
AUTOMÁTICO	"AUTO"
MODO_NO ESPECÍFICO	"MODE_UNSPECIFIED"
NINGUNO	"NONE"

FunctionDeclarationSchemaType

Contiene la lista de tipos de datos de OpenAPI, como se define en https://swagger.io/docs/specification/data-models/data-types/.

Firma:

export declare enum FunctionDeclarationSchemaType 

Miembros de enumeración

Miembro	Valor	Descripción
ARRAY	"ARRAY"	Tipo de array.
BOOLEAN	"BOOLEAN"	Tipo booleano.
INTEGER	"INTEGER"	Tipo de número entero.
NÚMERO	"NUMBER"	Tipo de número.
RETENCIÓN	"OBJECT"	Tipo de objeto.
STRING	"STRING"	Tipo de cadena.

HarmBlockMethod

Firma:

export declare enum HarmBlockMethod 

Miembros de enumeración

Miembro	Valor	Descripción
HARM_BLOCK_METHOD_UNSPECIFIED	"HARM_BLOCK_METHOD_UNSPECIFIED"
PROBABILIDAD	"PROBABILITY"
GRAVEDAD	"SEVERITY"

HarmBlockThreshold

Umbral por encima del cual se bloqueará una instrucción o un candidato.

Firma:

export declare enum HarmBlockThreshold 

Miembros de enumeración

Miembro	Valor	Descripción
BLOCK_LOW_AND_ABOVE	"BLOCK_LOW_AND_ABOVE"
BLOQUE_MEDIUM_AND_ABOVE	"BLOCK_MEDIUM_AND_ABOVE"
BLOCK_NONE	"BLOCK_NONE"
BLOCK_ONLY_HIGH	"BLOCK_ONLY_HIGH"
HARM_BLOCK_THRESHOLD_UNSPECIFIED	"HARM_BLOCK_THRESHOLD_UNSPECIFIED"

HarmCategory

Categorías de daños que podrían bloquear mensajes o candidatos

Firma:

export declare enum HarmCategory 

Miembros de enumeración

Miembro	Valor	Descripción
CONTENIDO DE HARM_CATEGORY_DANGEROUS_CONTENT	"HARM_CATEGORY_DANGEROUS_CONTENT"
HARM_CATEGORY_HARASSMENT	"HARM_CATEGORY_HARASSMENT"
HARM_CATEGORY_HATE_SPEECH	"HARM_CATEGORY_HATE_SPEECH"
HARM_CATEGORY_SEXUALLY_EXPLICIT	"HARM_CATEGORY_SEXUALLY_EXPLICIT"
CATEGORÍA HARMA NO ESPECÍFICA	"HARM_CATEGORY_UNSPECIFIED"

HarmProbability

Probabilidad de que una instrucción o un candidato coincidan con una categoría de perjuicio.

Firma:

export declare enum HarmProbability 

Miembros de enumeración

Miembro	Valor	Descripción
PROBABILIDADES_NO ESPECÍFICAS DE HARM	"HARM_PROBABILITY_UNSPECIFIED"
ALTO	"HIGH"
BAJO	"LOW"
MEDIO	"MEDIUM"
DESESTIMABLE	"NEGLIGIBLE"

HarmSeverity

Niveles de gravedad del daño.

Firma:

export declare enum HarmSeverity 

Miembros de enumeración

Miembro	Valor	Descripción
HARM_SEVERITY_HIGH	"HARM_SEVERITY_HIGH"
HARM_SEVERITY_LOW	"HARM_SEVERITY_LOW"
HARM_SEVERITY_MEDIUM	"HARM_SEVERITY_MEDIUM"
HARM_SEVERITY_NEGLIGIBLE	"HARM_SEVERITY_NEGLIGIBLE"
MAYOR_SEVERIDAD_NO ESPECÍFICA	"HARM_SEVERITY_UNSPECIFIED"

Código de error de VertexAI

Códigos de error estandarizados que puede tener VertexAIError

Firma:

export declare const enum VertexAIErrorCode 

Miembros de enumeración

Miembro	Valor	Descripción
ERROR	"error"	Se produjo un error genérico.
FETCH_ERROR	"fetch-error"	Se produjo un error durante la recuperación de datos.
CONTENIDO NO VÁLIDO	"invalid-content"	Un error asociado con un objeto de contenido.
SIN_CLAVE_API	"no-api-key"	Se produjo un error debido a la falta de una clave de API de Firebase.
SIN_MODELO	"no-model"	Se produjo un error debido a que no se especificó un nombre de modelo durante la inicialización.
SIN_ID_DE_PROYECTO	"no-project-id"	Se produjo un error debido a que faltaba un ID del proyecto.
ERROR DE PARSE	"parse-failed"	Se produjo un error durante el análisis.
REQUEST_ERROR	"request-error"	Se produjo un error en una solicitud.
ERROR_DE_RESPUESTA	"response-error"	Se produjo un error en una respuesta.