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 VertexAI para la app determinada.
function(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams y 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 el historial de mensajes enviados y recibidos hasta el momento.
GenerativeModel Clase para las APIs de modelos generativos.

Enumeraciones

Enumeration Descripción
BlockMotivo Motivo por el que se bloqueó un mensaje.
FinishReason Motivo por el que finalizó un candidato.
FunctionCallingMode
FunctionDeclarationSchemaType. Contiene la lista de los 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á un mensaje o candidato.
Categoría de daño Categorías perjudiciales que podrían bloquear las instrucciones o los candidatos
Daño Probabilidad Probabilidades de que una instrucción o un candidato coincida con una categoría de daño.
Daños graves Niveles de gravedad de daños.

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 Es el tipo de contenido para los mensajes y los candidatos de respuesta.
CountTokensRequest Parámetros para llamar a GenerativeModel.countTokens()
CountTokensResponse Respuesta de la llamada a GenerativeModel.countTokens().
Fecha_2 Protobuf google.type.Date
EnhancedGenerateContentResponse Objeto de respuesta unido con métodos auxiliares.
Datos de archivos Datos que apuntan a un archivo subido a Google Cloud Storage.
FileDataPart Es la interfaz de la parte de contenido si la parte representa FileData.
Llamada a función Una FunctionCall predicha que muestra el modelo y que contiene una string que representa FunctionDeclaration.name y un objeto JSON estructurado que contiene los parámetros y sus valores.
FunctionCallingConfig
FunctionCallPart Es la interfaz de la parte de contenido si la parte representa una FunctionCall.
Declaración de función Representación estructurada de una declaración de función según lo define la especificación de OpenAPI 3.0. Esta declaración incluye 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 que se pasan 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 en el futuro según sea necesario.
FunctionDeclarationsTool Un FunctionDeclarationsTool es un fragmento de código que permite al sistema interactuar con sistemas externos para realizar una acción, o un conjunto de acciones, fuera del conocimiento y el alcance del modelo.
FunctionResponse Como contexto para el modelo, se usa el resultado de una FunctionCall que contiene una string que representa FunctionDeclaration.name y un objeto JSON estructurado que contiene cualquier resultado de la función. Debe contener el resultado de una FunctionCall basada en la predicción del modelo.
FunctionResponsePart Es la interfaz de la parte de contenido si la parte representa FunctionResponse.
GenerateContentCandidate Es un candidato que se muestra como parte de una GenerateContentResponse.
GenerateContentRequest Solicitud enviada con GenerativeModel.generateContent()
GenerateContentResponse Respuesta individual de GenerativeModel.generateContent() y GenerativeModel.generateContentStream(). generateContentStream() mostrará uno en cada bloque hasta que se complete la transmisión.
GenerateContentResult Objeto de resultado que muestra la llamada GenerativeModel.generateContent()
GenerateContentStreamResult. Objeto Resultado que se muestra con 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 la transmisión finalice.
GenerationConfig Opciones de configuración para solicitudes relacionadas con el contenido
GenerativeContentBlob Interfaz para enviar una imagen.
Atribución de fundamentos
GroundingMetadata Metadatos que se devuelven 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 pasados a getGenerativeModel().
PromptFeedback Si se bloqueó el mensaje, se propagará con blockReason y el safetyRatings correspondiente.
Opciones de solicitud Parámetros pasados a getGenerativeModel().
RetrievedContextAttribution
Calificació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
IniciarChatParams Parámetros para GenerativeModel.startChat().
Partedetexto Es la interfaz de la parte de contenido si la parte representa una cadena de texto.
Configuración de la herramienta Configuración de la herramienta Esta configuración se comparte para todas las herramientas que se proporcionan en la solicitud.
UsageMetadata. Metadatos de uso sobre GenerateContentResponse.
VertexAI Una instancia del SDK de Vertex AI para Firebase.
VertexAIOptions Opciones cuando se inicializa el SDK de Vertex AI para Firebase.
Metadatos de video 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 llamadas o respuestas a funciones.
Rol El rol es el productor del contenido.
Herramienta Define una herramienta a la que el modelo puede llamar para acceder al conocimiento externo.

función(app, ...)

getVertexAI(app, opciones)

Muestra una instancia de VertexAI 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 y 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
Vertex AI VertexAI
Parámetrosdemodelos ModelParams
requestOptions Opciones de solicitud

Devuelve:

GenerativeModel

POSSIBLE_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 llamadas o respuestas a funciones.

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 al 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
BLOCKED_REASON_UNSPECIFIED "BLOCKED_REASON_UNSPECIFIED"
OTRO "OTHER"
DE LA MARCA "SAFETY"

Finalizar motivo

Motivo por el que finalizó un candidato.

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"
DE LA MARCA "SAFETY"
DETENER "STOP"

Modo de llamadadelafunción

Firma:

export declare enum FunctionCallingMode

Miembros de enumeración

Miembro Valor Descripción
CUALQUIERA "ANY"
AUTOMÁTICO "AUTO"
MODE_UNSPECIFIED "MODE_UNSPECIFIED"
NINGUNO "NONE"

FunctionDeclarationSchemaType

Contiene la lista de los 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á un mensaje o 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 perjudiciales que podrían bloquear las instrucciones o los candidatos

Firma:

export declare enum HarmCategory

Miembros de enumeración

Miembro Valor Descripción
CONTENIDO HARM_CATEGORY_DANGEROUS_CONTENT "HARM_CATEGORY_DANGEROUS_CONTENT"
HARM_CATEGORY_HARASSMENT "HARM_CATEGORY_HARASSMENT"
CATEGORÍA_HARMA_HATE_SPEECH "HARM_CATEGORY_HATE_SPEECH"
HARM_CATEGORY_SEXUALLY_EXPLICIT "HARM_CATEGORY_SEXUALLY_EXPLICIT"
HARM_CATEGORY_UNSPECIFIED "HARM_CATEGORY_UNSPECIFIED"

Perjuicio Probabilidad

Probabilidades de que una instrucción o un candidato coincida con una categoría de daño.

Firma:

export declare enum HarmProbability

Miembros de enumeración

Miembro Valor Descripción
HARM_PROBABILITY_UNSPECIFIED "HARM_PROBABILITY_UNSPECIFIED"
ALTO "HIGH"
BAJO "LOW"
MEDIO "MEDIUM"
DESESTIMABLE "NEGLIGIBLE"

Perjuicio

Niveles de gravedad de daños.

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"
SEVERITY_NEGLIGIBLE "HARM_SEVERITY_NEGLIGIBLE"
HARM_SEVERITY_UNSPECIFIED "HARM_SEVERITY_UNSPECIFIED"