Vertex AI for Firebase ウェブ SDK。
関数
| 関数 | 説明 |
|---|---|
| function(app, ...) を使用します。 | |
| getVertexAI(アプリ, オプション) | 指定されたアプリの VertexAI インスタンスを返します。 |
| function(vertexAI, ...) を使用します。 | |
| getGenerativeModel(vertexAI, modelParams, requestOptions) | 推論やその他の機能のメソッドを含む GenerativeModel クラスを返します。 |
クラス
| クラス | 説明 |
|---|---|
| ChatSession | チャット メッセージの送信を可能にし、これまでに送受信されたメッセージの履歴を保存する ChatSession クラス。 |
| GenerativeModel | 生成モデル API のクラス。 |
列挙型
| 列挙 | 説明 |
|---|---|
| BlockReason | メッセージがブロックされた理由。 |
| FinishReason | 候補者が退職した理由。 |
| FunctionCallingMode | |
| FunctionDeclarationSchemaType | https://swagger.io/docs/specification/data-models/data-types/ で定義されている OpenAPI データ型のリストが含まれます。 |
| HarmBlockMethod のメソッド | |
| HarmBlockThreshold | このしきい値を超えると、プロンプトまたは候補がブロックされます。 |
| HarmCategory | メッセージや候補がブロックされる原因となる有害なカテゴリ。 |
| 危害の可能性 | プロンプトまたは候補が有害なカテゴリに一致する確率。 |
| 有害性の重大度 | 害の重大度レベル。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| BaseParams | いくつかのメソッドの基本パラメータ。 |
| 引用 | 単一の引用。 |
| CitationMetadata | GenerateContentCandidate にある引用メタデータ。 |
| Content | プロンプトとレスポンス候補の両方のコンテンツ タイプ。 |
| CountTokensRequest | GenerativeModel.countTokens() を呼び出すためのパラメータ |
| CountTokensResponse | GenerativeModel.countTokens() の呼び出しに対するレスポンス。 |
| 日付_2 | Protobuf google.type.Date |
| EnhancedGenerateContentResponse | ヘルパー メソッドでラップされたレスポンス オブジェクト。 |
| ファイルデータ | Google Cloud Storage にアップロードされたファイルを指すデータ。 |
| FileDataPart | パーツが FileData を表す場合のコンテンツ パーツのインターフェース |
| FunctionCall | FunctionDeclaration.name を表す文字列と、パラメータとその値を含む構造化 JSON オブジェクトを含む、モデルから返された予測された FunctionCall。 |
| FunctionCallingConfig | |
| FunctionCallPart | コンテンツ パートが FunctionCall を表す場合、コンテンツ パートのインターフェース。 |
| FunctionDeclaration | OpenAPI 3.0 仕様 で定義された関数宣言の構造化表現。この宣言には、関数名とパラメータが含まれています。この FunctionDeclaration は、モデルによってツールとして使用され、クライアントによって実行できるコードブロックを表しています。 |
| FunctionDeclarationSchema | FunctionDeclaration.parameters に渡されるパラメータのスキーマ。 |
| FunctionDeclarationSchemaProperty | スキーマは、入出力データの形式を定義するために使用されます。OpenAPI 3.0 スキーマ オブジェクトの選択サブセットを表します。今後、必要に応じてさらに項目が追加される可能性があります。 |
| FunctionDeclarationsTool | FunctionDeclarationsTool は、システムが外部システムとやり取りし、モデルの知識やスコープ外で 1 つまたは複数のアクションを実行できるようにするコードです。 |
| 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 | 画像を送信するためのインターフェース。 |
| 根拠づけのアトリビューション | |
| GroundingMetadata | グラウンディングが有効な場合にクライアントに返されるメタデータ。 |
| InlineDataPart | コンテンツ パートが画像を表す場合、コンテンツ パートのインターフェース。 |
| ModelParams | getGenerativeModel() に渡されるパラメータ。 |
| PromptFeedback | プロンプトがブロックされた場合、blockReason と関連する safetyRatings が入力されます。 |
| RequestOptions | getGenerativeModel() に渡されるパラメータ。 |
| RetrievedContextAttribution | |
| 安全性の評価 | GenerateContentCandidate に関連付けられた安全性評価 |
| SafetySetting | リクエスト パラメータの一部として送信できる安全性設定。 |
| Segment | |
| StartChatParams | GenerativeModel.startChat() のパラメータ。 |
| テキスト パート | コンテンツ パートがテキスト文字列を表す場合、コンテンツ パートのインターフェース。 |
| ツール構成 | ツール構成この構成は、リクエストで提供されたすべてのツールで共有されます。 |
| UsageMetadata | GenerateContentResponse に関する使用状況メタデータ。 |
| VertexAI | Vertex AI for Firebase SDK のインスタンス。 |
| VertexAIOptions | Vertex AI for Firebase SDK を初期化する際のオプション。 |
| VideoMetadata | 入力動画コンテンツを記述します。 |
| ウェブ アトリビューション |
変数
| 変数 | 説明 |
|---|---|
| POSSIBLE_ROLES | ロールの例。 |
型エイリアス
| タイプ エイリアス | 説明 |
|---|---|
| パート | コンテンツ パート - テキスト、画像/動画、または関数呼び出し/レスポンスのパートタイプが含まれます。 |
| ロール | Role はコンテンツのプロデューサーです。 |
| ツール | モデルが外部の知識にアクセスするために呼び出すことができるツールを定義します。 |
function(app, ...)
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
ロールの例。
署名:
POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]
パーツ
コンテンツ パート - テキスト、画像/動画、または関数呼び出し/レスポンスのパートタイプが含まれます。
署名:
export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
ロール
Role はコンテンツのプロデューサーです。
署名:
export declare type Role = (typeof POSSIBLE_ROLES)[number];
ツール
モデルが外部の知識にアクセスするために呼び出すことができるツールを定義します。
署名:
export declare type Tool = FunctionDeclarationsTool;
ブロック理由
メッセージがブロックされた理由。
署名:
export declare enum BlockReason
列挙型メンバー
| Member | 値 | 説明 |
|---|---|---|
| BLOCKED_REASON_UNSPECIFIED（ブロックした理由が不明） | "BLOCKED_REASON_UNSPECIFIED" |
|
| その他 | "OTHER" |
|
| 安全性 | "SAFETY" |
FinishReason
候補者が退職した理由。
署名:
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 | "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_METHOD_UNSPECIFIED" |
|
| 確率 | "PROBABILITY" |
|
| 重大度 | "SEVERITY" |
HarmBlockThreshold
このしきい値を超えると、プロンプトまたは候補がブロックされます。
署名:
export declare enum HarmBlockThreshold
列挙型メンバー
| Member | 値 | 説明 |
|---|---|---|
| BLOCK_LOW_AND_ABOVE | "BLOCK_LOW_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" |
|
| 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
列挙型メンバー
| 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_MEDIUM" |
|
| 有害 - 重大度 - 不可 | "HARM_SEVERITY_NEGLIGIBLE" |
|
| 有害な重大度_不明 | "HARM_SEVERITY_UNSPECIFIED" |