CommunityNotesClient

コミュニティノート用クライアント

このクライアントは、X API のコミュニティノート用エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストの整形、レスポンスの解析を行い、コミュニティノートに関連するすべての操作を処理します。

​

コンストラクタ

​

constructor

• new CommunityNotesClient(client): CommunityNotesClient

新しい CommunityNotesClient のインスタンスを作成します

​

パラメーター

Name	Type	Description
client	Client	X API 用のメイン Client インスタンス

​

戻り値

CommunityNotesClient

​

定義元

community_notes/client.ts:186

​

メソッド

​

searchEligiblePosts

▸ searchEligiblePosts(testMode, options): Promise<Response>

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

​

パラメーター

Name	Type	Description
testMode	boolean	true の場合、テスト用の投稿のリストを返します。false の場合、ボットがプロダクトに関する提案ノートを作成できる投稿のリストを返します。
options	SearchEligiblePostsOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response

​

定義場所

community_notes/client.ts:231

▸ searchEligiblePosts(testMode, options?): Promise<Get2NotesSearchPostsEligibleForNotesResponse>

​

パラメーター

名前	type
testMode	boolean
options?	SearchEligiblePostsOptions

​

戻り値

Promise<Get2NotesSearchPostsEligibleForNotesResponse>

​

定義場所

community_notes/client.ts:244

---

​

evaluate

▸ evaluate(options): Promise<Response>

コミュニティノートの評価を行います
コミュニティノートを評価するためのエンドポイントです。

​

パラメータ

名前	type
options	EvaluateOptions & { requestOptions: { raw: true } }

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

​

定義場所

community_notes/client.ts:535

▸ evaluate(options?): Promise<EvaluateNoteResponse>

​

パラメーター

名前	Type
options?	EvaluateOptions

​

戻り値

Promise<EvaluateNoteResponse>

​

定義元

community_notes/client.ts:544

---

​

searchWritten

▸ searchWritten(testMode, options): Promise<Response>

投稿したコミュニティノートを検索します
ユーザーが投稿したすべてのコミュニティノートを返します。

​

パラメーター

名前	type	説明
testMode	boolean	true の場合はテスト用に呼び出し元が作成したノートを返します。false の場合はプロダクト上で呼び出し元が作成したノートを返します。
options	SearchWrittenOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

​

定義場所

community_notes/client.ts:640

▸ searchWritten(testMode, options?): Promise<Get2NotesSearchNotesWrittenResponse>

​

パラメータ

名前	type
testMode	boolean
options?	SearchWrittenOptions

​

戻り値

Promise<Get2NotesSearchNotesWrittenResponse>

​

定義元

community_notes/client.ts:653

---

​

delete

▸ delete(id, options): Promise<Response>

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

​

パラメータ

Name	Type	Description
id	string	削除するコミュニティノートのid。
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Returns

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response を返します

​

定義場所

community_notes/client.ts:826

▸ delete(id): Promise<DeleteNoteResponse>

​

パラメータ

名前	型
id	string

​

戻り値

Promise<DeleteNoteResponse>

​

定義元

community_notes/client.ts:839

---

​

create

▸ create(options): Promise<Response>

コミュニティノートを作成します
LLM のユースケース向けのコミュニティノート作成エンドポイントです。

​

パラメーター

名前	type
options	CreateOptions & { requestOptions: { raw: true } }

​

戻り値

Promise<Response>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response。

​

定義箇所

community_notes/client.ts:926

▸ create(options?): Promise<CreateNoteResponse>

​

パラメーター

名前	type
options?	CreateOptions

​

戻り値

Promise<CreateNoteResponse>

​

定義元

community_notes/client.ts:935