GigaChat
Defined in: src/index.ts:22
Класс для взаимодействия с API GigaChat. Позволяет выполнять авторизацию, отправлять запросы к модели, загружать файлы и работать с потоками данных.
Constructors
new GigaChat()
new GigaChat(
config):GigaChat
Defined in: src/index.ts:82
Создает новый экземпляр GigaChat.
Parameters
config
Конфигурация клиента.
Returns
Properties
authorization
authorization:
undefined|string
Defined in: src/index.ts:31
Токен авторизации для API.
Methods
allModels()
allModels():
Promise<IAllModelResponse>
Defined in: src/index.ts:275
Получает список всех моделей.
Returns
Promise<IAllModelResponse>
Ответ сервера с моделями.
completion()
completion(
data):Promise<ICompletionResponse>
Defined in: src/index.ts:229
Отправляет запрос на завершение чата.
Parameters
data
Данные запроса.
Returns
Promise<ICompletionResponse>
Ответ сервера.
completionStream()
completionStream(
data):Promise<Readable>
Defined in: src/index.ts:258
Отправляет потоковый запрос на завершение чата.
Parameters
data
Данные запроса.
Returns
Promise<Readable>
Потоковый ответ сервера.
createToken()
createToken():
Promise<ITokenResponse>
Defined in: src/index.ts:178
Создает новый токен доступа.
Returns
Promise<ITokenResponse>
Данные токена.
deleteFile()
deleteFile(
fileId):Promise<IFileDeleteResponse>
Defined in: src/index.ts:377
Удаление файла по идентификатору.
Parameters
fileId
string
Идентификатор файла.
Returns
Promise<IFileDeleteResponse>
Ответ сервера.
downloadFile()
downloadFile(
fileId):Promise<any>
Defined in: src/index.ts:405
Parameters
fileId
string
Returns
Promise<any>
embedding()
embedding(
input):Promise<IEmbeddingResponse>
Defined in: src/index.ts:292
Выполняет embedding запроса.
Parameters
input
string[]
Входные данные.
Returns
Promise<IEmbeddingResponse>
Ответ сервера с embedding.
getAllFiles()
getAllFiles():
Promise<IFile[]>
Defined in: src/index.ts:343
Получение списка доступных файлов.
Returns
Promise<IFile[]>
Массив объектов с информацией о доступных файлах.
getBalance()
getBalance():
Promise<IBalanceResponse>
Defined in: src/index.ts:393
Получение баланса токенов по всем моделям.
Returns
Promise<IBalanceResponse>
Ответ сервера с информацией о балансе.
getFileInfo()
getFileInfo(
fileId):Promise<IFile>
Defined in: src/index.ts:360
Получение информации о файле по идентификатору.
Parameters
fileId
string
Идентификатор файла.
Returns
Promise<IFile>
Объект с информацией о файле.
summarize()
summarize(
model,input):Promise<ISummarizeResponse[]>
Defined in: src/index.ts:310
Подсчитывает количество токенов в тексте.
Parameters
model
string
Модель.
input
string[]
Входные данные.
Returns
Promise<ISummarizeResponse[]>
Ответ с количеством токенов.
uploadFile()
uploadFile(
pathToFile,purpose?):Promise<IFile>
Defined in: src/index.ts:328
Загружает файл в сервис.
Parameters
pathToFile
string
Путь к файлу.
purpose?
string = 'general'
Назначение файла.
Returns
Promise<IFile>
Ответ сервера с данными файла.