enum Meilisearch::Crystal::Error::Code

Overview

All documented Meilisearch error codes.

Transcribed from the Meilisearch error reference and cross-checked against jgaskins/meilisearch (MIT). Grouped by concern for readability; parsing is by name, so order is not significant.

Defined in:

meilisearch/crystal/error.cr

Enum Members

APIKeyAlreadyExists = 0

---- API keys ----

APIKeyNotFound = 1
ImmutableAPIKeyActions = 2
ImmutableAPIKeyCreatedAt = 3
ImmutableAPIKeyExpiresAt = 4
ImmutableAPIKeyIndexes = 5
ImmutableAPIKeyKey = 6
ImmutableAPIKeyUid = 7
ImmutableAPIKeyUpdatedAt = 8
InvalidAPIKey = 9
InvalidAPIKeyActions = 10
InvalidAPIKeyDescription = 11
InvalidAPIKeyExpiresAt = 12
InvalidAPIKeyIndexes = 13
InvalidAPIKeyLimit = 14
InvalidAPIKeyName = 15
InvalidAPIKeyOffset = 16
InvalidAPIKeyUid = 17
MissingAPIKeyActions = 18
MissingAPIKeyExpiresAt = 19
MissingAPIKeyIndexes = 20
IndexAlreadyExists = 21

---- indexes ----

IndexCreationFailed = 22
IndexNotFound = 23
IndexPrimaryKeyAlreadyExists = 24
IndexPrimaryKeyMultipleCandidatesFound = 25
InvalidIndexLimit = 26
InvalidIndexOffset = 27
InvalidIndexUid = 28
InvalidIndexPrimaryKey = 29
IndexPrimaryKeyNoCandidateFound = 30
MissingIndexUid = 31
DocumentFieldsLimitReached = 32

---- documents / payload / environment ----

DocumentNotFound = 33
InvalidDocumentCsvDelimiter = 34
InvalidDocumentId = 35
InvalidDocumentFields = 36
InvalidDocumentFilter = 37
InvalidDocumentLimit = 38
InvalidDocumentOffset = 39
InvalidDocumentSort = 40
InvalidDocumentGeoField = 41
IoError = 42
MalformedPayload = 43
MissingAuthorizationHeader = 44
MissingContentType = 45
MissingDocumentFilter = 46
MissingDocumentId = 47
MissingFacetSearchFacetName = 48
MissingMasterKey = 49
MissingNetworkUrl = 50
MissingPayload = 51
MissingSwapIndexes = 52
MissingTaskFilters = 53
NoSpaceLeftOnDevice = 54
TooManyOpenFiles = 55
TooManySearchRequests = 56
UnretrievableDocument = 57
InvalidTaskAfterEnqueuedAt = 58

---- tasks ----

InvalidTaskAfterFinishedAt = 59
InvalidTaskAfterStartedAt = 60
InvalidTaskBeforeEnqueuedAt = 61
InvalidTaskBeforeFinishedAt = 62
InvalidTaskBeforeStartedAt = 63
InvalidTaskCanceledBy = 64
InvalidTaskIndexUids = 65
InvalidTaskLimit = 66
InvalidTaskStatuses = 67
InvalidTaskTypes = 68
InvalidTaskUids = 69
TaskNotFound = 70
InvalidSearchAttributesToSearchOn = 71

---- settings & search ----

InvalidSearchAttributesToCrop = 72
InvalidSearchAttributesToHighlight = 73
InvalidSearchAttributesToRetrieve = 74
InvalidSearchCropLength = 75
InvalidSearchCropMarker = 76
InvalidSearchEmbedder = 77
InvalidSearchFacets = 78
InvalidSearchFilter = 79
InvalidSearchHighlightPostTag = 80
InvalidSearchHighlightPreTag = 81
InvalidSearchHitsPerPage = 82
InvalidSearchHybridQuery = 83
InvalidSearchLimit = 84
InvalidSearchLocales = 85
InvalidSettingsEmbedder = 86
InvalidSettingsEmbedders = 87
InvalidSettingsFacetSearch = 88
InvalidSettingsLocalizedAttributes = 89
InvalidSearchMatchingStrategy = 90
InvalidSearchOffset = 91
InvalidSettingsPrefixSearch = 92
InvalidSearchPage = 93
InvalidSearchQ = 94
InvalidSearchRankingScoreThreshold = 95
InvalidSearchShowMatchesPosition = 96
InvalidSearchSort = 97
InvalidSettingsDisplayedAttributes = 98
InvalidSettingsDistinctAttribute = 99
InvalidSettingsFacetingSortFacetValuesBy = 100
InvalidSettingsFacetingMaxValuesPerFacet = 101
InvalidSettingsFilterableAttributes = 102
InvalidSettingsPagination = 103
InvalidSettingsRankingRules = 104
InvalidSettingsSearchableAttributes = 105
InvalidSettingsSearchCutoffMs = 106
InvalidSettingsSortableAttributes = 107
InvalidSettingsStopWords = 108
InvalidSettingsSynonyms = 109
InvalidSettingsTypoTolerance = 110
InvalidFacetSearchFacetName = 111

