vertexai-preview package

O SDK da Vertex AI para Firebase da Web.

Funções

Função	Descrição
função(app, ...)
getVertexAI(app, options)	Retorna uma instância da VertexAI para o app especificado.
função(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)	Retorna uma classe GenerativeModel com métodos para inferência e outras funcionalidades.

Aulas

Aula	Descrição
ChatSession (link em inglês)	A classe ChatSession que permite o envio de mensagens de chat e armazena o histórico de mensagens enviadas e recebidas até o momento.
GenerativeModel (link em inglês)	Classe para APIs de modelos generativos.

Enumerações

Enumeração	Descrição
BlockReason	Motivo do bloqueio de uma solicitação.
FinishReason	Motivo da conclusão do candidato.
FunctionCallingMode (em inglês)
FunctionDeclarationSchemaType	Contém a lista de tipos de dados OpenAPI, conforme definido por https://swagger.io/docs/especificação/data-models/data-types/
HarmBlockMethod (em inglês)
HarmBlockThreshold	Limite acima do qual um prompt ou candidato será bloqueado.
HarmCategory (link em inglês)	Categorias que causariam o bloqueio de solicitações ou candidatos.
Probabilidade de risco	Probabilidade de que um comando ou candidato corresponda a uma categoria de dano.
Gravidade da ameaça	Níveis de gravidade do dano.

Interfaces

Interface	Descrição
BaseParams.	Parâmetros de base para vários métodos.
Citação	Uma única citação.
CitationMetadata (link em inglês)	Metadados de citação que podem ser encontrados em GenerateContentCandidate.
Conteúdo	Tipo de conteúdo para comandos e candidatos de resposta.
CountTokensRequest (em inglês)	Parâmetros para chamar GenerativeModel.countTokens()
CountTokensResponse (link em inglês)	Resposta da chamada de GenerativeModel.countTokens().
Data_2	Protobuf google.type.Date
EnhancedGenerateContentResponse (link em inglês)	Objeto de resposta unido com métodos auxiliares.
FileData (em inglês)	Dados que apontam para um arquivo carregado no Google Cloud Storage.
FileDataPart (link em inglês)	Interface da parte de conteúdo se a parte representar FileData
FunctionCall (em inglês)	Uma FunctionCall prevista retornada do modelo que contém uma string que representa FunctionDeclaration.name e um objeto JSON estruturado contendo os parâmetros e os valores deles.
FunctionCallingConfig (em inglês)
FunctionCallPart (em inglês)	Interface da parte do conteúdo, se a parte representar uma FunctionCall.
FunctionDeclaration (em inglês)	Representação estruturada de uma declaração de função, conforme definido pela especificação OpenAPI 3.0. Incluídos nessa declaração estão o nome e os parâmetros da função. Esse FunctionDeclaration é uma representação de um bloco de código que pode ser usado como ferramenta pelo modelo e executado pelo cliente.
FunctionDeclarationSchema (link em inglês)	Esquema dos parâmetros transmitidos para FunctionDeclaration.parameters.
FunctionDeclarationSchemaProperty	O esquema é usado para definir o formato dos dados de entrada/saída. Representa um subconjunto selecionado de um objeto de esquema da OpenAPI 3.0. Mais campos podem ser adicionados no futuro, conforme necessário.
FunctionDeclarationsTool	Um FunctionDeclarationsTool é um trecho de código que permite que o sistema interaja com sistemas externos para realizar uma ação ou conjunto de ações fora do conhecimento e do escopo do modelo.
FunctionResponse (em inglês)	A saída resultante de uma FunctionCall que contém uma string que representa FunctionDeclaration.name e um objeto JSON estruturado com qualquer saída da função é usada como contexto para o modelo. Ele precisa conter o resultado de uma FunctionCall feita com base na previsão do modelo.
FunctionResponsePart (link em inglês)	Interface da parte do conteúdo se a parte representar FunctionResponse.
GenerateContentCandidate	Um candidato retornado como parte de um GenerateContentResponse.
GenerateContentRequest.	Solicitação enviada por GenerativeModel.generateContent()
GenerateContentResponse	Resposta individual de GenerativeModel.generateContent() e GenerativeModel.generateContentStream(). generateContentStream() retornará um em cada bloco até que o stream seja concluído.
GenerateContentResult.	Objeto de resultado retornado da chamada GenerativeModel.generateContent().
GenerateContentStreamResult.	Objeto de resultado retornado da chamada GenerativeModel.generateContentStream(). Itere em stream para receber blocos à medida que eles chegam e/ou use a promessa de response para receber a resposta agregada quando o stream terminar.
GenerationConfig (em inglês)	Opções de configuração para solicitações relacionadas ao conteúdo
GenerativeContentBlob (link em inglês)	Interface para enviar uma imagem.
GroundingAttribution (link em inglês)
GroundingMetadata (link em inglês)	Metadados retornados ao cliente quando o embasamento está ativado.
InlineDataPart (link em inglês)	Interface da parte do conteúdo se a parte representar uma imagem.
ModelParams	Parâmetros transmitidos para getGenerativeModel().
PromptFeedback	Se a solicitação foi bloqueada, ela será preenchida com blockReason e o safetyRatings relevante.
RequestOptions (em inglês)	Parâmetros transmitidos para getGenerativeModel().
RetrievedContextAttribution (link em inglês)
SafetyRating	Uma classificação de segurança associada a um objeto GenerateContentCandidate
SafetySetting (link em inglês)	Configuração de segurança que pode ser enviada como parte dos parâmetros de solicitação.
Segment
StartChatParams (link em inglês)	Parâmetros para GenerativeModel.startChat().
TextPart (link em inglês)	Interface da parte do conteúdo se a parte representar uma string de texto.
ToolConfig (em inglês)	Configuração da ferramenta Essa configuração é compartilhada para todas as ferramentas fornecidas na solicitação.
UsageMetadata (link em inglês)	Metadados de uso sobre um GenerateContentResponse.
VertexAI	Uma instância do SDK da Vertex AI para Firebase.
VertexAIOptions	Opções ao inicializar o SDK da Vertex AI para Firebase.
VideoMetadata (link em inglês)	Descreve o conteúdo do vídeo de entrada.
WebAttribution (link em inglês)

