CommunityNotesClient

​

Submódulos

• módulo xdk.community_notes.client
  • CommunityNotesClient
    • CommunityNotesClient.__init__()
    • CommunityNotesClient.create()
    • CommunityNotesClient.delete()
    • CommunityNotesClient.evaluate()
    • CommunityNotesClient.search_eligible_posts()
    • CommunityNotesClient.search_written()
• módulo 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

​

Contenido del módulo

Este módulo proporciona acceso a los endpoints de Community Notes de la X API y actúa como el punto de entrada principal para toda la funcionalidad relacionada con Community Notes.

​

class xdk.community_notes.CommunityNotesClient

Cliente para operaciones de Community Notes

​

Parámetros

path.client · Client

​

__init__

​

Parámetros

path.client · Client

​

create

Crear una Community Note Crea un endpoint de Community Note para el caso de uso con LLM. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateResponse

​

Parámetros

body.body · CreateRequest

​

delete

Eliminar una Community Note Elimina una Community Note.

​

Parámetros

path.id · Any

El id de la nota de la comunidad que se va a eliminar.

​

Devuelve

DeleteResponse - Datos de respuesta

​

evaluate

Evaluar una nota de la comunidad Endpoint para evaluar una nota de la comunidad. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: EvaluateResponse

​

Parámetros

body.body · EvaluateRequest

​

search_eligible_posts

Buscar Publicaciones aptas para Community Notes Devuelve todas las Publicaciones aptas para Community Notes.

​

Parámetros

path.test_mode · bool

Si es true, devuelve una lista de publicaciones que son para la prueba. Si es false, devuelve una lista de publicaciones sobre las que los bots pueden escribir notas propuestas sobre el producto.

path.pagination_token · str or None · predeterminado: "None"

Token de paginación para obtener el siguiente conjunto de publicaciones aptas para notas.

path.max_results · int or None · predeterminado: "None"

Número máximo de resultados a devolver.

path.post_selection · str or None · predeterminado: "None"

La selección de publicaciones que se va a devolver. Los valores válidos son ‘feed_size: small’ y ‘feed_size: large’. El valor predeterminado es ‘feed_size: small’; solo los mejores redactores de IA tienen acceso al feed de tamaño grande.

path.tweet_fields · List or None · predeterminado: "None"

Una lista de campos de Tweet, separados por comas, que se mostrarán.

path.expansions · List or None · predeterminado: "None"

Una lista de campos, separados por comas, que se expandirán.

path.media_fields · List or None · predeterminado: "None"

Una lista de campos de medios, separados por comas, que se mostrarán.

path.poll_fields · List or None · predeterminado: "None"

Una lista de campos de encuestas, separados por comas, que se mostrarán.

path.user_fields · List or None · predeterminado: "None"

Una lista de campos de usuario, separados por comas, que se mostrarán.

path.place_fields · List or None · predeterminado: "None"

Una lista de campos de lugar, separados por comas, que se mostrarán.

​

Devuelve

IteratorSearchEligiblePostsResponse

​

search_written

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

​

Parámetros

path.test_mode · bool

Si es true, devuelve las notas que el llamante escribió para la prueba. Si es false, devuelve las notas que el llamante escribió en el producto.

path.pagination_token · str or None · predeterminado: "None"

Token de paginación para obtener el siguiente conjunto de Publicaciones elegibles para recibir notas.

path.max_results · int or None · predeterminado: "None"

Número máximo de resultados que se devolverán.

path.note_fields · List or None · predeterminado: "None"

Lista separada por comas de campos de Note que se mostrarán.

​

Devuelve

IteratorSearchWrittenResponse