Index
643 matches
Other/Vectara REST
Index
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
{
"type": "object",
"properties": {
"corpusId": {
"type": "string",
"format": "int64"
},
"customer-id": {
"type": "integer"
},
"customerId": {
"type": "string",
"format": "int64"
},
"document": {
"type": "object",
"description": "A document to index.",
"properties": {
"customDims": {
"type": "array",
"description": "A list of custom dimension values that are included in the generated\nrepresentation of all sections.",
"items": {
"type": "object",
"description": "The value of a custom dimension. A valid list of custom dimensions is defined ahead of time for a corpus.",
"properties": {
"name": {
"type": "string",
"description": "The name of the dimension."
},
"value": {
"type": "number",
"format": "double",
"description": "The value of the dimension."
}
}
}
},
"description": {
"type": "string",
"description": "An optional description for the document."
},
"documentId": {
"type": "string",
"description": "Client assigned document ID to this document."
},
"metadataJson": {
"type": "string",
"description": "Metadata about the document. This should be a json string, and it can be\nretrieved at query time."
},
"section": {
"type": "array",
"description": "The actual content of the document, structured as a repeating list\nof sections.",
"items": {
"type": "object",
"description": "A section within a structured document.",
"properties": {
"customDims": {
"type": "array",
"description": "A list of custom dimension values that are included in the generated\nrepresentation of all subsections (i.e. sections contains by this section).",
"items": {
"type": "object",
"description": "The value of a custom dimension. A valid list of custom dimensions is defined ahead of time for a corpus.",
"properties": {
"name": {
"type": "string",
"description": "The name of the dimension."
},
"value": {
"type": "number",
"format": "double",
"description": "The value of the dimension."
}
}
}
},
"id": {
"type": "integer",
"format": "int32",
"description": "Optionally, the unique ID of this section. If set, it will be returned as\nmetadata in query results."
},
"metadataJson": {
"type": "string",
"description": "Metadata about this section. This should be a json string. It is passed\nthrough the system, without being used at indexing time. It can be\nretrieved at query time."
},
"section": {
"type": "array",
"description": "A list of subsections.",
"items": {
"type": "object",
"additionalProperties": true
}
},
"text": {
"type": "string",
"description": "The text of the section. This should never be empty."
},
"title": {
"type": "string",
"description": "Optionally, the title of the section. This may be empty."
}
}
}
},
"title": {
"type": "string",
"description": "The title of the document."
}
}
}
},
"required": [
"customer-id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
{
"type": "object",
"properties": {
"quotaConsumed": {
"type": "object",
"properties": {
"numChars": {
"type": "string",
"format": "int64",
"description": "The number of chars from the document that consumed the storage quota."
},
"numMetadataChars": {
"type": "string",
"format": "int64",
"description": "The number of chars in the metadata of the document that consumed the\nstorage quota."
}
}
},
"status": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"OK",
"FAILURE",
"UNKNOWN",
"INVALID_ARGUMENT",
"DEADLINE_EXCEEDED",
"ALREADY_EXISTS",
"PERMISSION_DENIED",
"RESOURCE_EXHAUSTED",
"FAILED_PRECONDITION",
"ABORTED",
"OUT_OF_RANGE",
"UNIMPLEMENTED",
"INTERNAL",
"UNAVAILABLE",
"DATA_LOSS",
"UNAUTHENTICATED",
"BAD_REQUEST",
"UNAUTHORIZED",
"FORBIDDEN",
"NOT_FOUND",
"METHOD_NOT_ALLOWED",
"CONFLICT",
"UNSUPPORTED_MEDIA_TYPE",
"TOO_MANY_REQUESTS",
"INTERNAL_SERVER_ERROR",
"NOT_IMPLEMENTED",
"SERVICE_UNAVAILABLE",
"INSUFFICIENT_STORAGE",
"UNPARSEABLE_RESPONSE",
"DISABLED_CUSTOMER",
"INVALID_CUSTOMER_ID",
"DISABLED_CORPUS",
"INVALID_CORPUS_ID",
"DISABLED_API_KEY",
"EXPIRED_API_KEY",
"INVALID_API_KEY",
"CMK_INACCESSIBLE",
"QRY__DISABLED_CORPUS",
"QRY__DOCUMENT_DB_FAILURE",
"QRY__ENCODER_FAILURE",
"QRY__INTERRUPTED",
"QRY__INVALID_CORPUS",
"QRY__INVALID_START",
"QRY__INVALID_NUM_RESULTS",
"QRY__INVALID_CONTEXT",
"QRY__MISSING_QUERY",
"QRY__MISSING_CORPUS",
"QRY__TIMEOUT",
"QRY__TOO_MANY_CORPORA",
"QRY__TOO_MANY_QUERIES",
"QRY__VECTOR_INDEX_FAILURE",
"QRY__INVALID_DIMENSION",
"QRY__INVALID_CLIENTKEY",
"QRY__DECRYPTION_FAILURE",
"QRY__INVALID_RERANKER",
"QRY__PARTIAL_RERANK",
"QRY__RERANK_FAILURE",
"QRY__TOO_MANY_RESULT_ROWS",
"QRY__PARTIAL_RETRIEVAL",
"CX_SPECS__INVALID_JSON",
"CX_SPECS__UNREGISTERED_TYPE",
"CX_SPECS__MISSING_SPEC",
"CX_SPECS__MISSING_TYPE",
"CX_SPECS__UNPARSEABLE_SPEC",
"ADM__INVALID_CUSTOMER_ID",
"ADM__INVALID_CORPUS_ID",
"ADM__INVALID_ENCODER_ID",
"ADM__INVALID_ROLE_ID",
"ADM__ROLE_ALREADY_EXISTS",
"ADM__ONLY_ONE_OWNER_SUPPORTED",
"ADM__INVALID_PERMISSION",
"ADM__ROLECREATION_FAILURE",
"ADM__USER_EMAIL_NOT_AVAIALBLE",
"ADM__USERNAME_NOT_AVAILABLE",
"ADM__SIGNUP_MISSING_NAME",
"ADM__SIGNUP_MISSING_ORG",
"ADM__SIGNUP_MISSING_EMAIL",
"ADM__SIGNUP_MISSING_PAYMENT",
"ADM__SIGNUP_MISSING_PLAN",
"ADM__SIGNUP_MISSING_PASSWORD",
"ADM__SIGNUP_INVALID_NAME",
"ADM__SIGNUP_INVALID_ORG",
"ADM__SIGNUP_INVALID_EMAIL",
"ADM__SIGNUP_INVALID_PAYMENT",
"ADM__SIGNUP_INVALID_PLAN",
"ADM__SIGNUP_INVALID_PASSWORD",
"ADM__SIGNUP_INVALID_ACCOUNT_ALIAS",
"ADM__SIGNUP_INVALID_EMAIL_VALIDATION_CODE",
"ADM__SIGNUP_MISSING_COUNTRY_CODE",
"ADM__SIGNUP_ROOT_EMAIL_NOT_AVAILABLE",
"ADM__CUST_MARK_DELETE_FAILED",
"ADM__CUST_FAISS_DEALLOC_FAILED",
"ADM__CORPUS_LIMIT_REACHED",
"ADM__STRIPE_CARD_DECLINED",
"ADM__STRIPE_PROCESSING_ERROR",
"ADM__EMAIL_VALIDATION_REQUEST_NOT_FOUND",
"ADM__EMAIL_NOT_VALIDATED",
"ADM__CHANGE_PLAN__NO_CURRENT_PLAN",
"ADM__CHANGE_PLAN__REQUIRES_MANUAL_CHANGE",
"ADM__CHANGE_PLAN__INVALID_PLAN_ID",
"ADM__CHANGE_PLAN__NO_PAYMENT_SOURCE",
"ADM__CHANGE_PLAN__INVALID_EFFECTIVE_DATE",
"ADM__CHANGE_PLAN__CONFLICTING_CHANGE",
"SCM__MISCONFIGURED_CONNECTION",
"STATS_DB_READ_FAILURE",
"VDB__TEXT_READ_FAILURE",
"REBUILD__LOW_RECALL",
"REBUILD__INDEX_UPLOAD_FAILURE",
"REBUILD__UPDATE_JOURNAL_FAILURE",
"REBUILD__UPDATE_FAISSPARAMS_FAILURE",
"REBUILD__NO_DATA",
"REBUILD__EVALUATION",
"IDX__TRANSIENT_PARTIAL_DELETION_FAILURE",
"IDX__PERMANENT_PARTIAL_DELETION_FAILURE"
]
},
"statusDetail": {
"type": "string"
}
}
}
}
}