CommunityNotesClient

커뮤니티 노트 작업을 위한 클라이언트

이 클라이언트는 X API의 커뮤니티 노트 엔드포인트와 상호작용하기 위한 메서드를 제공합니다. 커뮤니티 노트 관련 모든 작업에 대해 인증, 요청 서식화, 응답 파싱을 처리합니다.

​

생성자

​

constructor

• new CommunityNotesClient(client): CommunityNotesClient

새 Community Notes 클라이언트 인스턴스를 생성합니다

​

매개변수

이름	유형	설명
client	Client	주 X API 클라이언트 인스턴스

​

반환값

CommunityNotesClient

​

정의됨

community_notes/client.ts:120

​

메서드

​

searchEligiblePosts

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

커뮤니티 노트 적용 대상 Post 검색 커뮤니티 노트 적용 대상인 모든 Post를 반환합니다.

​

매개변수

이름	타입	설명
testMode	boolean	true이면 테스트용 Post 목록을 반환합니다. false이면 봇이 제품에 대한 제안 노트를 작성할 수 있는 Post 목록을 반환합니다.
options	SearchEligiblePostsOptions	-

​

반환

Promise<Get2NotesSearchPostsEligibleForNotesResponse>

API 응답으로 이행되는 Promise

​

정의됨

community_notes/client.ts:137

---

​

searchWritten

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

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

​

매개변수

이름	타입	설명
testMode	boolean	true인 경우 테스트용으로 호출자가 작성한 노트를 반환하고, false인 경우 제품에 대해 호출자가 작성한 노트를 반환합니다.
options	SearchWrittenOptions	-

​

반환

Promise<Get2NotesSearchNotesWrittenResponse>

API 응답으로 resolve되는 Promise

​

정의된 위치

community_notes/client.ts:231

---

​

delete

▸ delete(id): Promise<DeleteNoteResponse>

커뮤니티 노트 삭제 커뮤니티 노트를 삭제합니다.

​

매개변수

이름	유형	설명
id	string	삭제할 커뮤니티 노트의 id입니다.

​

반환

Promise<DeleteNoteResponse>

API 응답으로 완료되는 Promise

​

정의된 위치

community_notes/client.ts:295

---

​

evaluate

▸ evaluate(options?): Promise<EvaluateNoteResponse>

커뮤니티 노트 평가 커뮤니티 노트를 평가하는 엔드포인트입니다.

​

매개변수

이름	타입
options	EvaluateOptions

​

반환

Promise<EvaluateNoteResponse>

API 응답으로 이행되는 Promise

​

정의됨

community_notes/client.ts:329

---

​

create

▸ create(options?): Promise<CreateNoteResponse>

커뮤니티 노트 생성 LLM 사용 사례용 커뮤니티 노트 엔드포인트를 생성합니다.

​

매개변수

이름	타입
options	CreateOptions

​

반환

Promise<CreateNoteResponse>

API 응답으로 해결되는 Promise

​

정의된 위치

community_notes/client.ts:368