vertexai-preview package

Vertex AI для Firebase Web SDK.

Функции

Функция Описание
функция (приложение, ...)
getVertexAI (приложение, параметры) Возвращает экземпляр VertexAI для данного приложения.
функция (вершинаAI, ...)
getGenerativeModel (vertexAI, modelParams, requestOptions) Возвращает класс GenerativeModel с методами вывода и другими функциями.

Классы

Сорт Описание
Чат-сессия Класс ChatSession, который позволяет отправлять сообщения чата и хранит историю отправленных и полученных сообщений.
Генеративнаямодель Класс для API генеративной модели.
ВертексАИОррор Класс ошибок для Vertex AI для Firebase SDK.

Перечисления

Перечисление Описание
БлокПричина Причина, по которой приглашение было заблокировано.
FinishReason Причина, по которой кандидат закончил работу.
Режим вызова функции
ТипОбъявлениеСхемыФункции Содержит список типов данных OpenAPI, как определено https://swagger.io/docs/specification/data-models/data-types/.
ВредБлокМетод
ВредБлокПорог Порог, выше которого приглашение или кандидат будут заблокированы.
Категория Вреда Категории вреда, которые могут привести к блокировке подсказок или кандидатов.
ВредВероятность Вероятность того, что подсказка или кандидат соответствует категории вреда.
ВредСерьезность Степени тяжести вреда.
VertexAIErrorCode Стандартизированные коды ошибок, которые может иметь VertexAIError .

Интерфейсы

Интерфейс Описание
Базовые параметры Базовые параметры для ряда методов.
Цитирование Единственная цитата.
Метаданные цитирования Метаданные цитирования, которые можно найти в GenerateContentCandidate. .
Содержание Тип контента как для подсказок, так и для кандидатов на ответы.
Запрос графтокенов Параметры для вызова GenerativeModel.countTokens()
CountTokensОтвет Ответ на вызов GenerativeModel.countTokens() .
ПользовательскиеErrorData Объект сведений, содержащий данные, полученные в результате неправильного ответа HTTP.
Дата_2 Протобуф google.type.Date
EnhancedGenerateContentResponse Объект ответа, обернутый вспомогательными методами.
Подробности об ошибке Объект сведений, который может быть включен в ответ об ошибке.
ФайлДанные Данные, указывающие на файл, загруженный в Google Cloud Storage.
ФайлДанныеЧасть Интерфейс части содержимого, если часть представляет FileData
Вызов функции Прогнозируемый вызов FunctionCall , возвращенный из модели, содержит строку, представляющую FunctionDeclaration.name , и структурированный объект JSON, содержащий параметры и их значения.
ФункцияВызовConfig
ФункцияCallPart Интерфейс части контента, если часть представляет FunctionCall .
Объявление функции Структурированное представление объявления функции, определенное спецификацией OpenAPI 3.0. . В это объявление включены имя функции и параметры. Это FunctionDeclaration является представлением блока кода, который может использоваться моделью в качестве инструмента и выполняться клиентом.
Объявление функцииСхема Схема параметров, передаваемых в FunctionDeclaration.parameters .
FunctionDeclarationSchemaProperty Схема используется для определения формата входных/выходных данных. Представляет выбранное подмножество объекта схемы OpenAPI 3.0. При необходимости в будущем могут быть добавлены дополнительные поля.
Инструмент «Объявления функций» FunctionDeclarationsTool — это фрагмент кода, который позволяет системе взаимодействовать с внешними системами для выполнения действия или набора действий за пределами знаний и области действия модели.
ФункцияОтвет Выходные данные FunctionCall , содержащие строку, представляющую FunctionDeclaration.name , и структурированный объект JSON, содержащий любые выходные данные функции, используются в качестве контекста для модели. Он должен содержать результат вызова FunctionCall , созданного на основе предсказания модели.
ФункцияResponsePart Интерфейс части контента, если часть представляет FunctionResponse .
ГенерироватьКонтентКандидате Кандидат вернулся как часть GenerateContentResponse. .
ГенерироватьСодержимоеЗапрос Запрос отправлен через GenerativeModel.generateContent()
ГенерироватьКонтентОтвет Индивидуальный ответ от GenerativeModel.generateContent() и GenerativeModel.generateContentStream() . generateContentStream() будет возвращать по одному в каждом фрагменте, пока поток не завершится.
ГенерироватьСодержимоеРезультат Объект результата, возвращаемый вызовом GenerativeModel.generateContent() .
Генератеконтентстримрезультат Объект результата, возвращенный из вызова GenerativeModel.generateContentStream() . Выполняйте итерацию по stream , чтобы получать фрагменты по мере их поступления, и/или используйте обещание response , чтобы получить агрегированный ответ после завершения потока.
Конфигурация поколения Параметры конфигурации для запросов, связанных с контентом
Генеративный контентBlob Интерфейс для отправки изображения.
ЗаземлениеАтрибуция
ЗаземлениеМетаданные Метаданные возвращаются клиенту при включении заземления.
InlineDataPart Интерфейс части контента, если часть представляет собой изображение.
МодельПараметры Параметры, переданные в getGenerativeModel() .
ПодсказкаОбратная связь Если приглашение было заблокировано, оно будет заполнено значением blockReason и соответствующим значением safetyRatings .
Параметры запроса Параметры, переданные в getGenerativeModel() .
Полученная атрибуция контекста
Рейтинг безопасности Рейтинг безопасности, связанный с GenerateContentCandidate.
Настройка безопасности Настройка безопасности, которую можно отправить как часть параметров запроса.
Сегмент
НачатьЧатПарамс Параметры для GenerativeModel.startChat() .
Текстовая часть Интерфейс части содержимого, если часть представляет собой текстовую строку.
ИнструментКонфигурация Конфигурация инструмента. Эта конфигурация является общей для всех инструментов, предоставленных в запросе.
Использованиеметаданные Метаданные использования GenerateContentResponse .
ВертексАИ Экземпляр Vertex AI для Firebase SDK.
Параметры VertexAI Параметры при инициализации Vertex AI для Firebase SDK.
ВидеоМетаданные Описывает входной видеоконтент.
Веб-атрибуция

