View a markdown version of this page

レコメンデーションを取得する - Amazon Bedrock AgentCore
コードサンプルリクエストパラメータ[応答]エラー

レコメンデーションを取得する

アカウント内のすべてのレコメンデーションを一覧表示します。結果はページ分割され、ステータスでフィルタリングできます。

コードサンプル

例
AgentCore CLI

過去のレコメンデーションジョブを一覧表示する (実行中のジョブは サービスから更新されます）。

agentcore view recommendation

ID 別に 1 つのレコメンデーションを表示します。

agentcore view recommendation <recommendation-id>

機械読み取り可能な出力--jsonに を追加します。

agentcore view recommendation --json
AWS SDK (boto3)
import boto3

client = boto3.client("bedrock-agentcore", region_name="us-west-2")

# List all recommendations
response = client.list_recommendations()
for rec in response["recommendationSummaries"]:
    print(f"{rec['recommendationId']} | {rec['name']} | {rec['type']} | {rec['status']}")

ステータスでフィルタリング:

response = client.list_recommendations(statusFilter="COMPLETED")

for rec in response["recommendationSummaries"]:
    print(f"{rec['recommendationId']}  {rec['name']}  {rec['status']}")

すべての結果をページ分割します。

paginator = client.get_paginator("list_recommendations")
for page in paginator.paginate(statusFilter="COMPLETED"):
    for rec in page["recommendationSummaries"]:
        print(rec["recommendationId"])

リクエストパラメータ

パラメータ タイプ 必須 説明

maxResults

整数

いいえ

ページあたりの結果の最大数。範囲: 1～100。

nextToken

String

いいえ

前のレスポンスからのページ分割トークン。

statusFilter

String

いいえ

ステータスでフィルタリングします。次のいずれか: PENDING、IN_PROGRESS、、COMPLETEDFAILED、、DELETING。

[応答]

フィールド タイプ 説明

recommendationSummaries

[List] (リスト)

推奨事項の概要のリスト。

nextToken

String

次のページのページ分割トークン。結果がない場合には存在しません。

レコメンデーションの概要フィールド

フィールド タイプ 説明

recommendationId

文字列

一意の識別子。

recommendationArn

String

レコメンデーションの ARN。

name

String

レコメンデーション名。

description

String

オプションの説明が指定されている場合。

type

String

SYSTEM_PROMPT_RECOMMENDATION または TOOL_DESCRIPTION_RECOMMENDATION

status

String

現在のステータス: PENDING、IN_PROGRESS、COMPLETED、FAILED、DELETING。

createdAt

タイムスタンプ

レコメンデーションが作成された日時。

updatedAt

タイムスタンプ

レコメンデーションが最後に更新された日時。

レコメンデーションの完全な詳細と結果を取得するには、 でレコメンデーションを取得するを使用しますrecommendationId。

エラー

エラー HTTP ステータス 説明

ValidationException

400

ページ分割パラメータまたはステータスフィルター値が無効です。

AccessDeniedException

403

アクセス許可が不十分です。

ThrottlingException

429

リクエストレートを超えました。

InternalServerException

500

サービス側のエラー。