---- facet search ----

InvalidFacetSearchFacetQuery = 112
InvalidSimilarId = 113

---- similar documents ----

NotFoundSimilarId = 114
InvalidSimilarAttributesToRetrieve = 115
InvalidSimilarEmbedder = 116
InvalidSimilarFilter = 117
InvalidSimilarLimit = 118
InvalidSimilarOffset = 119
InvalidSimilarShowRankingScore = 120
InvalidSimilarShowRankingScoreDetails = 121
InvalidSimilarRankingScoreThreshold = 122
InvalidSwapDuplicateIndexFound = 123

---- index swaps ----

InvalidSwapIndexes = 124
InvalidMultiSearchQueryFederated = 125

---- multi-search / federation / remote ----

InvalidMultiSearchQueryPagination = 126
InvalidMultiSearchQueryPosition = 127
InvalidMultiSearchWeight = 128
InvalidMultiSearchQueriesRankingRules = 129
InvalidMultiSearchFacets = 130
InvalidMultiSearchSortFacetValuesBy = 131
InvalidMultiSearchQueryFacets = 132
InvalidMultiSearchMergeFacets = 133
InvalidMultiSearchMaxValuesPerFacet = 134
InvalidMultiSearchFacetOrder = 135
InvalidMultiSearchFacetsByIndex = 136
InvalidMultiSearchRemote = 137
InvalidNetworkSelf = 138
InvalidNetworkRemotes = 139
InvalidNetworkUrl = 140
InvalidNetworkSearchAPIKey = 141
RemoteBadResponse = 142
RemoteBadRequest = 143
RemoteCouldNotSendRequest = 144
RemoteInvalidAPIKey = 145
RemoteRemoteError = 146
RemoteTimeout = 147
VectorEmbeddingError = 148

---- embeddings ----

BadRequest = 149

---- general ----

BatchNotFound = 150
DatabaseSizeLimitReached = 151
DumpProcessFailed = 152
FacetSearchDisabled = 153
FeatureNotEnabled = 154
ImmutableIndexUid = 155
ImmutableIndexUpdatedAt = 156
Internal = 157
InvalidContentType = 158
InvalidState = 159
InvalidStoreFile = 160
NotFound = 161
PayloadTooLarge = 162
Unknown = 163

---- fallback for undocumented codes ----

Instance Method Summary

Instance Method Detail

def api_key_already_exists? #

Returns true if this enum value equals APIKeyAlreadyExists


[View source]
def api_key_not_found? #

Returns true if this enum value equals APIKeyNotFound


[View source]
def bad_request? #

Returns true if this enum value equals BadRequest


[View source]
def batch_not_found? #

Returns true if this enum value equals BatchNotFound


[View source]
def database_size_limit_reached? #

Returns true if this enum value equals DatabaseSizeLimitReached


[View source]
def document_fields_limit_reached? #

Returns true if this enum value equals DocumentFieldsLimitReached


[View source]
def document_not_found? #

Returns true if this enum value equals DocumentNotFound


[View source]
def dump_process_failed? #

Returns true if this enum value equals DumpProcessFailed


[View source]
def facet_search_disabled? #

Returns true if this enum value equals FacetSearchDisabled


[View source]
def feature_not_enabled? #

Returns true if this enum value equals FeatureNotEnabled


[View source]
def immutable_api_key_actions? #