Переменные

Переменная Описание
ВОЗМОЖНЫЕ_РОЛИ Возможные роли.

Введите псевдонимы

Введите псевдоним Описание
Часть Часть контента – включает в себя текст, изображения/видео или типы частей вызова/ответа функции.
Роль Роль — производитель контента.
Инструмент Определяет инструмент, который модель может вызвать для доступа к внешним знаниям.

функция (приложение, ...)

getVertexAI (приложение, параметры)

Возвращает экземпляр VertexAI для данного приложения.

Подпись:

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

Параметры

Параметр Тип Описание
приложение FirebaseApp Используемое приложение FirebaseApp .
параметры Параметры VertexAI

Возврат:

ВертексАИ

функция (вершинаAI, ...)

getGenerativeModel (vertexAI, modelParams, requestOptions)

Возвращает класс GenerativeModel с методами вывода и другими функциями.

Подпись:

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

Параметры

Параметр Тип Описание
вершинаAI ВертексИИ
модельПарамс МодельПараметры
параметры запроса Параметры запроса

Возврат:

Генеративнаямодель

ВОЗМОЖНЫЕ_РОЛИ

Возможные роли.

Подпись:

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

Часть

Часть контента — включает в себя текст, изображение/видео или типы частей вызова/ответа функции.

Подпись:

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

Роль

Роль — производитель контента.

Подпись:

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

Инструмент

Определяет инструмент, который модель может вызвать для доступа к внешним знаниям.

Подпись:

export declare type Tool = FunctionDeclarationsTool;

БлокПричина

Причина, по которой приглашение было заблокировано.

Подпись:

export declare enum BlockReason

Члены перечисления

Член Ценить Описание
BLOCKED_REASON_UNSPECIFIED "BLOCKED_REASON_UNSPECIFIED"
ДРУГОЙ "OTHER"
БЕЗОПАСНОСТЬ "SAFETY"

FinishReason

Причина, по которой кандидат закончил работу.

Подпись:

export declare enum FinishReason

Члены перечисления

Член Ценить Описание
FINISH_REASON_UNSPECIFIED "FINISH_REASON_UNSPECIFIED"
MAX_TOKENS "MAX_TOKENS"
ДРУГОЙ "OTHER"
ЧТЕНИЕ "RECITATION"
БЕЗОПАСНОСТЬ "SAFETY"
ОСТАНАВЛИВАТЬСЯ "STOP"

Режим вызова функции

Подпись:

export declare enum FunctionCallingMode

Члены перечисления

