Method: projects.locations.collections.engines.conversations.list

親 DataStore ごとにすべての会話を一覧表示します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/conversations

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。データストアのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

クエリ パラメータ

パラメータ
pageSize

integer

ページあたりの結果数の上限です。指定されていない場合、デフォルトは 50 件です。最大許容値は 1,000 です。
pageToken

string

前回の conversations.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。
filter

string

リストの結果に適用するフィルタ。サポートされている機能は、userPseudoId と state です。

例: 「userPseudoId = some_id」
orderBy

string

並べ替えに使用するフィールドのカンマ区切りのリスト（昇順）。降順にするには、フィールド名の後に「desc」を使用します。サポートされているフィールド: * updateTime * createTime * conversation_name

例: 「updateTime desc」、「createTime」

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には ListConversationsResponse のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.conversations.list

詳細については、IAM のドキュメントをご覧ください。