Variáveis

Variável	Descrição
FUNÇÕES POSSIBLE	Funções possíveis.

Aliases de tipos

Tipo de alias	Descrição
Parte	Parte do conteúdo: inclui texto, imagem/vídeo ou tipos de partes de chamada/resposta de função.
Papel	O papel é o produtor do conteúdo.
Ferramenta	Define uma ferramenta que o modelo pode chamar para acessar conhecimentos externos.

função(app; ...)

getVertexAI(aplicativo; opções)

Retorna uma instância da VertexAI para o app especificado.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
app	FirebaseApp (link em inglês)	O FirebaseApp a ser usado.
do modelo.	VertexAIOptions

Retorna:

VertexAI

função(vertexAI, ...)

getGenerativeModel(vertexAI, modelParams, requestOptions)

Retorna uma classe GenerativeModel com métodos para inferência e outras funcionalidades.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
Vertex AI	VertexAI
ModelParams	ModelParams
requestOptions	RequestOptions (em inglês)

Retorna:

GenerativeModel (link em inglês)

POSSIBILIDADES

Funções possíveis.

Assinatura:

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

Parte

Parte do conteúdo: inclui texto, imagem/vídeo ou tipos de partes de chamada/resposta de função.

Assinatura:

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

Papel

O papel é o produtor do conteúdo.

Assinatura:

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

Ferramenta

Define uma ferramenta que o modelo pode chamar para acessar conhecimentos externos.

Assinatura:

export declare type Tool = FunctionDeclarationsTool;

Motivo do bloqueio

Motivo do bloqueio de uma solicitação.

Assinatura:

export declare enum BlockReason 

Participantes da enumeração

Participante	Valor	Descrição
BLOCKED_REASON_UNSPECIFIED	"BLOCKED_REASON_UNSPECIFIED"
OUTROS	"OTHER"
SEGURANÇA	"SAFETY"

Motivo do encerramento

Motivo da conclusão do candidato.

Assinatura:

export declare enum FinishReason 

Participantes da enumeração

Participante	Valor	Descrição
FINISH_REASON_UNSPECIFIED	"FINISH_REASON_UNSPECIFIED"
MAX_TOKENS	"MAX_TOKENS"
OUTROS	"OTHER"
RECITAÇÃO	"RECITATION"
SEGURANÇA	"SAFETY"
PARE	"STOP"

