{"id":"citation-record-key","version":"1.0.0","description":"Compute transparent deterministic match keys (DOI key and folded year|author|title key) for one CSL citation record.","supported_operations":["compute a deterministic match key for a citation record","case-insensitive DOI key for comparing references","accent and case folded title key for a bibliography entry","year author title fingerprint for a CSL-JSON item","explain which fields a citation match key was built from","מפתח התאמה דטרמיניסטי לרשומת ציטוט"],"unsupported_operations":["deciding that two works are the same publication with certainty","fuzzy or similarity matching of titles (edit distance, n-grams)","network lookup of DOI metadata","language-aware stop-word or article removal from titles"],"semantics":["The record is first validated and normalized exactly as citation-record-normalize does (same errors and limits).","doi_key = \"doi:\" + the normalized DOI with ASCII a-z upper-cased and every other character unchanged (DOI Handbook section 3.3.4: DOI names are case-insensitive for Basic Latin letters only); null without a DOI.","Folding for keys: NFKC; String.prototype.toLowerCase (Unicode default full lowercase mapping with Final_Sigma; not CaseFolding.txt, so U+00DF stays); NFKD; remove every p{M} mark; replace each run of code points that are not p{L} or p{N} with one space; trim; NFC. Unicode tables come from the runtime.","metadata_key = \"meta:\" + year + \"|\" + first_author + \"|\" + title: year is issued.date_parts[0][0] as a base-10 string (empty if absent); first_author is the fold of the first remaining author name's family, else literal, else given (empty if absent); title is the fold of title. metadata_key is null when there is no title or it folds to empty. Every key is at most 2060 code points.","match_key is doi_key when the record has a DOI, else metadata_key, else null; key_type is doi, metadata or none accordingly. components show the exact folded inputs (null when absent).","Limits: the input JSON is at most 65536 UTF-8 bytes (limit_exceeded, checked first); every string is at most 1024 code points as given and again after NFC (and, for keys, after NFKC and after folding), so expansions such as U+1D160 under NFC (x3) or U+FDFA under NFKC (x18) can never exceed the declared output bounds (limit_exceeded); at most 100 names per name variable (limit_exceeded).","Keys are transparent heuristics for grouping, not bibliographic verification: equal keys do not prove two records describe the same work, and different keys do not prove they differ."],"limits":{"max_input_bytes":65536,"max_field_chars":1024,"max_names":100},"pricing":{"status":"unpriced","charge_usd":null},"input_schema":{"type":"object","additionalProperties":false,"properties":{"record":{"type":"object","additionalProperties":false,"properties":{"id":{"type":["string","integer"],"maxLength":1024},"type":{"type":"string","enum":["article","article-journal","article-magazine","article-newspaper","bill","book","broadcast","chapter","classic","collection","dataset","document","entry","entry-dictionary","entry-encyclopedia","event","figure","graphic","hearing","interview","legal_case","legislation","manuscript","map","motion_picture","musical_score","pamphlet","paper-conference","patent","performance","periodical","personal_communication","post","post-weblog","regulation","report","review","review-book","software","song","speech","standard","thesis","treaty","webpage"]},"abstract":{"type":"string","maxLength":1024},"annote":{"type":"string","maxLength":1024},"archive":{"type":"string","maxLength":1024},"archive_collection":{"type":"string","maxLength":1024},"archive_location":{"type":"string","maxLength":1024},"archive_place":{"type":"string","maxLength":1024},"authority":{"type":"string","maxLength":1024},"call_number":{"type":"string","maxLength":1024},"citation_key":{"type":"string","maxLength":1024},"citation_label":{"type":"string","maxLength":1024},"collection_title":{"type":"string","maxLength":1024},"container_title":{"type":"string","maxLength":1024},"container_title_short":{"type":"string","maxLength":1024},"dimensions":{"type":"string","maxLength":1024},"division":{"type":"string","maxLength":1024},"doi":{"type":"string","maxLength":1024},"event":{"type":"string","maxLength":1024},"event_title":{"type":"string","maxLength":1024},"event_place":{"type":"string","maxLength":1024},"genre":{"type":"string","maxLength":1024},"isbn":{"type":"string","maxLength":1024},"issn":{"type":"string","maxLength":1024},"jurisdiction":{"type":"string","maxLength":1024},"keyword":{"type":"string","maxLength":1024},"language":{"type":"string","maxLength":1024},"license":{"type":"string","maxLength":1024},"medium":{"type":"string","maxLength":1024},"note":{"type":"string","maxLength":1024},"original_publisher":{"type":"string","maxLength":1024},"original_publisher_place":{"type":"string","maxLength":1024},"original_title":{"type":"string","maxLength":1024},"part_title":{"type":"string","maxLength":1024},"pmcid":{"type":"string","maxLength":1024},"pmid":{"type":"string","maxLength":1024},"publisher":{"type":"string","maxLength":1024},"publisher_place":{"type":"string","maxLength":1024},"references":{"type":"string","maxLength":1024},"reviewed_genre":{"type":"string","maxLength":1024},"reviewed_title":{"type":"string","maxLength":1024},"scale":{"type":"string","maxLength":1024},"source":{"type":"string","maxLength":1024},"status":{"type":"string","maxLength":1024},"title":{"type":"string","maxLength":1024},"title_short":{"type":"string","maxLength":1024},"url":{"type":"string","maxLength":1024},"volume_title":{"type":"string","maxLength":1024},"chapter_number":{"type":["string","integer"],"maxLength":1024},"collection_number":{"type":["string","integer"],"maxLength":1024},"edition":{"type":["string","integer"],"maxLength":1024},"issue":{"type":["string","integer"],"maxLength":1024},"number":{"type":["string","integer"],"maxLength":1024},"number_of_pages":{"type":["string","integer"],"maxLength":1024},"number_of_volumes":{"type":["string","integer"],"maxLength":1024},"page":{"type":["string","integer"],"maxLength":1024},"page_first":{"type":["string","integer"],"maxLength":1024},"part_number":{"type":["string","integer"],"maxLength":1024},"printing_number":{"type":["string","integer"],"maxLength":1024},"section":{"type":["string","integer"],"maxLength":1024},"supplement_number":{"type":["string","integer"],"maxLength":1024},"version":{"type":["string","integer"],"maxLength":1024},"volume":{"type":["string","integer"],"maxLength":1024},"accessed":{"type":"object","additionalProperties":false,"properties":{"date_parts":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"array","minItems":1,"maxItems":3,"items":{"type":["integer","string"]}}},"season":{"type":["integer","string"]},"circa":{"type":"boolean"},"literal":{"type":"string","maxLength":1024},"raw":{"type":"string","maxLength":1024}}},"available_date":{"type":"object","additionalProperties":false,"properties":{"date_parts":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"array","minItems":1,"maxItems":3,"items":{"type":["integer","string"]}}},"season":{"type":["integer","string"]},"circa":{"type":"boolean"},"literal":{"type":"string","maxLength":1024},"raw":{"type":"string","maxLength":1024}}},"event_date":{"type":"object","additionalProperties":false,"properties":{"date_parts":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"array","minItems":1,"maxItems":3,"items":{"type":["integer","string"]}}},"season":{"type":["integer","string"]},"circa":{"type":"boolean"},"literal":{"type":"string","maxLength":1024},"raw":{"type":"string","maxLength":1024}}},"issued":{"type":"object","additionalProperties":false,"properties":{"date_parts":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"array","minItems":1,"maxItems":3,"items":{"type":["integer","string"]}}},"season":{"type":["integer","string"]},"circa":{"type":"boolean"},"literal":{"type":"string","maxLength":1024},"raw":{"type":"string","maxLength":1024}}},"original_date":{"type":"object","additionalProperties":false,"properties":{"date_parts":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"array","minItems":1,"maxItems":3,"items":{"type":["integer","string"]}}},"season":{"type":["integer","string"]},"circa":{"type":"boolean"},"literal":{"type":"string","maxLength":1024},"raw":{"type":"string","maxLength":1024}}},"submitted":{"type":"object","additionalProperties":false,"properties":{"date_parts":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"array","minItems":1,"maxItems":3,"items":{"type":["integer","string"]}}},"season":{"type":["integer","string"]},"circa":{"type":"boolean"},"literal":{"type":"string","maxLength":1024},"raw":{"type":"string","maxLength":1024}}},"author":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"chair":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"collection_editor":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"compiler":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"composer":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"container_author":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"contributor":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"curator":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"director":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"editor":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"editorial_director":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"editor_translator":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"executive_producer":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"guest":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"host":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"illustrator":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"interviewer":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"narrator":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"organizer":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"original_author":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"performer":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"producer":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"recipient":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"reviewed_author":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"script_writer":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"series_creator":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}},"translator":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"properties":{"family":{"type":"string","maxLength":1024},"given":{"type":"string","maxLength":1024},"dropping_particle":{"type":"string","maxLength":1024},"non_dropping_particle":{"type":"string","maxLength":1024},"suffix":{"type":"string","maxLength":1024},"literal":{"type":"string","maxLength":1024},"comma_suffix":{"type":"boolean"},"static_ordering":{"type":"boolean"},"parse_names":{"type":"boolean"}}}}},"required":["id","type"]}},"required":["record"]},"output_schema":{"type":"object","additionalProperties":false,"properties":{"match_key":{"type":["string","null"],"maxLength":2060},"key_type":{"type":"string","enum":["doi","metadata","none"]},"doi_key":{"type":["string","null"],"maxLength":2060},"metadata_key":{"type":["string","null"],"maxLength":2060},"components":{"type":"object","additionalProperties":false,"properties":{"doi":{"type":["string","null"],"minLength":1,"maxLength":1024},"year":{"type":["string","null"],"pattern":"^-?[0-9]{1,4}$"},"first_author":{"type":["string","null"],"minLength":1,"maxLength":1024},"title":{"type":["string","null"],"minLength":1,"maxLength":1024}},"required":["doi","year","first_author","title"]}},"required":["match_key","key_type","doi_key","metadata_key","components"]},"examples":[{"input":{"record":{"id":"r1","type":"article-journal","doi":"10.123/abc","title":"Example"}},"output":{"match_key":"doi:10.123/ABC","key_type":"doi","doi_key":"doi:10.123/ABC","metadata_key":"meta:||example","components":{"doi":"10.123/ABC","year":null,"first_author":null,"title":"example"}}},{"input":{"record":{"id":"r1","type":"article-journal","title":"financial ffice report","issued":{"date_parts":[[1999]]}}},"output":{"match_key":"meta:1999||financial ffice report","key_type":"metadata","doi_key":null,"metadata_key":"meta:1999||financial ffice report","components":{"doi":null,"year":"1999","first_author":null,"title":"financial ffice report"}}}],"execute_url":"/v1/tools/citation-record-key/versions/1.0.0/execute"}