メインコンテンツへスキップ

CommunityNotesClient

クラス 基底クラス: object Community Notes の操作を行う Client

コンストラクタ

__init__

パラメーター

path.client
Client

create

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

パラメータ

body.body
CreateRequest

delete

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

パラメーター

path.id
Any
削除対象のコミュニティノートのid。

戻り値

DeleteResponse - レスポンスデータ

evaluate

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

パラメータ

body.body
EvaluateRequest

search_eligible_posts

Community Notes の対象となる投稿を検索します。 Community Notes の対象となるすべての投稿を返します。

パラメーター

path.test_mode
bool
true の場合、テスト用の投稿のリストを返します。false の場合、ボットがプロダクトに関する提案ノートを作成できる投稿のリストを返します。
path.pagination_token
str or None
デフォルト:"None"
ノート対象となる次の投稿セットを取得するためのページネーショントークンです。
path.max_results
int or None
デフォルト:"None"
返却する最大件数です。
path.post_selection
str or None
デフォルト:"None"
返却対象とする投稿の種別です。有効な値は「feed_size: small」と「feed_size: large」です。デフォルトは「feed_size: small」であり、大きいサイズのフィードには上位の AI ライターのみがアクセスできます。
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りのリストで指定します。
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
path.media_fields
List or None
デフォルト:"None"
表示するメディアのフィールドをカンマ区切りのリストで指定します。
path.poll_fields
List or None
デフォルト:"None"
表示する投票のフィールドをカンマ区切りのリストで指定します。
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドをカンマ区切りのリストで指定します。
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドをカンマ区切りのリストで指定します。

戻り値

IteratorSearchEligiblePostsResponse

search_written

作成済みのCommunity Notesを検索します。 ユーザーが作成したすべてのCommunity Notesを返します。

パラメータ

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

戻り値

IteratorSearchWrittenResponse