Skip to main content

サブモジュール

モジュールの内容

このモジュールは X API の Community Notes エンドポイントへのアクセスを提供し、 Community Notes 関連機能のメインエントリポイントとして機能します。

class xdk.community_notes.CommunityNotesClient

コミュニティノート機能を操作するための Client

パラメータ

Client

__init__

パラメータ

Client

create

コミュニティノートを作成します LLM のユースケース向けのコミュニティノート作成エンドポイントです。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateResponse

パラメータ

CreateRequest

delete

コミュニティノートを削除 コミュニティノートを削除します。

パラメーター

Any
削除するコミュニティノートのID。

戻り値

DeleteResponse - レスポンスデータ

evaluate

Community Note を評価します Community Note を評価するためのエンドポイントです。 body: リクエストボディ :returns: レスポンスデータ :rtype: EvaluateResponse

パラメータ

EvaluateRequest

search_eligible_posts

コミュニティノートの対象となる投稿を検索します コミュニティノートの対象となるすべての投稿を返します。

Parameters

bool
true の場合、テスト用の投稿のリストを返します。false の場合、ボットがプロダクトに対する提案ノートを書き込むことができる投稿のリストを返します。
str or None
デフォルト:"None"
ノート対象として利用可能な次の投稿セットを取得するためのページネーショントークンです。
int or None
デフォルト:"None"
返却する最大件数です。
str or None
デフォルト:"None"
返却する投稿の選択条件です。有効な値は ‘feed_size: small’ と ‘feed_size: large’ です。デフォルトは ‘feed_size: small’ であり、large サイズのフィードにアクセスできるのは上位の AI ライターのみです。
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りで指定したリストです。
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りで指定したリストです。
List or None
デフォルト:"None"
表示する Media のフィールドをカンマ区切りで指定したリストです。
List or None
デフォルト:"None"
表示する Poll のフィールドをカンマ区切りで指定したリストです。
List or None
デフォルト:"None"
表示する User のフィールドをカンマ区切りで指定したリストです。
List or None
デフォルト:"None"
表示する Place のフィールドをカンマ区切りで指定したリストです。

戻り値

IteratorSearchEligiblePostsResponse

search_written

ユーザーが執筆した Community Notes を検索する ユーザーが執筆したすべての Community Notes を返します。

パラメーター

bool
true の場合、テスト用に呼び出し元が作成したノートを返します。false の場合、本番環境のプロダクトに対して呼び出し元が作成したノートを返します。
str or None
デフォルト:"None"
ノート対象となる投稿の次ページ分を取得するためのページネーショントークン。
int or None
デフォルト:"None"
返却する結果の最大数。
List or None
デフォルト:"None"
表示するノートフィールドのカンマ区切りリスト。

戻り値

IteratorSearchWrittenResponse