ऑब्जेक्ट
Card
फ़ील्ड
expandedCardExpandedpermissionsObjectPermissionListaccessstringमान्य मान:
wholepartialaccess_contactstringऐक्सेस के लिए किससे संपर्क करें (सिर्फ़
access=partialहोने पर)।aclobjectफ़ील्ड
verifybooleanज़रूरीwritebooleanज़रूरी
categorystringज़रूरीcategory_confidencenumber | nullज़रूरीcategory_lockedbooleanज़रूरीcategory_reviewbooleanज़रूरीcollectionstringज़रूरीcollection_idintegerज़रूरीcollection_titlestringcommentsarray of CardCommentcontent_jsonContentJSON | nullनवीनतम प्रकाशित वर्शन का एडिटर कंटेंट। यह फ़ील्ड न भी हो सकता है; उस स्थिति में एडिटर कंटेंट ड्राफ़्ट से लें (
card_idके साथPOST /v1/drafts)।editing_lockEditingLock | nullएडिटिंग का सक्रिय लॉक। यह फ़ील्ड न भी हो सकता है; उस स्थिति में एडिटर को
POST /v1/cards/{card_id}/lockपर मिले409 cards.lockedसे पता चलता है कि लॉक किसके पास है।created_atstring (date-time)ज़रूरीdays_since_verifiedintegerज़रूरीerrorstring | nullज़रूरीeventsarray of CardEventfeedback_negintegerज़रूरीfeedback_posintegerज़रूरीfoldersarray of CardFolderRefसिर्फ़ कार्ड की सूची में: वे फ़ोल्डर, जिनमें कार्ड है (जो यूज़र को दिखते हैं), कलेक्शन के रूट से उनके पाथ के साथ। ख़ाली सूची का मतलब है कि कार्ड किसी फ़ोल्डर में नहीं है।
has_tablesbooleanसिर्फ़ कार्ड की सूची में।
hidden_partsbooleanidstringज़रूरीjobJob | nullorg_idintegerज़रूरीowner_activeboolean | nullowner_idinteger | nullज़रूरीowner_namestring | nullज़रूरीpagesinteger | nullज़रूरीparserstring | nullज़रूरीन्यूट्रल कोड के रूप में दस्तावेज़ पार्सर:
document(पूरी संरचना: पेज, शीर्षक, टेबल, स्कैन किए गए पेज),pdf(PDF की टेक्स्ट लेयर),docx,xlsx,csv,markdown,html,text। यह सूची बढ़ सकती है।sensitivebooleanज़रूरीsha256string | nullज़रूरीsizeintegerज़रूरीsnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleanज़रूरीsource_pathstring | nullज़रूरीsource_urlstring | nullज़रूरीstatusstringज़रूरीमान्य मान:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringज़रूरीtitlestringज़रूरीtrustnumberज़रूरीtrust_if_verifiednumberupdated_atstring (date-time)ज़रूरीverified_atstring (date-time) | nullज़रूरीverified_byinteger | nullज़रूरीverified_by_namestring | nullverifier_idsarray of integerज़रूरीverifiersarray of objectफ़ील्ड
activebooleanज़रूरीidintegerज़रूरीnamestringज़रूरी
verify_interval_daysintegerज़रूरीversionintegerज़रूरीversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectपार्सिंग की मैन्युअल सेटिंग्स (प्रीव्यू)।
doc_kindDocKind | nullदस्तावेज़ का टाइप। टाइप तय न हो, तो
null(उदाहरण के लिए, उन कार्ड के लिए, जो दस्तावेज़ टाइप आने से पहले इंडेक्स हुए थे)।doc_kind_confidencenumber | nullदस्तावेज़ के टाइप पर भरोसे का स्तर, 0 से 1 तक।
doc_kind_sourcestring | nullटाइप किसने तय किया: नियम (
rules), यूज़र (manual) या अपने-आप होने वाला वर्गीकरण। यह सूची बढ़ सकती है: अज्ञात मान को अपने-आप होने वाला वर्गीकरण मानें।मान्य मान:
rulesmanualnullinvoiceDocInvoiceExtraction | nullइनवॉइस, क्रेडिट नोट या रसीद के फ़ील्ड (सिर्फ़ इन टाइप के लिए, और सिर्फ़ कार्ड में, सूची में नहीं)। अगर आपके पास पूरे दस्तावेज़ का ऐक्सेस नहीं है, तो
null, क्योंकि फ़ील्ड पूरे दस्तावेज़ से निकाले जाते हैं।warningsarray of ReviewWarningदस्तावेज़ पार्सिंग की चेतावनियाँ (
ReviewWarning; सिर्फ़ कार्ड में, सूची में नहीं)।enrichmentCardEnrichmentStatus | nullएनरिचमेंट का स्टेटस (सिर्फ़ कार्ड में, सूची में नहीं)। दस्तावेज़ का टाइप, इनवॉइस के फ़ील्ड और वित्तीय रिकॉर्ड इंडेक्सिंग के बाद बैकग्राउंड में जोड़े जाते हैं और बाद में दोबारा गिने जा सकते हैं; तैयार होने पर वे कार्ड में दिखते हैं।
nullका मतलब है कि कोई स्टेटस उपलब्ध नहीं है (कार्ड बैकग्राउंड एनरिचमेंट के बिना इंडेक्स हुआ था)।external_idstring | nullइंटीग्रेटर के सिस्टम में कार्ड का ID। यह संगठन में उन कार्ड के बीच यूनीक होता है, जो स्रोतों से नहीं आते;
nullका मतलब है कि यह सेट नहीं है।/v1/cards-by-external-id/{external_id}इसी से कार्ड पढ़ता और बदलता है।length ≤ 512
metadataMetadata
इनमें इस्तेमाल
- GET
/v1/cards/{card_id}कार्ड को उसके वर्शन, कमेंट, टेबल और इवेंट के साथ पाएँ - PATCH
/v1/cards/{card_id}कार्ड बदलें - GET
/v1/cards-by-external-id/{external_id}बाहरी ID से कार्ड पाएँ - POST
/v1/cards/{card_id}/verifyपुष्टि करें कि कार्ड अप-टू-डेट है
इसका हिस्सा
CardListJobActionResultJobExpandedJobWithCardPushDocumentStatusExpandedReindexResultTasksDetailTasksLegacyTextCardResultUploadResult