CommunityNotesClient

​

하위 모듈

• xdk.community_notes.client 모듈
  • CommunityNotesClient
    • CommunityNotesClient.__init__()
    • CommunityNotesClient.create()
    • CommunityNotesClient.delete()
    • CommunityNotesClient.evaluate()
    • CommunityNotesClient.search_eligible_posts()
    • CommunityNotesClient.search_written()
• xdk.community_notes.models 모듈
  • CreateRequest
    • CreateRequest.model_config
  • CreateResponse
    • CreateResponse.model_config
  • DeleteResponse
    • DeleteResponse.model_config
  • EvaluateRequest
    • EvaluateRequest.model_config
  • EvaluateResponse
    • EvaluateResponse.model_config
  • SearchEligiblePostsResponse
    • SearchEligiblePostsResponse.model_config
  • SearchWrittenResponse
    • SearchWrittenResponse.model_config

​

모듈 내용

이 모듈은 X API의 커뮤니티 노트 엔드포인트에 대한 접근을 제공하며, 커뮤니티 노트 관련 모든 기능의 주요 진입점 역할을 합니다.

​

class xdk.community_notes.CommunityNotesClient

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

​

매개변수

path.client · Client

​

__init__

​

매개변수

path.client · Client

​

create

커뮤니티 노트 생성 LLM 유스 케이스를 위한 커뮤니티 노트 엔드포인트를 생성합니다. body: 요청 본문 :returns: 응답 데이터 :rtype: CreateResponse

​

매개변수

body.body · CreateRequest

​

delete

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

​

매개변수

path.id · Any

삭제할 커뮤니티 노트의 id입니다.

​

반환값

DeleteResponse - 응답 데이터

​

evaluate

커뮤니티 노트를 평가합니다 커뮤니티 노트를 평가하기 위한 엔드포인트입니다. body: 요청 본문 :returns: 응답 데이터 :rtype: EvaluateResponse

​

매개변수

body.body · EvaluateRequest

​

search_eligible_posts

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

​

매개변수

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’이며, large 크기 피드에는 상위 AI 작성자만 접근할 수 있습니다.

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드를 쉼표로 구분한 목록입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드를 쉼표로 구분한 목록입니다.

path.media_fields · List or None · 기본값: "None"

표시할 Media 필드를 쉼표로 구분한 목록입니다.

path.poll_fields · List or None · 기본값: "None"

표시할 Poll 필드를 쉼표로 구분한 목록입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드를 쉼표로 구분한 목록입니다.

path.place_fields · List or None · 기본값: "None"

표시할 Place 필드를 쉼표로 구분한 목록입니다.

​

반환값

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"

표시할 노트 필드의 쉼표로 구분된 목록입니다.

​

반환값

IteratorSearchWrittenResponse