Classe para APIs de modelos generativos.
Assinatura:
export declare class GenerativeModel
Construtores
Construtor | Modificadores | Descrição |
---|---|---|
(construtor)(vertexAI, modelParams, requestOptions) | Constrói uma nova instância da classe GenerativeModel . |
Propriedades
Propriedade | Modificadores | Tipo | Descrição |
---|---|---|---|
generationConfig (em inglês) | GenerationConfig (em inglês) | ||
model | string | ||
requestOptions (em inglês) | RequestOptions (em inglês) | ||
safetySettings (link em inglês) | Segurança[] | ||
systemInstruções (link em inglês) | Conteúdo | ||
toolConfig | ToolConfig (em inglês) | ||
ferramentas | Ferramenta[] |
Métodos
Método | Modificadores | Descrição |
---|---|---|
countTokens(solicitação) | Conta os tokens na solicitação fornecida. | |
generateContent(request). | Faz uma única chamada sem streaming para o modelo e retorna um objeto contendo um único GenerateContentResponse. | |
generateContentStream(request) (link em inglês) | Faz uma única chamada de streaming para o modelo e retorna um objeto contendo um fluxo iterável que faz iterações em todos os blocos na resposta de streaming, bem como uma promessa que retorna a resposta agregada final. | |
startChat(startChatParams) (em inglês) | Recebe uma nova instância de ChatSession que pode ser usada para chats com vários turnos. |
GenerativeModel.(construtor)
Constrói uma nova instância da classe GenerativeModel
.
Assinatura:
constructor(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions);
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
Vertex AI | VertexAI | |
ModelParams | ModelParams | |
requestOptions | RequestOptions (em inglês) |
GenerativeModel.generationConfig
Assinatura:
generationConfig: GenerationConfig;
Modelo Generativo
Assinatura:
model: string;
GenerativeModel.requestOptions
Assinatura:
requestOptions?: RequestOptions;
GenerativeModel.safetySettings
Assinatura:
safetySettings: SafetySetting[];
GenerativeModel.systemInstrução
Assinatura:
systemInstruction?: Content;
GenerativeModel.toolConfig
Assinatura:
toolConfig?: ToolConfig;
GenerativeModel.tools.
Assinatura:
tools?: Tool[];
GenerativeModel.countTokens().
Conta os tokens na solicitação fornecida.
Assinatura:
countTokens(request: CountTokensRequest | string | Array<string | Part>): Promise<CountTokensResponse>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
solicitar | CountTokensRequest | string | Matriz<string | Parte> |
Retorna:
Prometer<CountTokensResponse>
GenerativeModel.generateContent()
Faz uma única chamada sem streaming para o modelo e retorna um objeto contendo um único GenerateContentResponse.
Assinatura:
generateContent(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
solicitar | GenerateContentRequest | string | Matriz<string | Parte> |
Retorna:
Prometer<GenerateContentResult>
GenerativeModel.generateContentStream()
Faz uma única chamada de streaming para o modelo e retorna um objeto contendo um fluxo iterável que faz iterações em todos os blocos na resposta de streaming, bem como uma promessa que retorna a resposta agregada final.
Assinatura:
generateContentStream(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentStreamResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
solicitar | GenerateContentRequest | string | Matriz<string | Parte> |
Retorna:
Prometer<GenerateContentStreamResult>
GenerativeModel.startChat()
Recebe uma nova instância de ChatSession que pode ser usada para chats com vários turnos.
Assinatura:
startChat(startChatParams?: StartChatParams): ChatSession;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
startChatParams | StartChatParams (link em inglês) |
Retorna:
ChatSession (link em inglês)