Returns true if this enum value equals ImmutableAPIKeyActions


[View source]
def immutable_api_key_created_at? #

Returns true if this enum value equals ImmutableAPIKeyCreatedAt


[View source]
def immutable_api_key_expires_at? #

Returns true if this enum value equals ImmutableAPIKeyExpiresAt


[View source]
def immutable_api_key_indexes? #

Returns true if this enum value equals ImmutableAPIKeyIndexes


[View source]
def immutable_api_key_key? #

Returns true if this enum value equals ImmutableAPIKeyKey


[View source]
def immutable_api_key_uid? #

Returns true if this enum value equals ImmutableAPIKeyUid


[View source]
def immutable_api_key_updated_at? #

Returns true if this enum value equals ImmutableAPIKeyUpdatedAt


[View source]
def immutable_index_uid? #

Returns true if this enum value equals ImmutableIndexUid


[View source]
def immutable_index_updated_at? #

Returns true if this enum value equals ImmutableIndexUpdatedAt


[View source]
def index_already_exists? #

Returns true if this enum value equals IndexAlreadyExists


[View source]
def index_creation_failed? #

Returns true if this enum value equals IndexCreationFailed


[View source]
def index_not_found? #

Returns true if this enum value equals IndexNotFound


[View source]
def index_primary_key_already_exists? #

Returns true if this enum value equals IndexPrimaryKeyAlreadyExists


[View source]
def index_primary_key_multiple_candidates_found? #

Returns true if this enum value equals IndexPrimaryKeyMultipleCandidatesFound


[View source]
def index_primary_key_no_candidate_found? #

Returns true if this enum value equals IndexPrimaryKeyNoCandidateFound


[View source]
def internal? #

Returns true if this enum value equals Internal


[View source]
def invalid_api_key? #

Returns true if this enum value equals InvalidAPIKey


[View source]
def invalid_api_key_actions? #

Returns true if this enum value equals InvalidAPIKeyActions


[View source]
def invalid_api_key_description? #

Returns true if this enum value equals InvalidAPIKeyDescription


[View source]
def invalid_api_key_expires_at? #

Returns true if this enum value equals InvalidAPIKeyExpiresAt


[View source]
def invalid_api_key_indexes? #

Returns true if this enum value equals InvalidAPIKeyIndexes


[View source]
def invalid_api_key_limit? #

Returns true if this enum value equals InvalidAPIKeyLimit


[View source]
def invalid_api_key_name? #

Returns true if this enum value equals InvalidAPIKeyName


[View source]
def invalid_api_key_offset? #

Returns true if this enum value equals InvalidAPIKeyOffset


[View source]
def invalid_api_key_uid? #

Returns true if this enum value equals InvalidAPIKeyUid


[View source]
def invalid_content_type? #

Returns true if this enum value equals InvalidContentType


[View source]
def invalid_document_csv_delimiter? #

Returns true if this enum value equals InvalidDocumentCsvDelimiter


[View source]
def invalid_document_fields? #

Returns true if this enum value equals InvalidDocumentFields


[View source]
def invalid_document_filter? #

Returns true if this enum value equals InvalidDocumentFilter


[View source]
def invalid_document_geo_field? #

Returns true if this enum value equals InvalidDocumentGeoField


[View source]
def invalid_document_id? #

Returns true if this enum value equals InvalidDocumentId


[View source]
def invalid_document_limit? #

Returns true if this enum value equals InvalidDocumentLimit


[View source]
def invalid_document_offset? #

Returns true if this enum value equals InvalidDocumentOffset


[View source]
def invalid_document_sort? #

Returns true if this enum value equals InvalidDocumentSort


[View source]
def invalid_facet_search_facet_name? #

Returns true if this enum value equals InvalidFacetSearchFacetName


[View source]
def invalid_facet_search_facet_query? #

Returns true if this enum value equals InvalidFacetSearchFacetQuery


[View source]
def invalid_index_limit? #

Returns true if this enum value equals InvalidIndexLimit


[View source]
def invalid_index_offset? #

Returns true if this enum value equals InvalidIndexOffset


[View source]
def invalid_index_primary_key? #

Returns true if this enum value equals InvalidIndexPrimaryKey


[View source]
def invalid_index_uid? #

Returns true if this enum value equals InvalidIndexUid


