@firebase/vertexai
Version:
A Firebase SDK for VertexAI
51 lines (50 loc) • 2.02 kB
TypeScript
/**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Content, GenerateContentResult, GenerateContentStreamResult, Part, RequestOptions, StartChatParams } from '../types';
import { ApiSettings } from '../types/internal';
/**
* ChatSession class that enables sending chat messages and stores
* history of sent and received messages so far.
*
* @public
*/
export declare class ChatSession {
model: string;
params?: StartChatParams | undefined;
requestOptions?: RequestOptions | undefined;
private _apiSettings;
private _history;
private _sendPromise;
constructor(apiSettings: ApiSettings, model: string, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
/**
* Gets the chat history so far. Blocked prompts are not added to history.
* Neither blocked candidates nor the prompts that generated them are added
* to history.
*/
getHistory(): Promise<Content[]>;
/**
* Sends a chat message and receives a non-streaming
* <code>{@link GenerateContentResult}</code>
*/
sendMessage(request: string | Array<string | Part>): Promise<GenerateContentResult>;
/**
* Sends a chat message and receives the response as a
* <code>{@link GenerateContentStreamResult}</code> containing an iterable stream
* and a response promise.
*/
sendMessageStream(request: string | Array<string | Part>): Promise<GenerateContentStreamResult>;
}