コンテンツにスキップ
KARTE Craft Developer Portal

Craft AI Modules Google

const { aiModules } = MODULES;

Table of Contents

Schemas

FunctionCall

Type: Object

Properties

  • name string 呼び出す関数の名前
  • args Object 関数に渡す引数

FunctionResponse

Type: Object

Properties

  • name string 呼び出された関数の名前
  • response Object 関数からのレスポンス

GeminiResultValue

Type: Object

Properties

  • usageMetadata Object 使用量メタデータ

    • usageMetadata.candidatesTokenCount number 候補のトークン数
    • usageMetadata.totalTokenCount number トークン総数
    • usageMetadata.promptTokenCount number プロンプトのトークン数
    • usageMetadata.thoughtsTokenCount number? 思考のトークン数

  • candidates Array<Object> 回答内容

    • candidates[].content Object 回答の内容

      • candidates[].content.role string 役割
      • candidates[].content.parts Array<Object> 回答の部分
      • candidates[].content.parts string [].text - 回答のテキスト
      • candidates[].content.parts FunctionCall [].functionCall - functionCall
      • candidates[].content.parts FunctionResponse [].functionResponse - functionResponse

    • candidates[].finishReason string 回答終了理由

ContentPart

Type: Object

Properties

  • text string テキスト

  • inlineData Object? インラインデータ (任意)

    • inlineData.mimeType string MIMEタイプ
    • inlineData.data string Base64エンコードされたデータ

Content

Type: Object

Properties

EmbeddingsResultValue

Type: Object

Properties

  • predictions Array<Object> 予測結果

    • predictions[].embeddings Object Embeddings

      • predictions[].embeddings.values Array<number> 値

      • predictions[].embeddings.statistics Object 統計情報

        • predictions[].embeddings.statistics.truncated boolean 切り捨てられたかどうか
        • predictions[].embeddings.statistics.token_count number トークン数

  • metadata Object メタデータ

    • metadata.billableCharacterCount number 課金文字数

MultiEmbedding

Type: Object

Properties

  • textEmbedding Array<number>? The text embedding array.
  • imageEmbedding Array<number>? The image embedding array.

MultiEmbeddingsResultValue

Type: Object

Properties

RerankRecord

Type: Object

Properties

  • id string レコードのID
  • title string レコードのタイトル
  • content string レコードのコンテンツ

RankedRecord

Type: Object

Properties

  • id string レコードのID
  • title string? レコードのタイトル。ignoreRecordDetailsInResponse が true の場合は省略される。
  • content string? レコードのコンテンツ。ignoreRecordDetailsInResponse が true の場合は省略される。
  • score number ランキングスコア

RerankResultValue

Type: Object

Properties

StreamChunk

Type: Object

Properties

  • delta Object? 増分の回答内容

  • finishReason string? 回答終了理由

  • usageMetadata Object? 使用量メタデータ (最後のチャンクでのみ)

ThinkingConfig

Type: Object

Properties

  • includeThoughts boolean? 思考の要約を有効にするかどうか
  • thinkingBudget number? 思考処理のための予算（トークン数）

GenerationConfig

Type: Object

Properties

  • maxOutputTokens number? 最大出力トークン数
  • temperature number? 生成時の多様性を制御するパラメータ
  • topP number? 確率の高いトークンから選択する閾値
  • responseMimeType string? レスポンスタイプ
  • responseSchema Object? レスポンス構造を定義するスキーマ
  • thinkingConfig ThinkingConfig? 思考処理の設定

TextEmbeddingInstance

Type: Object

Properties

  • content string コンテンツ
  • title string? タイトル (optional) - RETRIEVAL_DOCUMENTタスクタイプでのみ使用可能
  • task_type string? タスクタイプ (optional) - 以下の値が使用可能。デフォルトは ‘RETRIEVAL_QUERY’:* ‘RETRIEVAL_QUERY’: 検索クエリ用
    • ’RETRIEVAL_DOCUMENT’: 検索対象のドキュメント用
    • ’SEMANTIC_SIMILARITY’: 意味的類似性の比較用
    • ’CLASSIFICATION’: 分類タスク用
    • ’CLUSTERING’: クラスタリングタスク用
    • ’QUESTION_ANSWERING’: 質問応答システム用
    • ’FACT_VERIFICATION’: 事実検証用
    • ’CODE_RETRIEVAL_QUERY’: コード検索クエリ用

TextEmbeddingParameters

Type: Object

Properties

  • autoTruncate boolean? 自動切り詰め (optional)
  • outputDimensionality number? 出力次元数 (optional)

Methods

gcpGeminiGenerateContent

Geminiにリクエストを送信する

Parameters

  • param Object

    • param.model string モデル名(gemini-2.5-flash-lite, gemini-2.5-flash, gemini-2.5-pro が契約に応じて利用可能です)
    • param.contents Array<Content> プロンプトの内容
    • param.systemInstruction string システムインストラクション
    • param.generationConfig GenerationConfig? 生成設定
    • param.toolConfig Object? ツール実行の設定
    • param.tools Object? function callingのためのツール
    • param.craftExtra

Returns Promise<GeminiResultValue>

gcpGeminiGenerateContentStream

Geminiにストリーミングリクエストを送信する

Parameters

  • param Object

    • param.model string モデル名(gemini-2.5-flash-lite, gemini-2.5-flash, gemini-2.5-pro が契約に応じて利用可能です)
    • param.contents Array<Content> プロンプトの内容
    • param.systemInstruction string システムインストラクション
    • param.generationConfig GenerationConfig? 生成設定
    • param.toolConfig Object? ツール実行の設定
    • param.tools Object? function callingのためのツール
    • param.onMessage function (StreamChunk): void チャンクごとのコールバック関数
    • param.onError function (Error): void? エラー発生時のコールバック関数
    • param.onComplete function (): void? ストリーミング完了時のコールバック関数
    • param.craftExtra

Returns Promise<void>

gcpEmbeddingsText

TextEmbeddingsにリクエストを送信する

Parameters

  • param Object

    • param.text string テキストの内容 (deprecated, use instances instead)
    • param.instances Array<TextEmbeddingInstance>? インスタンスの配列
    • param.parameters TextEmbeddingParameters? パラメータ
    • param.model string? モデル名 (optional) - ‘text-multilingual-embedding-002’, ‘text-embedding-004’, ‘gemini-embedding-001’

Returns Promise<EmbeddingsResultValue>

gcpEmbeddingsMulti

MultiModalEmbeddingsにリクエストを送信する

Parameters

  • param Object

    • param.text string? テキストの内容
    • param.dimension number? 次元数
    • param.bytesBase64Encoded string? 画像をBase64エンコードしたバイト列
    • param.model string? モデル名 (optional) - ‘multimodalembedding@001’
  • Throws Error failed. text or bytesBase64Encoded is required

Returns Promise<MultiEmbeddingsResultValue>

gcpRerank

GCP Rerank APIにリクエストを送信する

Parameters

  • param Object

    • param.query string 検索クエリ
    • param.records Array<RerankRecord> ランク付けするレコードの配列
    • param.model string? モデル名（デフォルト: semantic-ranker-512@latest）。利用可能なモデル: semantic-ranker-512@latest, semantic-ranker-default-004, semantic-ranker-fast-004
    • param.ignoreRecordDetailsInResponse boolean? レコードのタイトルとコンテンツも返さないか（デフォルト: true）
    • param.topN number? 返される上位レコードの数（デフォルト: 10）
  • Throws Error failed. query and records are required

Returns Promise<RerankResultValue>