[View source]
def invalid_multi_search_facet_order? #

Returns true if this enum value equals InvalidMultiSearchFacetOrder


[View source]
def invalid_multi_search_facets? #

Returns true if this enum value equals InvalidMultiSearchFacets


[View source]
def invalid_multi_search_facets_by_index? #

Returns true if this enum value equals InvalidMultiSearchFacetsByIndex


[View source]
def invalid_multi_search_max_values_per_facet? #

Returns true if this enum value equals InvalidMultiSearchMaxValuesPerFacet


[View source]
def invalid_multi_search_merge_facets? #

Returns true if this enum value equals InvalidMultiSearchMergeFacets


[View source]
def invalid_multi_search_queries_ranking_rules? #

Returns true if this enum value equals InvalidMultiSearchQueriesRankingRules


[View source]
def invalid_multi_search_query_facets? #

Returns true if this enum value equals InvalidMultiSearchQueryFacets


[View source]
def invalid_multi_search_query_federated? #

Returns true if this enum value equals InvalidMultiSearchQueryFederated


[View source]
def invalid_multi_search_query_pagination? #

Returns true if this enum value equals InvalidMultiSearchQueryPagination


[View source]
def invalid_multi_search_query_position? #

Returns true if this enum value equals InvalidMultiSearchQueryPosition


[View source]
def invalid_multi_search_remote? #

Returns true if this enum value equals InvalidMultiSearchRemote


[View source]
def invalid_multi_search_sort_facet_values_by? #

Returns true if this enum value equals InvalidMultiSearchSortFacetValuesBy


[View source]
def invalid_multi_search_weight? #

Returns true if this enum value equals InvalidMultiSearchWeight


[View source]
def invalid_network_remotes? #

Returns true if this enum value equals InvalidNetworkRemotes


[View source]
def invalid_network_search_api_key? #

Returns true if this enum value equals InvalidNetworkSearchAPIKey


[View source]
def invalid_network_self? #

Returns true if this enum value equals InvalidNetworkSelf


[View source]
def invalid_network_url? #

Returns true if this enum value equals InvalidNetworkUrl


[View source]
def invalid_search_attributes_to_crop? #

Returns true if this enum value equals InvalidSearchAttributesToCrop


[View source]
def invalid_search_attributes_to_highlight? #

Returns true if this enum value equals InvalidSearchAttributesToHighlight


[View source]
def invalid_search_attributes_to_retrieve? #

Returns true if this enum value equals InvalidSearchAttributesToRetrieve


[View source]
def invalid_search_attributes_to_search_on? #

Returns true if this enum value equals InvalidSearchAttributesToSearchOn


[View source]
def invalid_search_crop_length? #

Returns true if this enum value equals InvalidSearchCropLength


[View source]
def invalid_search_crop_marker? #

Returns true if this enum value equals InvalidSearchCropMarker


[View source]
def invalid_search_embedder? #

Returns true if this enum value equals InvalidSearchEmbedder


[View source]
def invalid_search_facets? #

Returns true if this enum value equals InvalidSearchFacets


[View source]
def invalid_search_filter? #

Returns true if this enum value equals InvalidSearchFilter


[View source]
def invalid_search_highlight_post_tag? #

Returns true if this enum value equals InvalidSearchHighlightPostTag


[View source]
def invalid_search_highlight_pre_tag? #

Returns true if this enum value equals InvalidSearchHighlightPreTag


[View source]
def invalid_search_hits_per_page? #

Returns true if this enum value equals InvalidSearchHitsPerPage


[View source]
def invalid_search_hybrid_query? #

Returns true if this enum value equals InvalidSearchHybridQuery


[View source]
def invalid_search_limit? #

Returns true if this enum value equals InvalidSearchLimit


[View source]
def invalid_search_locales? #

Returns true if this enum value equals InvalidSearchLocales


[View source]
def invalid_search_matching_strategy? #

Returns true if this enum value equals InvalidSearchMatchingStrategy


[View source]
def invalid_search_offset? #

Returns true if this enum value equals InvalidSearchOffset


[View source]
def invalid_search_page? #

Returns true if this enum value equals InvalidSearchPage


[View source]
def invalid_search_q? #

Returns true if this enum value equals InvalidSearchQ


