Specification
Index
Every term, record kind, error kind and case on this site, A to Z, each linked to the place that defines it.
A
AppendixSDK nameappendix_alignmenterror kindappendix_crc_mismatcherror kindappendix_invaliderror kindappendix_legacy_versionerror kindAppendix::container_versionSDK nameAppendix::file_checksumSDK nameAppendix::section_bytesSDK nameAppendix::sectionsSDK nameAppendix::tensor_f32SDK nameAppendix::tensor_namesSDK nameAppendixDiffSDK nameAppendixReportSDK nameAppendixSpecSDK nameAppendixSpec::compactSDK nameAppendixSpec::emptySDK nameAppendixSpec::with_tensor_f32SDK name
B
- Bindings term
BindProfileSDK nameBoundEmbeddingSDK name
C
canonical_jsonSDK namechecksum_mismatcherror kindcitationrecord kindclauserecord kindcodebook_manifestrecord kind- Compact embedding profile term
COMPACT_ALIGN_LOG2SDK nameCOMPACT_FORMAT_VERSIONSDK nameCOMPACT_RECORD_SIZESDK namecorpus_versionSDK namecsdt_file_checksumfooter fieldcsdt_offsetfooter fieldcsdt_refrecord kindcsdt_sizefooter field
D
dangling_embreferror kind- dedup key term
DiffSDK namediffSDK namediff-add-remove-changecasediff-appendix-section-changedcasediff-duplicate-keyscasediff-member-order-onlycaseDiff::is_emptySDK nameDiff::to_jsonSDK nameDiff::to_json_valueSDK nameDiffChangeSDK name- Differ conformance level
discoveryrecord kind
E
embrefrecord kindEmbrefReportSDK nameentrecord kindEntityViewSDK nameErrorSDK nameerror_kinds_versionSDK nameError::detailsSDK nameError::kindSDK nameError::messageSDK nameError::to_jsonSDK nameErrorKindSDK nameErrorKind::ALLSDK nameErrorKind::as_strSDK nameErrorKind::from_keySDK name
F
FilterSDK namefilter-id-prefixcasefilter-kindscaseFilter::matchesSDK nameFilter::newSDK nameFilter::with_id_prefixSDK nameFilter::with_kindsSDK name- final term
- format version term
FORMAT_VERSIONSDK name
G
graph-appendix-sectionscasegraph-appendix-v3-readcasegraph-bind-s2-acasegraph-emptycasegraph-gzipcasegraph-no-appendixcasegraph-open-verify-opt-outcasegraph-placeholder-headercasegraph-section-b2048casegraph-verify-compactcasegraph-verify-dangling-countscasegraph-verify-footer-csdt-checksumcasegraph-verify-type-mismatch-countscasegrounded_answerrecord kind
H
header_footer_mismatcherror kindhyperrecord kind
I
internalerror kindinvalid_footererror kindinvalid_headererror kindinvalid_recorderror kindinvalid_utf8error kindioerror kind
J
jsonerror kind
K
L
limit_exceedederror kind
M
magicfooter fieldmergeSDK namemerge_conflicterror kindmerge-commutative-abcasemerge-commutative-bacasemerge-higher-saliencecasemerge-id-dedup-trapcasemerge-latestcasemerge-manualcasemerge-stub-resolutioncasemerge-unioncaseMergeOptionsSDK nameMergeOptions::with_strategySDK name- Merger conformance level
MergeReportSDK nameMergeReport::to_jsonSDK nameMergeReport::to_json_valueSDK nameMergeStrategySDK nameMergeStrategy::as_strSDK nameMergeStrategy::from_nameSDK namemetarecord kindmutrecord kind
N
neg-align-csdt-offset-not-64caseneg-align-log2-64caseneg-app-csdt-bad-magiccaseneg-app-csdt-version-2caseneg-app-csdt-version-9caseneg-app-data-range-past-eofcaseneg-app-descriptor-reserved-nonzerocaseneg-app-table-offset-near-u64-maxcaseneg-app-table-offset-past-eofcaseneg-app-zero-count-table-past-eofcaseneg-bind-ext-no-csdt-refcaseneg-bind-local-record-oobcaseneg-bind-local-section-oobcaseneg-bind-no-appendixcaseneg-bind-wrong-dtypecaseneg-bind-wrong-stridecaseneg-bind-wrong-typecaseneg-body-non-utf8caseneg-count-footer-plus-onecaseneg-crc-section-flipcaseneg-crc-section-tablecaseneg-footer-bad-magiccaseneg-footer-offset-ge-2p32caseneg-footer-padding-nonzerocaseneg-footer-reserved-nonzerocaseneg-footer-text-size-before-bodycaseneg-footer-text-size-overlaps-appendixcaseneg-footer-text-size-past-endcaseneg-footer-version-7caseneg-header-bad-magiccaseneg-header-multibyte-byte80caseneg-header-non-numeric-recordscaseneg-header-too-shortcaseneg-header-version-7caseneg-hf-neither-final-nor-placeholdercaseneg-hf-records-disagreecaseneg-hf-sha-disagreecaseneg-io-missing-pathcaseneg-json-lone-surrogatecaseneg-json-syntaxcaseneg-json-typed-schemacaseneg-limit-gzip-inflate-capcaseneg-limit-input-cap-plaincaseneg-merge-legacy-v3-appendixcaseneg-merge-tensorindex-sectioncaseneg-merge-unregistered-section-typecaseneg-record-appendix-without-markercaseneg-record-marker-mid-bodycaseneg-record-missing-kcaseneg-record-not-objectcaseneg-sha-appendix-flip-opencaseneg-sha-body-flipcaseneg-unsupported-payload-classcase
O
- opaque term
- opaque round-trip rule term
OpenOptionsSDK nameOpenOptions::no_verifySDK nameOpenOptions::with_max_input_bytesSDK nameOpenOptions::with_verifySDK nameoutcomerecord kind
P
PackSDK namePack::appendixSDK namePack::bind_embrefsSDK namePack::body_bytesSDK namePack::from_bytesSDK namePack::has_appendixSDK namePack::openSDK namePack::record_countSDK namePack::recordsSDK namePack::records_filteredSDK namePack::sha256_hexSDK namePack::to_bytesSDK namePack::verifySDK namepayloadrecord kind- placeholder term
- PLXI identity form term
pos-fixture-emptycasepos-kind-citationcasepos-kind-clausecasepos-kind-codebook-manifestcasepos-kind-csdt-refcasepos-kind-discoverycasepos-kind-embrefcasepos-kind-entcasepos-kind-grounded-answercasepos-kind-hypercasepos-kind-knob-setcasepos-kind-metacasepos-kind-outcomecasepos-kind-payloadcasepos-kind-promocasepos-kind-provcasepos-kind-relcasepos-kind-sessioncasepos-kind-session-endcasepos-kind-sevcasepos-member-order-preservedcasepos-numberscasepos-numbers-d96casepos-opaque-future-kindcasepos-typed-kind-higher-vcase- primary id term
promorecord kindprovrecord kind
R
- rank term
- Reader-Appendix conformance level
- Reader-Core conformance level
RecordSDK namerecord_countfooter fieldrecord_count_mismatcherror kindRecord::as_entitySDK nameRecord::as_relationSDK nameRecord::canonical_jsonSDK nameRecord::dedup_keySDK nameRecord::from_json_lineSDK nameRecord::json_lineSDK nameRecord::kindSDK nameRecord::primary_idSDK nameRecord::sort_keySDK nameRecord::to_json_valueSDK nameRecord::versionSDK nameRecordCountReportSDK namerelrecord kindRelationViewSDK namereservedfooter fieldResultSDK name
S
sdk_versionSDK namesection_type_mismatcherror kindSectionCrcReportSDK nameSectionInfoSDK nameSectionInfo::to_json_valueSDK namesessionrecord kindsession_endrecord kindsevrecord kindsha256footer fieldshard_quality_below_thresholderror kindshard_unsupported_specerror kind- Sharder conformance level
- sort key term
T
- target-key term
text_section_sizefooter field- typed term
U
unsupportederror kindunsupported_versionerror kind
V
- verify step 1: Size verify step
- verify step 10: Bindings verify step
- verify step 2: Header verify step
- verify step 3: Footer verify step
- verify step 4: Header against footer verify step
- verify step 5: Layout verify step
- verify step 6: Digest verify step
- verify step 7: Body verify step
- verify step 8: Count verify step
- verify step 9: Appendix verify step
VerifyReportSDK nameVerifyReport::is_okSDK nameVerifyReport::to_jsonSDK nameVerifyReport::to_json_valueSDK nameversionfooter field
W
writeSDK namewrite_to_pathSDK namewrite-no-appendixcasewrite-opaque-roundtripcase- Writer conformance level
284 entries.