CommunityNotesClient

Cliente para operaciones de Community Notes

Este cliente ofrece métodos para interactuar con los endpoints de Community Notes de la X API. Se encarga de la autenticación, el formateo de las solicitudes y el análisis de las respuestas para todas las operaciones relacionadas con Community Notes.

​

Constructores

​

constructor

• new CommunityNotesClient(client): CommunityNotesClient

Crea una nueva instancia de CommunityNotesClient

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal del cliente de la X API

​

Devuelve

CommunityNotesClient

​

Definido en

community_notes/client.ts:120

​

Métodos

​

searchEligiblePosts

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

Buscar Posts aptos para Community Notes Devuelve todos los Posts que cumplen los requisitos para Community Notes.

​

Parámetros

Nombre	Tipo	Descripción
testMode	boolean	Si es true, devuelve una lista de Posts destinados a la prueba. Si es false, devuelve una lista de Posts sobre los que los bots pueden escribir notas propuestas sobre el producto.
options	SearchEligiblePostsOptions	-

​

Devuelve

Promise<Get2NotesSearchPostsEligibleForNotesResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

community_notes/client.ts:137

---

​

searchWritten

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

Buscar notas de la comunidad escritas Devuelve todas las notas de la comunidad que el usuario ha escrito.

​

Parámetros

Nombre	Tipo	Descripción
testMode	boolean	Si es true, devuelve las notas que el llamante escribió para la prueba. Si es false, devuelve las notas que el llamante escribió sobre el producto.
options	SearchWrittenOptions	-

​

Devuelve

Promise<Get2NotesSearchNotesWrittenResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

community_notes/client.ts:231

---

​

delete

▸ delete(id): Promise<DeleteNoteResponse>

Eliminar una nota de la comunidad Elimina una nota de la comunidad.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de la nota de la comunidad que se eliminará.

​

Devuelve

Promise<DeleteNoteResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

community_notes/client.ts:295

---

​

evaluate

▸ evaluate(options?): Promise<EvaluateNoteResponse>

Evaluar una Community Note Punto de conexión para evaluar una Community Note.

​

Parámetros

Nombre	Tipo
options	EvaluateOptions

​

Devuelve

Promise<EvaluateNoteResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

community_notes/client.ts:329

---

​

create

▸ create(options?): Promise<CreateNoteResponse>

Crear una Community Note Crea un endpoint de Community Note para el caso de uso de LLM.

​

Parámetros

Nombre	Tipo
options	CreateOptions

​

Devuelve

Promise<CreateNoteResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

community_notes/client.ts:368