[View source]
def invalid_search_ranking_score_threshold? #

Returns true if this enum value equals InvalidSearchRankingScoreThreshold


[View source]
def invalid_search_show_matches_position? #

Returns true if this enum value equals InvalidSearchShowMatchesPosition


[View source]
def invalid_search_sort? #

Returns true if this enum value equals InvalidSearchSort


[View source]
def invalid_settings_displayed_attributes? #

Returns true if this enum value equals InvalidSettingsDisplayedAttributes


[View source]
def invalid_settings_distinct_attribute? #

Returns true if this enum value equals InvalidSettingsDistinctAttribute


[View source]
def invalid_settings_embedder? #

Returns true if this enum value equals InvalidSettingsEmbedder


[View source]
def invalid_settings_embedders? #

Returns true if this enum value equals InvalidSettingsEmbedders


[View source]
def invalid_settings_facet_search? #

Returns true if this enum value equals InvalidSettingsFacetSearch


[View source]
def invalid_settings_faceting_max_values_per_facet? #

Returns true if this enum value equals InvalidSettingsFacetingMaxValuesPerFacet


[View source]
def invalid_settings_faceting_sort_facet_values_by? #

Returns true if this enum value equals InvalidSettingsFacetingSortFacetValuesBy


[View source]
def invalid_settings_filterable_attributes? #

Returns true if this enum value equals InvalidSettingsFilterableAttributes


[View source]
def invalid_settings_localized_attributes? #

Returns true if this enum value equals InvalidSettingsLocalizedAttributes


[View source]
def invalid_settings_pagination? #

Returns true if this enum value equals InvalidSettingsPagination


[View source]
def invalid_settings_prefix_search? #

Returns true if this enum value equals InvalidSettingsPrefixSearch


[View source]
def invalid_settings_ranking_rules? #

Returns true if this enum value equals InvalidSettingsRankingRules


[View source]
def invalid_settings_search_cutoff_ms? #

Returns true if this enum value equals InvalidSettingsSearchCutoffMs


[View source]
def invalid_settings_searchable_attributes? #

Returns true if this enum value equals InvalidSettingsSearchableAttributes


[View source]
def invalid_settings_sortable_attributes? #

Returns true if this enum value equals InvalidSettingsSortableAttributes


[View source]
def invalid_settings_stop_words? #

Returns true if this enum value equals InvalidSettingsStopWords


[View source]
def invalid_settings_synonyms? #

Returns true if this enum value equals InvalidSettingsSynonyms


[View source]
def invalid_settings_typo_tolerance? #

Returns true if this enum value equals InvalidSettingsTypoTolerance


[View source]
def invalid_similar_attributes_to_retrieve? #

Returns true if this enum value equals InvalidSimilarAttributesToRetrieve


[View source]
def invalid_similar_embedder? #

Returns true if this enum value equals InvalidSimilarEmbedder


[View source]
def invalid_similar_filter? #

Returns true if this enum value equals InvalidSimilarFilter


[View source]
def invalid_similar_id? #

Returns true if this enum value equals InvalidSimilarId


[View source]
def invalid_similar_limit? #

Returns true if this enum value equals InvalidSimilarLimit


[View source]
def invalid_similar_offset? #

Returns true if this enum value equals InvalidSimilarOffset


[View source]
def invalid_similar_ranking_score_threshold? #

Returns true if this enum value equals InvalidSimilarRankingScoreThreshold


[View source]
def invalid_similar_show_ranking_score? #

Returns true if this enum value equals InvalidSimilarShowRankingScore


[View source]
def invalid_similar_show_ranking_score_details? #

Returns true if this enum value equals InvalidSimilarShowRankingScoreDetails


[View source]
def invalid_state? #

Returns true if this enum value equals InvalidState


[View source]
def invalid_store_file? #

Returns true if this enum value equals InvalidStoreFile


[View source]
def invalid_swap_duplicate_index_found? #

Returns true if this enum value equals InvalidSwapDuplicateIndexFound


[View source]
def invalid_swap_indexes? #

Returns true if this enum value equals InvalidSwapIndexes


[View source]
def invalid_task_after_enqueued_at? #

Returns true if this enum value equals InvalidTaskAfterEnqueuedAt