FunctionCallingMode

Assinatura:

export declare enum FunctionCallingMode 

Participantes da enumeração

Participante	Valor	Descrição
QUALQUER UMA	"ANY"
AUTOMÁTICO	"AUTO"
MODO_NÃO ESPECIFICADO	"MODE_UNSPECIFIED"
NENHUM	"NONE"

FunctionDeclarationSchemaType

Contém a lista de tipos de dados OpenAPI, conforme definido por https://swagger.io/docs/especificação/data-models/data-types/

Assinatura:

export declare enum FunctionDeclarationSchemaType 

Participantes da enumeração

Participante	Valor	Descrição
ARRAY	"ARRAY"	Tipo de matriz.
BOOLEAN	"BOOLEAN"	Tipo booleano.
INTEGER	"INTEGER"	Tipo de número inteiro.
NÚMERO	"NUMBER"	Tipo de número.
OBJETO	"OBJECT"	Tipo de objeto.
STRING	"STRING"	Tipo de string.

HarmBlockMethod

Assinatura:

export declare enum HarmBlockMethod 

Participantes da enumeração

Participante	Valor	Descrição
BLOQUEIO_DE_MÉTODO_NÃO ESPECIFICADO	"HARM_BLOCK_METHOD_UNSPECIFIED"
PROBABILIDADE	"PROBABILITY"
GRAVIDADE	"SEVERITY"

HarmBlockThreshold

Limite acima do qual um prompt ou candidato será bloqueado.

Assinatura:

export declare enum HarmBlockThreshold 

Participantes da enumeração

Participante	Valor	Descrição
BLOCK_LOW_AND_ABOVE	"BLOCK_LOW_AND_ABOVE"
BLOQUEIO_MEDIUM_E_ABOVE	"BLOCK_MEDIUM_AND_ABOVE"
BLOCK_NONE	"BLOCK_NONE"
BLOCK_ONLY_HIGH	"BLOCK_ONLY_HIGH"
HARM_BLOCK_THRESHOLD_UNSPECIFIED	"HARM_BLOCK_THRESHOLD_UNSPECIFIED"

HarmCategory

Categorias que causariam o bloqueio de solicitações ou candidatos.

Assinatura:

export declare enum HarmCategory 

Participantes da enumeração

Participante	Valor	Descrição
CONTEÚDO_DE_CATEGORIA_HARM_CATEGORIA	"HARM_CATEGORY_DANGEROUS_CONTENT"
ASSÉDIO_DE_CATEGORIA	"HARM_CATEGORY_HARASSMENT"
FALHA_DE_CATEGORIA_HARM_CATEGORIA	"HARM_CATEGORY_HATE_SPEECH"
HARM_CATEGORIA_SEXUALLY_EXPLICITADA	"HARM_CATEGORY_SEXUALLY_EXPLICIT"
CATEGORIA NÃO ESPECIFICADA	"HARM_CATEGORY_UNSPECIFIED"

Probabilidade de prejudicar

Probabilidade de que um comando ou candidato corresponda a uma categoria de dano.

Assinatura:

export declare enum HarmProbability 

Participantes da enumeração

Participante	Valor	Descrição
HARM_PROBABILITY_UNSPECIFIED	"HARM_PROBABILITY_UNSPECIFIED"
HIGH	"HIGH"
LOW	"LOW"
MÉDIO	"MEDIUM"
INSIGNIFICANTE	"NEGLIGIBLE"

Danogravidade

Níveis de gravidade do dano.

Assinatura:

export declare enum HarmSeverity 

Participantes da enumeração

Participante	Valor	Descrição
HARM_SEVERITY_ALTA	"HARM_SEVERITY_HIGH"
HARM_SEVERITY_BAIXO	"HARM_SEVERITY_LOW"
HARM_SEVERITY_MEDIUM	"HARM_SEVERITY_MEDIUM"
HARM_SEVERITY_NEGLIGIBLE	"HARM_SEVERITY_NEGLIGIBLE"
HARM_SEVERITY_UNSPECIFIED	"HARM_SEVERITY_UNSPECIFIED"