Amazon Titan Embeddings Text
Titan Embeddings G1 - Text は推論パラメータの使用をサポートしていません。以下のセクションでは、リクエストとレスポンスの形式を詳述し、コード例を示します。
リクエストとレスポンス
リクエスト本文は InvokeModel リクエストの body フィールドに渡されます。
- V2 Request
-
inputText パラメータは必須です。normalize および dimensions パラメータはオプションです。
-
inputText – 埋め込みに変換するテキストを入力します。
-
normalize – (オプション) 出力埋め込みを正規化するかどうかを示すフラグです。デフォルトは true です。
-
dimensions – (オプション) 出力埋め込みに必要なディメンション数です。1024 (デフォルト値)、512、256 の値を使用できます。
-
embeddingTypes – (オプション) 「float」、「binary」、またはその両方を含むリストを承認します。デフォルトは
floatです。
{ "inputText": string, "dimensions": int, "normalize": boolean, "embeddingTypes": list } -
- V2 Response
-
フィールドについて以下に説明します。
-
embedding – 指定した入力の埋め込みベクトルを表す配列です。これは常に、タイプ
floatです。 -
inputTextTokenCount – 入力内のトークン数です。
-
embeddingsByType – 埋め込みリストのディクショナリまたはマップです。入力に応じて、「float」、「binary」、またはその両方を一覧表示します。
-
例：
"embeddingsByType": {"binary": [int,..], "float": [float,...]} -
このフィールドは常に表示されます。入力で
embeddingTypesを指定しなくても、「float」は表示されます。例："embeddingsByType": {"float": [float,...]}
-
{ "embedding": [float, float, ...], "inputTextTokenCount": int, "embeddingsByType": {"binary": [int,..], "float": [float,...]} } -
- G1 Request
-
使用可能なフィールドは、
inputTextのみで、これには、埋め込みに変換されるテキストが含まれます。{ "inputText": string } - G1 Response
-
レスポンスの
bodyには、次のフィールドが含まれます。{ "embedding": [float, float, ...], "inputTextTokenCount": int }フィールドについて以下に説明します。
-
embedding – 指定した入力の埋め込みベクトルを表す配列です。
-
inputTextTokenCount – 入力内のトークン数です。
-
サンプルのコード
次の例は、Amazon Titan 埋め込みモデルを呼び出して埋め込みを生成する方法を示しています。使用しているモデルに対応するタブを選択します。
- Amazon Titan Embeddings G1 - Text
-
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: Apache-2.0 """ Shows how to generate embeddings with the Amazon Titan Embeddings G1 - Text model (on demand). """ import json import logging import boto3 from botocore.exceptions import ClientError logger = logging.getLogger(__name__) logging.basicConfig(level=logging.INFO) def generate_embeddings(model_id, body): """ Generate a vector of embeddings for a text input using Amazon Titan Embeddings G1 - Text on demand. Args: model_id (str): The model ID to use. body (str) : The request body to use. Returns: response (JSON): The embedding created by the model and the number of input tokens. """ logger.info("Generating embeddings with Amazon Titan Embeddings G1 - Text model %s", model_id) bedrock = boto3.client(service_name='bedrock-runtime') accept = "application/json" content_type = "application/json" response = bedrock.invoke_model( body=body, modelId=model_id, accept=accept, contentType=content_type ) response_body = json.loads(response.get('body').read()) return response_body def main(): """ Entrypoint for Amazon Titan Embeddings G1 - Text example. """ logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s") model_id = "amazon.titan-embed-text-v1" input_text = "What are the different services that you offer?" # Create request body. body = json.dumps({ "inputText": input_text, }) try: response = generate_embeddings(model_id, body) print(f"Generated embeddings: {response['embedding']}") print(f"Input Token count: {response['inputTextTokenCount']}") except ClientError as err: message = err.response["Error"]["Message"] logger.error("A client error occurred: %s", message) print("A client error occured: " + format(message)) else: print(f"Finished generating embeddings with Amazon Titan Embeddings G1 - Text model {model_id}.") if __name__ == "__main__": main() - Amazon Titan Text Embeddings V2
-
Titan Text Embeddings V2 を使用する際に、
embeddingTypesにbinaryが含まれる場合は、embeddingフィールドはレスポンスに表示されません。# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: Apache-2.0 """ Shows how to generate embeddings with the Amazon Titan Text Embeddings V2 Model """ import json import logging import boto3 from botocore.exceptions import ClientError logger = logging.getLogger(__name__) logging.basicConfig(level=logging.INFO) def generate_embeddings(model_id, body): """ Generate a vector of embeddings for a text input using Amazon Titan Text Embeddings G1 on demand. Args: model_id (str): The model ID to use. body (str) : The request body to use. Returns: response (JSON): The embedding created by the model and the number of input tokens. """ logger.info("Generating embeddings with Amazon Titan Text Embeddings V2 model %s", model_id) bedrock = boto3.client(service_name='bedrock-runtime') accept = "application/json" content_type = "application/json" response = bedrock.invoke_model( body=body, modelId=model_id, accept=accept, contentType=content_type ) response_body = json.loads(response.get('body').read()) return response_body def main(): """ Entrypoint for Amazon Titan Embeddings V2 - Text example. """ logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s") model_id = "amazon.titan-embed-text-v2:0" input_text = "What are the different services that you offer?" # Create request body. body = json.dumps({ "inputText": input_text, "embeddingTypes": ["binary"] }) try: response = generate_embeddings(model_id, body) print(f"Generated embeddings: {response['embeddingByTypes']['binary']}") # returns binary embedding # print(f"Generated embeddings: {response['embedding']}") NOTE:"embedding" field is not in "response". print(f"Input Token count: {response['inputTextTokenCount']}") except ClientError as err: message = err.response["Error"]["Message"] logger.error("A client error occurred: %s", message) print("A client error occured: " + format(message)) else: print(f"Finished generating embeddings with Amazon Titan Text Embeddings V2 model {model_id}.") if __name__ == "__main__": main()