[View source]
def invalid_task_after_finished_at? #

Returns true if this enum value equals InvalidTaskAfterFinishedAt


[View source]
def invalid_task_after_started_at? #

Returns true if this enum value equals InvalidTaskAfterStartedAt


[View source]
def invalid_task_before_enqueued_at? #

Returns true if this enum value equals InvalidTaskBeforeEnqueuedAt


[View source]
def invalid_task_before_finished_at? #

Returns true if this enum value equals InvalidTaskBeforeFinishedAt


[View source]
def invalid_task_before_started_at? #

Returns true if this enum value equals InvalidTaskBeforeStartedAt


[View source]
def invalid_task_canceled_by? #

Returns true if this enum value equals InvalidTaskCanceledBy


[View source]
def invalid_task_index_uids? #

Returns true if this enum value equals InvalidTaskIndexUids


[View source]
def invalid_task_limit? #

Returns true if this enum value equals InvalidTaskLimit


[View source]
def invalid_task_statuses? #

Returns true if this enum value equals InvalidTaskStatuses


[View source]
def invalid_task_types? #

Returns true if this enum value equals InvalidTaskTypes


[View source]
def invalid_task_uids? #

Returns true if this enum value equals InvalidTaskUids


[View source]
def io_error? #

Returns true if this enum value equals IoError


[View source]
def malformed_payload? #

Returns true if this enum value equals MalformedPayload


[View source]
def missing_api_key_actions? #

Returns true if this enum value equals MissingAPIKeyActions


[View source]
def missing_api_key_expires_at? #

Returns true if this enum value equals MissingAPIKeyExpiresAt


[View source]
def missing_api_key_indexes? #

Returns true if this enum value equals MissingAPIKeyIndexes


[View source]
def missing_authorization_header? #

Returns true if this enum value equals MissingAuthorizationHeader


[View source]
def missing_content_type? #

Returns true if this enum value equals MissingContentType


[View source]
def missing_document_filter? #

Returns true if this enum value equals MissingDocumentFilter


[View source]
def missing_document_id? #

Returns true if this enum value equals MissingDocumentId


[View source]
def missing_facet_search_facet_name? #

Returns true if this enum value equals MissingFacetSearchFacetName


[View source]
def missing_index_uid? #

Returns true if this enum value equals MissingIndexUid


[View source]
def missing_master_key? #

Returns true if this enum value equals MissingMasterKey


[View source]
def missing_network_url? #

Returns true if this enum value equals MissingNetworkUrl


[View source]
def missing_payload? #

Returns true if this enum value equals MissingPayload


[View source]
def missing_swap_indexes? #

Returns true if this enum value equals MissingSwapIndexes


[View source]
def missing_task_filters? #

Returns true if this enum value equals MissingTaskFilters


[View source]
def no_space_left_on_device? #

Returns true if this enum value equals NoSpaceLeftOnDevice


[View source]
def not_found? #

Returns true if this enum value equals NotFound


[View source]
def not_found_similar_id? #

Returns true if this enum value equals NotFoundSimilarId


[View source]
def payload_too_large? #

Returns true if this enum value equals PayloadTooLarge


[View source]
def remote_bad_request? #

Returns true if this enum value equals RemoteBadRequest


[View source]
def remote_bad_response? #

Returns true if this enum value equals RemoteBadResponse


[View source]
def remote_could_not_send_request? #

Returns true if this enum value equals RemoteCouldNotSendRequest


[View source]
def remote_invalid_api_key? #

Returns true if this enum value equals RemoteInvalidAPIKey


[View source]
def remote_remote_error? #

Returns true if this enum value equals RemoteRemoteError


[View source]
def remote_timeout? #

Returns true if this enum value equals RemoteTimeout


[View source]
def task_not_found? #

Returns true if this enum value equals TaskNotFound


[View source]
def too_many_open_files? #

Returns true if this enum value equals TooManyOpenFiles


[View source]
def too_many_search_requests? #

Returns true if this enum value equals TooManySearchRequests


[View source]
def unknown? #

Returns true if this enum value equals Unknown


[View source]
def unretrievable_document? #

Returns true if this enum value equals UnretrievableDocument


[View source]
def vector_embedding_error? #

Returns true if this enum value equals VectorEmbeddingError


[View source]