Член Ценить Описание
ЛЮБОЙ "ANY"
АВТО "AUTO"
MODE_UNSPECIFIED "MODE_UNSPECIFIED"
НИКТО "NONE"

ТипОбъявлениеСхемыФункции

Содержит список типов данных OpenAPI, как определено https://swagger.io/docs/specification/data-models/data-types/.

Подпись:

export declare enum FunctionDeclarationSchemaType

Члены перечисления

Член Ценить Описание
МНОЖЕСТВО "ARRAY" Тип массива.
БУЛЕВОЕ значение "BOOLEAN" Булев тип.
ЦЕЛОЕ ЧИСЛО "INTEGER" Целочисленный тип.
ЧИСЛО "NUMBER" Тип номера.
ОБЪЕКТ "OBJECT" Тип объекта.
НИТЬ "STRING" Тип строки.

ВредБлокМетод

Подпись:

export declare enum HarmBlockMethod

Члены перечисления

Член Ценить Описание
HARM_BLOCK_METHOD_UNSPECIFIED "HARM_BLOCK_METHOD_UNSPECIFIED"
ВЕРОЯТНОСТЬ "PROBABILITY"
СТРОГОСТЬ "SEVERITY"

ВредБлокПорог

Порог, выше которого приглашение или кандидат будут заблокированы.

Подпись:

export declare enum HarmBlockThreshold

Члены перечисления

Член Ценить Описание
BLOCK_LOW_AND_ABOVE "BLOCK_LOW_AND_ABOVE"
BLOCK_MEDIUM_AND_ABOVE "BLOCK_MEDIUM_AND_ABOVE"
БЛОК_НОН "BLOCK_NONE"
BLOCK_ONLY_HIGH "BLOCK_ONLY_HIGH"
HARM_BLOCK_THRESHOLD_UNSPECIFIED "HARM_BLOCK_THRESHOLD_UNSPECIFIED"

Категория Вреда

Категории вреда, которые могут привести к блокировке подсказок или кандидатов.

Подпись:

export declare enum HarmCategory

Члены перечисления

Член Ценить Описание
HARM_CATEGORY_DANGEROUS_CONTENT "HARM_CATEGORY_DANGEROUS_CONTENT"
HARM_CATEGORY_HARASSMENT "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"

ВредВероятность

Вероятность того, что подсказка или кандидат соответствует категории вреда.

Подпись:

export declare enum HarmProbability

Члены перечисления

Член Ценить Описание
HARM_PROBABILITY_UNSPECIFIED "HARM_PROBABILITY_UNSPECIFIED"
ВЫСОКИЙ "HIGH"
НИЗКИЙ "LOW"
СЕРЕДИНА "MEDIUM"
НЕЗНАЧИТЕЛЬНО "NEGLIGIBLE"

ВредСерьезность

Степени тяжести вреда.

Подпись:

export declare enum HarmSeverity

Члены перечисления

Член Ценить Описание
HARM_SEVERITY_HIGH "HARM_SEVERITY_HIGH"
HARM_SEVERITY_LOW "HARM_SEVERITY_LOW"
HARM_SEVERITY_MEDIUM "HARM_SEVERITY_MEDIUM"
HARM_SEVERITY_NEGLIGIBLE "HARM_SEVERITY_NEGLIGIBLE"
HARM_SEVERITY_UNSPECIFIED "HARM_SEVERITY_UNSPECIFIED"

VertexAIErrorCode

Стандартизированные коды ошибок, которые может иметь VertexAIError .

Подпись:

export declare const enum VertexAIErrorCode

Члены перечисления

Член Ценить Описание
ОШИБКА "error" Произошла общая ошибка.
FETCH_ERROR "fetch-error" При выполнении выборки произошла ошибка.
INVALID_CONTENT "invalid-content" Ошибка, связанная с объектом Content.
NO_API_KEY "no-api-key" Произошла ошибка из-за отсутствия ключа API Firebase.
NO_MODEL "no-model" Произошла ошибка из-за того, что при инициализации не было указано имя модели.
NO_PROJECT_ID "no-project-id" Произошла ошибка из-за отсутствия идентификатора проекта.
PARSE_FAILED "parse-failed" При анализе произошла ошибка.
ЗАПРОС_ОШИБКА "request-error" В запросе произошла ошибка.
RESPONSE_ERROR "response-error" В ответе произошла ошибка.