CommunityNotesClient

커뮤니티 노트 관련 작업을 위한 Client

이 Client는 X API의 커뮤니티 노트 엔드포인트와 상호작용하기 위한 메서드를 제공합니다. 인증, 요청 형식 지정, 응답 파싱을 처리하여 커뮤니티 노트와 관련된 모든 작업을 지원합니다.

​

생성자

​

constructor

• new CommunityNotesClient(client): CommunityNotesClient

새 CommunityNotesClient 인스턴스를 생성합니다

​

매개변수

이름	Type	설명
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 } }	-

​

Returns

Promise<Response>

API 응답으로 resolve되는 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 } }

​

Returns

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response입니다

​

정의 위치

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>

사용자가 작성한 Community Notes 검색
사용자가 작성한 모든 Community Notes를 반환합니다.

​

매개변수

이름	type	설명
testMode	boolean	true인 경우 호출자가 테스트용으로 작성한 노트를 반환합니다. false인 경우 호출자가 제품에서 작성한 노트를 반환합니다.
options	SearchWrittenOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다.

​

정의된 위치

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	-

​

반환 값

Promise<Response>

API 응답으로 resolve되는 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 } }

​

Returns

Promise<Response>

API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response

​

정의 위치

community_notes/client.ts:926

▸ create(options?): Promise<CreateNoteResponse>

​

매개변수

이름	type
options?	CreateOptions

​

반환값

Promise<CreateNoteResponse>

​

정의된 위치

community_notes/client.ts:935