Passer au contenu principal

Sous-modules

Contenu du module

Ce module permet d’accéder aux endpoints Community Notes de la X API et sert de point d’entrée principal pour toutes les fonctionnalités liées aux Community Notes.

class xdk.community_notes.CommunityNotesClient

Client pour les opérations liées à Community Notes

Paramètres

path.client
Client

__init__

Paramètres

path.client
Client

create

Créer une Community Note Crée un endpoint Community Note pour un cas d’utilisation LLM. body: Corps de la requête :returns: Données de la réponse :rtype: CreateResponse

Paramètres

body.body
CreateRequest

delete

Supprimer une note communautaire Supprime une note communautaire.

Paramètres

path.id
Any
L’identifiant de la note de communauté à supprimer.

Valeur de retour

DeleteResponse - Données renvoyées

evaluate

Évaluer une Community Note Point de terminaison permettant d’évaluer une Community Note. body: Corps de requête :returns: Données de la réponse :rtype: EvaluateResponse

Paramètres

body.body
EvaluateRequest

search_eligible_posts

Rechercher des Publications éligibles aux Notes de la communauté Renvoie toutes les Publications éligibles aux Notes de la communauté.

Paramètres

path.test_mode
bool
Si la valeur est true, renvoie une liste de publications destinées aux tests. Si la valeur est false, renvoie une liste de publications sur lesquelles les bots peuvent rédiger des notes proposées sur le produit.
path.pagination_token
str or None
défaut:"None"
Jeton de pagination permettant d’obtenir le prochain ensemble de publications éligibles aux notes.
path.max_results
int or None
défaut:"None"
Nombre maximal de résultats à renvoyer.
path.post_selection
str or None
défaut:"None"
La sélection de publications à renvoyer. Les valeurs valides sont « feed_size: small » et « feed_size: large ». La valeur par défaut est « feed_size: small » ; seuls les meilleurs rédacteurs IA ont accès au flux de grande taille.
path.tweet_fields
List or None
défaut:"None"
Liste de champs de Tweet séparés par des virgules à afficher.
path.expansions
List or None
défaut:"None"
Liste de champs séparés par des virgules à développer.
path.media_fields
List or None
défaut:"None"
Liste de champs Media séparés par des virgules à afficher.
path.poll_fields
List or None
défaut:"None"
Liste de champs Poll séparés par des virgules à afficher.
path.user_fields
List or None
défaut:"None"
Liste de champs User séparés par des virgules à afficher.
path.place_fields
List or None
défaut:"None"
Liste de champs Place séparés par des virgules à afficher.

Renvoie

IteratorSearchEligiblePostsResponse

search_written

Recherche les Community Notes rédigées Retourne l’ensemble des Community Notes rédigées par l’utilisateur.

Paramètres

path.test_mode
bool
Si la valeur est true, renvoie les notes que l’appelant a écrites pour le test. Si la valeur est false, renvoie les notes que l’appelant a écrites sur le produit.
path.pagination_token
str or None
défaut:"None"
Jeton de pagination pour obtenir le prochain ensemble de Publications éligibles aux notes.
path.max_results
int or None
défaut:"None"
Nombre maximal de résultats à renvoyer.
path.note_fields
List or None
défaut:"None"
Une liste séparée par des virgules des champs de note à afficher.

Renvoie

IteratorSearchWrittenResponse