Google スプレッドシートで、自然言語で質問できる関数を作ってみよう（Google Cloud Vertex AI 前編）

{
  instances: [
    {
      content: "Where is the restroom?"
    }
  ],
  parameters: {
    opt_out: true
  }
}

predictions: [
  {
    embeddings: {
      values: [ 0.04106621444225311, 0.015827510505914688, ... ],
	statistics: {
        truncated: false, 
        token_count: 5
      }
    }
  }    
]

{
  code: 429, 
  message: 'Quota exceeded for aiplatform.googleapis.com/online_prediction_requests_per_base_model with base model: textembedding-gecko. Please submit a quota increase request. https://cloud.google.com/vertex-ai/docs/quotas.',
  status: 'RESOURCE_EXHAUSTED'
}

{
  access_token: 'ya29...Uxt8',
  expires_in: 3599,
  token_type: 'Bearer'
}

// サービスアカウントキー
const GCP_CREDS =
// この行を選択して、サービスアカウントのキーファイル(JSON)の内容をペーストしてください



/**
 * サービスアカウントでAPIを利用するためのアクセストークンを取得します。
 * カスタム関数の内部で使用するための共通関数です。
 *
 * @param {string} client_email  資格情報のclient_email
 * @param {string} private_key  資格情報のprivate_key
 * @param {number} expires  トークンの有効期間(秒) デフォルト値:1800 
 * 
 * @return {object} 実行結果
 * 
 * copyright (c) 2023 SoftBank Corp.
 */
function get_access_token_(client_email, private_key, expires = 1800) {

  const header = { "alg": "RS256", "typ": "JWT" };

  const now = new Date();
  const iat = Math.floor(now / 1000)
  const exp = iat + expires

  const payload = {
    "iss": client_email,
    "scope": "https://www.googleapis.com/auth/cloud-platform",
    "aud": "https://www.googleapis.com/oauth2/v4/token",
    "iat": iat,
    "exp": exp,
  }

  const header_encoded = Utilities.base64EncodeWebSafe(JSON.stringify(header))
  const payload_encoded = Utilities.base64EncodeWebSafe(JSON.stringify(payload)).replace(/=+$/, '')
  const to_sign = `${header_encoded}.${payload_encoded}`
  const signature = Utilities.computeRsaSha256Signature(to_sign, private_key);
  const signature_encoded = Utilities.base64EncodeWebSafe(signature).replace(/=+$/, '');
  const jwt = `${to_sign}.${signature_encoded}`;

  const params = {
    'method': 'post',
    "payload": `grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&assertion=${jwt}`,
    'muteHttpExceptions': true
  };

  // APIリクエスト
  let res;
  try {
    res = UrlFetchApp.fetch("https://www.googleapis.com/oauth2/v4/token/", params)
  }
  catch (e) {
    console.error(e)
    throw Error("内部エラーが発生しました")
  }

  const res_json = JSON.parse(res.getContentText())
  return res_json
}



/**
 * テキスト埋め込みAPIを使用して、テキストに対する埋め込みベクトルを取得します。
 * 結果は文字列化されたベクトルです。
 *
 * @param {"トイレはどこですか"} TEXT テキスト {文字列} 
 *     埋め込み対象のテキストです。
 * @return {string}
 * 
 * @customfunction
 * copyright (c) 2023 SoftBank Corp.
 */
function TEXT_EMBEDDINGS(TEXT) {

  const url = `https://us-central1-aiplatform.googleapis.com/v1/projects/${GCP_CREDS.project_id}/locations/us-central1/publishers/google/models/textembedding-gecko:predict`

  let access_info;
  try {
    access_info = get_access_token_(GCP_CREDS.client_email, GCP_CREDS.private_key)
  }
  catch (e) {
    console.error(e)
    throw "内部エラーが発生しました"
  }
  const access_token = access_info.access_token

  const headers = {
    "Authorization": "Bearer " + access_token
  }

  const payload = {
    "instances": [
      {
        "content": TEXT,
      }
    ],
    "parameters": {
      "opt_out": true,
    }
  }

  const params = {
    method: "POST",
    headers: headers,
    contentType: "application/json",
    payload: JSON.stringify(payload),
    muteHttpExceptions: true,
  }

  const res = UrlFetchApp.fetch(url, params)
  const res_json = JSON.parse(res.getContentText())

  if ("error" in res_json) {
    console.log(res_json.error)
    throw "内部エラーが発生しました"
  }

  const vector = res_json.predictions[0].embeddings.values
  return JSON.stringify(vector)
}



/**
 * ベクトル間の類似度を算出します。各ベクトルは次元数が一致していて、文字列化されている必要があります。
 * 結果は1.0（もっとも似ている）から-1.0（もっとも似ていない）の範囲の実数です。
 *
 * @param {"[0.0,0.1]"} VECTOR1 ベクトル {文字列} 
 *     比較する一方のベクトルです。
 * @param {"[-1.0,1.1]"} VECTOR2 ベクトル {文字列} 
 *     比較するもう一方のベクトルです。
 * @return {string}
 * 
 * @customfunction
 * copyright (c) 2023 SoftBank Corp.
 */
function VECTOR_SIMILARITY(VECTOR1, VECTOR2) {

  let vec1
  try {
    vec1 = JSON.parse(VECTOR1)
  }
  catch (e) {
    throw "引数:VECTOR1が不正な値です"
  }

  let vec2
  try {
    vec2 = JSON.parse(VECTOR2)
  }
  catch (e) {
    throw "引数:VECTOR2が不正な値です"
  }

  if (vec1.length != vec2.length) {
    throw "次元数が一致していません"
  }

  // コサイン類似度を計算
  const vec12_dot = vec1.reduce((acc, curr, index) => acc + curr * vec2[index], 0);
  const vec11_dot = vec1.reduce((acc, curr, index) => acc + curr * vec1[index], 0);
  const vec22_dot = vec2.reduce((acc, curr, index) => acc + curr * vec2[index], 0);
  const vec1_l2norm = Math.sqrt(vec11_dot)
  const vec2_l2norm = Math.sqrt(vec22_dot)
  const cos_theta = vec12_dot / (vec1_l2norm * vec2_l2norm)

  return cos_theta
}