コンストラクタ
constructor
client): CommunityNotesClient
Community Notes クライアントの新しいインスタンスを作成します
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
client | Client | X API のメインクライアントインスタンス |
戻り値
CommunityNotesClient
定義元
community_notes/client.ts:120メソッド
searchEligiblePosts
testMode, options?): Promise<Get2NotesSearchPostsEligibleForNotesResponse>
コミュニティノートの対象となるPostを検索します
コミュニティノートの対象となるすべてのPostを返します。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
testMode | boolean | true の場合はテスト用の Post の一覧を返します。false の場合は、ボットが製品に対して提案ノートを作成できる Post の一覧を返します。 |
options | SearchEligiblePostsOptions | - |
返り値
Promise<Get2NotesSearchPostsEligibleForNotesResponse>
API レスポンスを返す Promise
定義箇所
searchWritten
testMode, options?): Promise<Get2NotesSearchNotesWrittenResponse>
Community Notesの投稿履歴を検索
ユーザーが作成したCommunity Notesをすべて返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
testMode | boolean | true の場合はテスト用に呼び出し元が作成したノートを返し、false の場合は製品に対して呼び出し元が作成したノートを返します。 |
options | SearchWrittenOptions | - |
戻り値
Promise<Get2NotesSearchNotesWrittenResponse>
API レスポンスで解決される Promise
定義元
community_notes/client.ts:231delete
id): Promise<DeleteNoteResponse>
コミュニティノートを削除
コミュニティノートを削除します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
id | string | 削除するコミュニティノートのid。 |
戻り値
Promise<DeleteNoteResponse>
API レスポンスで解決される Promise
定義場所
community_notes/client.ts:295evaluate
options?): Promise<EvaluateNoteResponse>
コミュニティノートを評価
コミュニティノートを評価するためのエンドポイントです。
パラメータ
| 名前 | 型 |
|---|---|
options | EvaluateOptions |
戻り値
Promise<EvaluateNoteResponse>
API レスポンスで解決される Promise
定義場所
community_notes/client.ts:329create
options?): Promise<CreateNoteResponse>
コミュニティノートの作成
LLM のユースケース向けにコミュニティノート用エンドポイントを作成します。
パラメータ
| 名称 | 型 |
|---|---|
options | CreateOptions |
戻り値
Promise<CreateNoteResponse>
API レスポンスを返す Promise