मुख्य सामग्री पर जाएं
कम्युनिटी नोट्स ऑपरेशनों के लिए क्लाइंट यह क्लाइंट X API के कम्युनिटी नोट्स एंडपॉइंट्स के साथ इंटरैक्ट करने के लिए मेथड उपलब्ध कराता है। यह कम्युनिटी नोट्स से जुड़े सभी ऑपरेशनों के लिए प्रमाणीकरण, अनुरोध फ़ॉर्मैटिंग और रिस्पॉन्स पार्सिंग को संभालता है।

कंस्ट्रक्टर्स

constructor

new CommunityNotesClient(client): CommunityNotesClient कम्युनिटी नोट्स Client का एक नया इंस्टेंस बनाता है

पैरामीटर

नामtypeविवरण
clientClientमुख्य X API Client इंस्टेंस

रिटर्न

CommunityNotesClient

यहाँ परिभाषित है

community_notes/client.ts:186

मेथड्स

searchEligiblePosts

searchEligiblePosts(testMode, options): Promise<Response> कम्युनिटी नोट्स के लिए पात्र पोस्ट्स खोजता है उन सभी पोस्ट्स को लौटाता है जो कम्युनिटी नोट्स के लिए पात्र हैं।

पैरामीटर

NameTypeDescription
testModebooleanयदि true है, तो परीक्षण के लिए पोस्ट्स की एक सूची लौटाएँ। यदि false है, तो उन पोस्ट्स की एक सूची लौटाएँ जिन पर बॉट्स प्रोडक्ट के लिए प्रस्तावित नोट्स लिख सकते हैं।
optionsSearchEligiblePostsOptions & { requestOptions: { raw: true } }-

रिटर्न

Promise<Response> वह Promise जो API रिस्पॉन्स पर resolve होता है, या यदि requestOptions.raw true है, तो raw Response पर

यहाँ परिभाषित है

community_notes/client.ts:231 searchEligiblePosts(testMode, options?): Promise<Get2NotesSearchPostsEligibleForNotesResponse>

पैरामीटर

नामtype
testModeboolean
options?SearchEligiblePostsOptions

रिटर्न

Promise<Get2NotesSearchPostsEligibleForNotesResponse>

यहाँ परिभाषित है

community_notes/client.ts:244

evaluate

evaluate(options): Promise<Response> किसी कम्युनिटी नोट का मूल्यांकन करें कम्युनिटी नोट का मूल्यांकन करने के लिए एंडपॉइंट।

पैरामीटर

नामtype
optionsEvaluateOptions & { requestOptions: { raw: true } }

रिटर्न

Promise<Response> API रिस्पॉन्स पर रिज़ॉल्व होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

यहाँ परिभाषित है

community_notes/client.ts:535 evaluate(options?): Promise<EvaluateNoteResponse>

पैरामीटर

नामtype
options?EvaluateOptions

रिटर्न

Promise<EvaluateNoteResponse>

यहाँ परिभाषित है

community_notes/client.ts:544

searchWritten

searchWritten(testMode, options): Promise<Response> लिखे गए कम्युनिटी नोट्स खोजता है उपयोगकर्ता द्वारा लिखे गए सभी कम्युनिटी नोट्स लौटाता है।

पैरामीटर

नामtypeविवरण
testModebooleanयदि true है, तो परीक्षण के लिए कॉलर द्वारा लिखे गए notes लौटाएँ। यदि false है, तो product पर कॉलर द्वारा लिखे गए notes लौटाएँ।
optionsSearchWrittenOptions & { requestOptions: { raw: true } }-

रिटर्न

Promise<Response> ऐसा Promise जो API रिस्पॉन्स पर रिज़ॉल्व होता है, या यदि requestOptions.raw true है, तो raw Response

यहाँ परिभाषित है

community_notes/client.ts:640 searchWritten(testMode, options?): Promise<Get2NotesSearchNotesWrittenResponse>

पैरामीटर

नामtype
testModeboolean
options?SearchWrittenOptions

रिटर्न

Promise<Get2NotesSearchNotesWrittenResponse>

यहाँ परिभाषित है

community_notes/client.ts:653

delete

delete(id, options): Promise<Response> किसी कम्युनिटी नोट को हटाएँ यह किसी कम्युनिटी नोट को हटाता है।

पैरामीटर

नामtypeविवरण
idstringहटाई जाने वाली कम्युनिटी नोट की id।
optionsObject-
options.requestOptionsObject-
options.requestOptions.rawtrue-

रिटर्न

Promise<Response> API रिस्पॉन्स पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

यहाँ परिभाषित है

community_notes/client.ts:826 delete(id): Promise<DeleteNoteResponse>

पैरामीटर

नामप्रकार
idstring

रिटर्न

Promise<DeleteNoteResponse>

यहाँ परिभाषित है

community_notes/client.ts:839

create

create(options): Promise<Response> एक कम्युनिटी नोट बनाएँ यह LLM उपयोग के मामले के लिए कम्युनिटी नोट endpoint बनाता है।

पैरामीटर

नामtype
optionsCreateOptions & { requestOptions: { raw: true } }

रिटर्न

Promise<Response> API रिस्पॉन्स पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

यहाँ परिभाषित है

community_notes/client.ts:926 create(options?): Promise<CreateNoteResponse>

पैरामीटर

नामtype
options?CreateOptions

रिटर्न

Promise<CreateNoteResponse>

यहाँ परिभाषित है

community_notes/client.ts:935