A Vertex AI no SDK da Web do Firebase.
Funções
Função | Descrição |
---|---|
function(app, ...) (link em inglês) | |
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. |
Classes
Turma | Descrição |
---|---|
ChatSession (link em inglês) | A classe ChatSession permite enviar 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 modelo generativo. |
VertexAIError | Classe de erro da Vertex AI no SDK do Firebase. |
Enumerações
Enumeração | Descrição |
---|---|
BlockReason | Motivo pelo qual uma solicitação foi bloqueada. |
FinishReason | Motivo pelo qual um candidato terminou. |
FunctionCallingMode (link em inglês) | |
FunctionDeclarationSchemaType (em inglês) | Contém a lista de tipos de dados da OpenAPI, conforme definido por https://swagger.io/docs/specification/data-models/data-types/ |
HarmBlockMethod (link em inglês) | |
HarmBlockThreshold (em inglês) | Limite acima do qual um prompt ou candidato será bloqueado. |
HarmCategory (em inglês) | Categorias de dano que fariam com que comandos ou candidatos fossem bloqueados. |
Probabilidade de danos | Probabilidade de que um comando ou candidato corresponda a uma categoria de dano. |
Gravidade de perigo | Níveis de gravidade de danos. |
VertexAIErrorCode | Códigos de erro padronizados que o VertexAIError pode ter. |
Interfaces
Interface | Descrição |
---|---|
BaseParams | Parâmetros base para vários métodos. |
Citação | Uma única citação. |
CitationMetadata (em inglês) | Metadados de citação que podem ser encontrados em um GenerateContentCandidate. |
Conteúdo | Tipo de conteúdo para comandos e candidatos de resposta. |
CountTokensRequest (link em inglês) | Parâmetros para chamar GenerativeModel.countTokens() |
CountTokensResponse (em inglês) | Resposta ao chamar GenerativeModel.countTokens(). |
CustomErrorData (em inglês) | Objeto de detalhes que contém dados originados de uma resposta HTTP inválida. |
Data_2 | Protobuf google.type.Date |
EnhancedGenerateContentResponse (em inglês) | Objeto de resposta encapsulado com métodos auxiliares. |
ErrorDetails (em inglês) | Objeto de detalhes que pode ser incluído em uma resposta de erro. |
FileData (link em inglês) | Dados que apontam para um arquivo carregado no Google Cloud Storage. |
FileDataPart (link em inglês) | Interface da parte do conteúdo se ela representar FileData |
FunctionCall (em inglês) | Uma FunctionCall prevista retornada do modelo contendo uma string que representa o FunctionDeclaration.name e um objeto JSON estruturado que contém os parâmetros e os valores deles. |
FunctionCallingConfig (em inglês) | |
FunctionCallPart (link 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. Essa declaração inclui 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 uma ferramenta pelo modelo e executado pelo cliente. |
FunctionDeclarationSchema (link em inglês) | Esquema dos parâmetros transmitidos para FunctionDeclaration.parameters. |
FunctionDeclarationSchemaProperty (link em inglês) | 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 (link em inglês) | Um FunctionDeclarationsTool é um trecho de código que permite ao sistema interagir 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) | O modelo usa a saída resultante de uma FunctionCall que contém uma string que representa o FunctionDeclaration.name e um objeto JSON estruturado com alguma saída da função. Ela deve conter o resultado de uma FunctionCall criada 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 uma GenerateContentResponse. |
GenerateContentRequest (em inglês) | Solicitação enviada por GenerativeModel.generateContent() |
GenerateContentResponse (em inglês) | Resposta individual de GenerativeModel.generateContent() e GenerativeModel.generateContentStream(). generateContentStream() vai retornar um em cada bloco até que o stream seja concluído. |
GenerateContentResult (em inglês) | Objeto de resultado retornado da chamada GenerativeModel.generateContent(). |
GenerateContentStreamResult (em inglês) | Objeto de resultado retornado da chamada GenerativeModel.generateContentStream(). Itere em stream para receber os blocos à medida que eles chegam e/ou use a promessa response para receber a resposta agregada quando o stream for concluído. |
GenerationConfig (em inglês) | Opções de configuração para solicitações relacionadas a conteúdo |
GenerativeContentBlob (link em inglês). | Interface para envio de imagens. |
GroundingAttribution (em inglês) | |
GroundingMetadata (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 (em inglês) | Se a solicitação estiver bloqueada, este campo será preenchido com blockReason e o safetyRatings relevante. |
RequestOptions (em inglês). | Parâmetros transmitidos para getGenerativeModel(). |
RetrievedContextAttribution (em inglês) | |
SafetyRating (em inglês) | Uma classificação de segurança associada a um 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 (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 (em inglês) | Metadados de uso sobre um GenerateContentResponse. |
VertexAI | Uma instância da Vertex AI no SDK do Firebase. |
VertexAIOptions | Opções ao inicializar a Vertex AI no SDK do Firebase. |
VideoMetadata (em inglês) | Descreve o conteúdo do vídeo de entrada. |
WebAttribution (link em inglês) |
Variáveis
Variável | Descrição |
---|---|
POSSIBLE_ROLES (link em inglês) | Possíveis papéis. |
Aliases de tipos
Alias de tipo | Descrição |
---|---|
Parte | Parte do conteúdo: inclui tipos de parte de texto, imagem/vídeo, chamada/resposta de função. |
Papel | O papel é o produtor do conteúdo. |
Ferramenta | Define uma ferramenta que o modelo pode chamar para acessar conhecimento externo. |
function(app, ...)
getVertexAI(app, options)
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 | O FirebaseApp a ser usado. |
options | VertexAIOptions |
Retorna:
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)
PAPÉIS POSSÍVEIS
Possíveis papéis.
Assinatura:
POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]
Parte
Parte do conteúdo: inclui tipos de parte de texto, imagem/vídeo, 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 conhecimento externo.
Assinatura:
export declare type Tool = FunctionDeclarationsTool;
Motivo do bloqueio
Motivo pelo qual uma solicitação foi bloqueada.
Assinatura:
export declare enum BlockReason
Membros de enumeração
Participante | Valor | Descrição |
---|---|---|
BLOCKED_REASON_UNSPECIFIED | "BLOCKED_REASON_UNSPECIFIED" |
|
OUTROS | "OTHER" |
|
SEGURANÇA | "SAFETY" |
Motivo do fim
Motivo pelo qual um candidato terminou.
Assinatura:
export declare enum FinishReason
Membros de enumeração
Participante | Valor | Descrição |
---|---|---|
FINISH_REASON_UNSPECIFIED | "FINISH_REASON_UNSPECIFIED" |
|
MAX_TOKENS | "MAX_TOKENS" |
|
OUTROS | "OTHER" |
|
RECITATION | "RECITATION" |
|
SEGURANÇA | "SAFETY" |
|
PARAR | "STOP" |
FunctionCallingMode
Assinatura:
export declare enum FunctionCallingMode
Membros de 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 da OpenAPI, conforme definido por https://swagger.io/docs/specification/data-models/data-types/
Assinatura:
export declare enum FunctionDeclarationSchemaType
Membros de 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
Membros de enumeração
Participante | Valor | Descrição |
---|---|---|
HARM_BLOCK_MÉTODO_UNSPECIFIADO | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
PROBABILIDADE | "PROBABILITY" |
|
GRAVIDADE | "SEVERITY" |
HarmBlockThreshold
Limite acima do qual um prompt ou candidato será bloqueado.
Assinatura:
export declare enum HarmBlockThreshold
Membros de 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 de dano que fariam com que comandos ou candidatos fossem bloqueados.
Assinatura:
export declare enum HarmCategory
Membros de enumeração
Participante | Valor | Descrição |
---|---|---|
HARM_CATEGORY_DANGEROUS_CONTENT | "HARM_CATEGORY_DANGEROUS_CONTENT" |
|
HARM_CATEGORY_ASSÉDIO | "HARM_CATEGORY_HARASSMENT" |
|
HARM_CATEGORY_HATE_SPEECH | "HARM_CATEGORY_HATE_SPEECH" |
|
HARM_CATEGORY_SEXUALLY_EXPLICIT | "HARM_CATEGORY_SEXUALLY_EXPLICIT" |
|
HARM_CATEGORY_UNSPECIFIED | "HARM_CATEGORY_UNSPECIFIED" |
Probabilidade de danos
Probabilidade de que um comando ou candidato corresponda a uma categoria de dano.
Assinatura:
export declare enum HarmProbability
Membros de enumeração
Participante | Valor | Descrição |
---|---|---|
HARM_PROBABILITY_UNSPECIFIED | "HARM_PROBABILITY_UNSPECIFIED" |
|
HIGH | "HIGH" |
|
BAIXA | "LOW" |
|
MÉDIO | "MEDIUM" |
|
INSIGNIFICANTE | "NEGLIGIBLE" |
Gravidade de danos
Níveis de gravidade de danos.
Assinatura:
export declare enum HarmSeverity
Membros de enumeração
Participante | Valor | Descrição |
---|---|---|
HARM_SEVERITY_ALTA | "HARM_SEVERITY_HIGH" |
|
HARM_SEVERITY_BAIXO | "HARM_SEVERITY_LOW" |
|
MÉDIA_DE_SEVERIDADE_HARM | "HARM_SEVERITY_MEDIUM" |
|
HARM_SEVERITY_NEGLIGÍVEL | "HARM_SEVERITY_NEGLIGIBLE" |
|
HARM_SEVERITY_UNSPECIFIED | "HARM_SEVERITY_UNSPECIFIED" |
Código de erro da VertexAI
Códigos de erro padronizados que o VertexAIError pode ter.
Assinatura:
export declare const enum VertexAIErrorCode
Membros de enumeração
Participante | Valor | Descrição |
---|---|---|
ERRO | "error" |
Ocorreu um erro genérico. |
ERRO_DE_FETCH | "fetch-error" |
Ocorreu um erro ao fazer uma busca. |
CONTEÚDO INVÁLIDO | "invalid-content" |
Um erro associado a um objeto Content. |
SEM_CHAVE_DE_API | "no-api-key" |
Ocorreu um erro devido à ausência de uma chave de API do Firebase. |
NENHUM_MODELO | "no-model" |
Ocorreu um erro porque o nome de um modelo não foi especificado durante a inicialização. |
SEM_ID_DO_PROJETO | "no-project-id" |
Ocorreu um erro porque o ID do projeto está ausente. |
FALHA NA PARSE | "parse-failed" |
Ocorreu um erro durante a análise. |
ERRO_DE_SOLICITAÇÃO | "request-error" |
Ocorreu um erro em uma solicitação. |
ERRO_RESPOSTA | "response-error" |
Ocorreu um erro em uma resposta. |