Vertex AI for Firebase Web SDK。
関数
| 関数 | 説明 |
|---|---|
| function(app, ...) | |
| getVertexAI(アプリ, オプション) | 指定されたアプリの VertexAI インスタンスを返します。 |
| 関数（vertexAI, ...） | |
| getGenerativeModel(vertexAI, modelParams, requestOptions) | 推論やその他の機能のためのメソッドを含む GenerativeModel クラスを返します。 |
クラス
| クラス | 説明 |
|---|---|
| ChatSession | チャット メッセージの送信を可能にし、これまでの送受信メッセージの履歴を保存する ChatSession クラス。 |
| GenerativeModel | 生成モデル API のクラス。 |
| VertexAIError | Vertex AI for Firebase SDK のエラークラス。 |
列挙型
| 列挙 | 説明 |
|---|---|
| BlockReason（ブロックの理由） | プロンプトがブロックされた理由。 |
| FinishReason | 候補者が終了した理由。 |
| FunctionCallingMode | |
| FunctionDeclarationSchemaType | https://swagger.io/docs/specification/data-models/data-types/ で定義されている OpenAPI データ型のリストを含む。 |
| HarmBlockMethod | |
| HarmBlockThreshold | プロンプトまたは候補がブロックされるしきい値。 |
| 有害カテゴリ | プロンプトや候補者がブロックされる原因となる有害カテゴリ。 |
| HarmProbability | プロンプトまたは候補が有害カテゴリに一致する確率。 |
| 有害性の重大度 | 有害性の重大度レベル。 |
| VertexAIErrorCode | VertexAIError に含まれる可能性のある標準化されたエラーコード。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| BaseParams | 多くのメソッドの基本パラメータ。 |
| 引用 | 単一の引用。 |
| CitationMetadata | GenerateContentCandidate にある引用メタデータ。 |
| Content | プロンプトとレスポンス候補の両方のコンテンツ タイプ。 |
| CountTokensRequest | GenerativeModel.countTokens() を呼び出すためのパラメータ |
| CountTokensResponse | GenerativeModel.countTokens() の呼び出しに対するレスポンス。 |
| CustomErrorData | 不正な HTTP レスポンスから派生したデータを含む Details オブジェクトです。 |
| 日付_2 | プロトコル バッファ google.type.Date |
| EnhancedGenerateContentResponse | ヘルパー メソッドでラップされたレスポンス オブジェクト。 |
| ErrorDetails | エラー レスポンスに含まれる可能性のある Details オブジェクト。 |
| ファイルデータ | Google Cloud Storage にアップロードされたファイルを指すデータ。 |
| FileDataPart | パートが FileData を表す場合のコンテンツ パート インターフェース |
| FunctionCall | モデルから返された予測された FunctionCall。FunctionDeclaration.name を表す文字列と、パラメータとその値を含む構造化 JSON オブジェクトが含まれています。 |
| FunctionCallingConfig | |
| FunctionCallPart | パーツが FunctionCall を表す場合、コンテンツ パートのインターフェース。 |
| FunctionDeclaration | OpenAPI 3.0 仕様 で定義されている関数宣言の構造化表現。この宣言には、関数名とパラメータが含まれます。この FunctionDeclaration は、モデルがツールとして使用し、クライアントで実行するコードブロックの表現です。 |
| FunctionDeclarationSchema | FunctionDeclaration.parameters に渡されるパラメータのスキーマ。 |
| FunctionDeclarationSchemaProperty | スキーマは入出力データの形式を定義するために使用されます。OpenAPI 3.0 スキーマ オブジェクトの選択サブセットを表します。今後、必要に応じて他のフィールドが追加される可能性があります。 |
| FunctionDeclarationsTool | FunctionDeclarationsTool は、システムが外部システムとやり取りして、モデルの知識や範囲外のアクションまたは一連のアクションを実行できるようにするコードです。 |
| FunctionResponse | FunctionDeclaration.name を表す文字列と、関数からの出力を含む構造化 JSON オブジェクトを含む FunctionCall からの出力が、モデルのコンテキストとして使用されます。これには、モデル予測に基づいて作成された FunctionCall の結果が含まれている必要があります。 |
| FunctionResponsePart | パーツが FunctionResponse を表す場合、コンテンツ パートのインターフェース。 |
| GenerateContentCandidate | GenerateContentResponse の一部として返される候補。 |
| GenerateContentRequest | GenerativeModel.generateContent() を介して送信されたリクエスト |
| GenerateContentResponse | GenerativeModel.generateContent() および GenerativeModel.generateContentStream() からの個々のレスポンス。ストリームが完了するまで、generateContentStream() は各チャンクで 1 つを返します。 |
| GenerateContentResult | GenerativeModel.generateContent() 呼び出しから返される結果オブジェクト。 |
| GenerateContentStreamResult | GenerativeModel.generateContentStream() 呼び出しから返される結果オブジェクト。stream を反復処理して、受信時にチャンクを取得するか、response Promise を使用して、ストリーミングの終了時に集約されたレスポンスを取得します。 |
| GenerationConfig | コンテンツ関連のリクエストの構成オプション |
| GenerativeContentBlob | 画像を送信するためのインターフェース。 |
| GroundingAttribution | |
| GroundingMetadata | グラウンディングが有効な場合にクライアントに返されるメタデータ。 |
| InlineDataPart | パーツが画像を表す場合、コンテンツ パーツのインターフェース。 |
| ModelParams | getGenerativeModel() に渡されるパラメータ。 |
| PromptFeedback | プロンプトがブロックされている場合は、blockReason と関連する safetyRatings が入力されます。 |
| RequestOptions | getGenerativeModel() に渡されるパラメータ。 |
| RetrievedContextAttribution（英語） | |
| SafetyRating | GenerateContentCandidate に関連付けられた安全性評価 |
| SafetySetting | リクエスト パラメータの一部として送信できる安全性設定。 |
| Segment | |
| StartChatParams | GenerativeModel.startChat() のパラメータ。 |
| TextPart | テキスト文字列を表す場合、コンテンツ パートのインターフェース。 |
| ToolConfig | ツール構成。この構成は、リクエストで指定されたすべてのツールで共有されます。 |
| UsageMetadata | GenerateContentResponse に関する使用状況メタデータ。 |
| VertexAI | Vertex AI for Firebase SDK のインスタンス。 |
| VertexAIOptions | Vertex AI for Firebase SDK を初期化する際のオプション。 |
| VideoMetadata | 入力動画コンテンツを記述します。 |
| WebAttribution |
変数
| 変数 | 説明 |
|---|---|
| POSSIBLE_ROLES | 可能なロール。 |
型エイリアス
| 型エイリアス | 説明 |
|---|---|
| パート | コンテンツ パート - テキスト、画像/動画、関数呼び出し/レスポンスの各パートタイプが含まれます。 |
| 役割 | ロールはコンテンツの作成者です。 |
| ツール | モデルが外部の知識にアクセスするために呼び出せるツールを定義します。 |
関数（アプリ、...）
getVertexAI(アプリ, オプション)
指定されたアプリの VertexAI インスタンスを返します。
署名:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
パラメータ
| パラメータ | 種類 | 説明 |
|---|---|---|
| app | FirebaseApp | 使用する FirebaseApp。 |
| オプション | VertexAIOptions |
戻り値:
関数（vertexAI、...）
getGenerativeModel(vertexAI, modelParams, requestOptions)
推論やその他の機能のためのメソッドを含む GenerativeModel クラスを返します。
署名:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
パラメータ
| パラメータ | 種類 | 説明 |
|---|---|---|
| Vertex AI | VertexAI | |
| modelParams | ModelParams | |
| requestOptions | RequestOptions |
戻り値:
可能なロール
可能なロール。
署名:
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;
BlockReason（ブロックの理由）
プロンプトがブロックされた理由。
署名:
export declare enum BlockReason
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| BLOCKED_REASON_UNSPECIFIED | "BLOCKED_REASON_UNSPECIFIED" |
|
| その他 | "OTHER" |
|
| 安全 | "SAFETY" |
終了理由
候補者が終了した理由。
署名:
export declare enum FinishReason
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| FINISH_REASON_UNSPECIFIED（終了の理由なし） | "FINISH_REASON_UNSPECIFIED" |
|
| MAX_TOKENS | "MAX_TOKENS" |
|
| その他 | "OTHER" |
|
| リテーション | "RECITATION" |
|
| 安全 | "SAFETY" |
|
| 停止 | "STOP" |
FunctionCallingMode
署名:
export declare enum FunctionCallingMode
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| 任意 | "ANY" |
|
| 自動 | "AUTO" |
|
| モード_指定なし | "MODE_UNSPECIFIED" |
|
| NONE | "NONE" |
FunctionDeclarationSchemaType
https://swagger.io/docs/specification/data-models/data-types/ で定義されている OpenAPI データ型のリストを含む。
署名:
export declare enum FunctionDeclarationSchemaType
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| ARRAY | "ARRAY" |
配列型。 |
| BOOLEAN | "BOOLEAN" |
ブール値型。 |
| INTEGER | "INTEGER" |
整数型。 |
| NUMBER | "NUMBER" |
数値の型。 |
| オブジェクト | "OBJECT" |
オブジェクト タイプ。 |
| STRING | "STRING" |
文字列型。 |
HarmBlockMethod
署名:
export declare enum HarmBlockMethod
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| HARM_BLOCK_メソッド_UNSPECIFIED | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
| 確率 | "PROBABILITY" |
|
| 重大度 | "SEVERITY" |
HarmBlockThreshold
プロンプトまたは候補がブロックされるしきい値。
署名:
export declare enum HarmBlockThreshold
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| BLOCK_LOW_AND_ABOVE | "BLOCK_LOW_AND_ABOVE" |
|
| BLOCK_MEDIUM_AND_ABOVE | "BLOCK_MEDIUM_AND_ABOVE" |
|
| BLOCK_NONE | "BLOCK_NONE" |
|
| BLOCK_ONLY_HIGH | "BLOCK_ONLY_HIGH" |
|
| HARM_BLOCK_THRESHOLD_UNSPECIFIED | "HARM_BLOCK_THRESHOLD_UNSPECIFIED" |
HarmCategory
プロンプトや候補者がブロックされる原因となる有害カテゴリ。
署名:
export declare enum HarmCategory
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| HARM_CATEGORY_DANGEROUS_CONTENT | "HARM_CATEGORY_DANGEROUS_CONTENT" |
|
| 有害カテゴリー_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
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| HARM_PROBABILITY_UNSPECIFIED | "HARM_PROBABILITY_UNSPECIFIED" |
|
| 高 | "HIGH" |
|
| 低 | "LOW" |
|
| 中 | "MEDIUM" |
|
| 最小 | "NEGLIGIBLE" |
有害性
有害性の重大度レベル。
署名:
export declare enum HarmSeverity
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| HARM_SEVERITY_HIGH | "HARM_SEVERITY_HIGH" |
|
| HARM_SEVERITY_LOW（高重大度_低） | "HARM_SEVERITY_LOW" |
|
| 高重大度_中程度 | "HARM_SEVERITY_MEDIUM" |
|
| HARM_SEVERITY_NEGLIGIBLE | "HARM_SEVERITY_NEGLIGIBLE" |
|
| HARM_SEVERITY_UNSPECIFIED | "HARM_SEVERITY_UNSPECIFIED" |
VertexAIErrorCode
VertexAIError に含まれる可能性のある標準化されたエラーコード。
署名:
export declare const enum VertexAIErrorCode
列挙型メンバー
| Member | 価値 | 説明 |
|---|---|---|
| エラー | "error" |
一般的なエラーが発生しました。 |
| 取得エラー | "fetch-error" |
取得中にエラーが発生しました。 |
| INVALID_CONTENT | "invalid-content" |
Content オブジェクトに関連するエラーです。 |
| API キーなし | "no-api-key" |
Firebase API キーがないため、エラーが発生しました。 |
| NO_MODEL | "no-model" |
初期化時にモデル名が指定されていないため、エラーが発生しました。 |
| プロジェクト ID なし | "no-project-id" |
プロジェクト ID がないためエラーが発生しました。 |
| 解析に失敗 | "parse-failed" |
解析中にエラーが発生しました。 |
| リクエスト エラー | "request-error" |
リクエストでエラーが発生しました。 |
| RESPONSE_ERROR（応答エラー） | "response-error" |
レスポンスでエラーが発生しました。 |