Query
643 matches
Other/Vectara REST
Query
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
{
"type": "object",
"properties": {
"customer-id": {
"type": "integer"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"corpusKey": {
"type": "array",
"items": {
"type": "object",
"properties": {
"corpusId": {
"type": "integer",
"format": "int64",
"description": "The Corpus ID."
},
"customerId": {
"type": "integer",
"format": "int64",
"description": "The Customer ID."
},
"dim": {
"type": "array",
"description": "Weights on custom dimensions for the corpus.",
"items": {
"type": "object",
"description": "Defined the weight of a custom dimension at query time.",
"properties": {
"name": {
"type": "string"
},
"weight": {
"type": "number",
"format": "double"
}
}
}
},
"metadataFilter": {
"type": "string"
},
"semantics": {
"type": "string",
"description": "Semantics controls the interpretation of the query string by the\nserver, and can be used to override the default semantics assigned\nin the corpus definition.\n\n\n\n\n - DEFAULT: Use corpus-assigned semantics. This is the most common setting.\n - QUERY: Use query semantics. This is also common.\n - RESPONSE: Use response semantics. Usage of this is rare.",
"enum": [
"DEFAULT",
"QUERY",
"RESPONSE"
]
}
}
}
},
"numResults": {
"type": "integer",
"format": "int64",
"description": "The number of results to return."
},
"query": {
"type": "string",
"description": "The query text to use from the end user."
},
"rerankingConfig": {
"type": "object",
"description": "Configuration options to apply to the reranking.",
"properties": {
"rerankerId": {
"type": "integer",
"format": "int64"
}
}
},
"start": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"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
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
{
"type": "object",
"properties": {
"metrics": {
"type": "object",
"description": "Basic performance metrics that can be attached to a server response.",
"properties": {
"queryEncodeMs": {
"type": "integer",
"format": "int64",
"description": "How long it took to encode the query."
},
"rerankMs": {
"type": "integer",
"format": "int64",
"description": "How long it took to rerank the results."
},
"retrievalMs": {
"type": "integer",
"format": "int64",
"description": "How long it took to retrieve relevant results."
},
"userdataRetrievalMs": {
"type": "integer",
"format": "int64",
"description": "How long it took to retrieve user data."
}
}
},
"responseSet": {
"type": "array",
"items": {
"type": "object",
"properties": {
"document": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"metadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"response": {
"type": "array",
"items": {
"type": "object",
"properties": {
"corpusKey": {
"type": "object",
"properties": {
"corpusId": {
"type": "integer",
"format": "int64",
"description": "The Corpus ID."
},
"customerId": {
"type": "integer",
"format": "int64",
"description": "The Customer ID."
},
"dim": {
"type": "array",
"description": "Weights on custom dimensions for the corpus.",
"items": {
"type": "object",
"description": "Defined the weight of a custom dimension at query time.",
"properties": {
"name": {
"type": "object",
"additionalProperties": true
},
"weight": {
"type": "object",
"additionalProperties": true
}
}
}
},
"metadataFilter": {
"type": "string"
},
"semantics": {
"type": "string",
"description": "Semantics controls the interpretation of the query string by the\nserver, and can be used to override the default semantics assigned\nin the corpus definition.\n\n\n\n\n - DEFAULT: Use corpus-assigned semantics. This is the most common setting.\n - QUERY: Use query semantics. This is also common.\n - RESPONSE: Use response semantics. Usage of this is rare.",
"enum": [
"DEFAULT",
"QUERY",
"RESPONSE"
]
}
}
},
"documentIndex": {
"type": "integer",
"format": "int64",
"description": "Use this ID to find the document in the ResponseSet."
},
"metadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"score": {
"type": "number",
"format": "float",
"description": "The score used for ranking results. The higher the score, the better the match."
},
"text": {
"type": "string"
}
}
}
},
"status": {
"type": "array",
"description": "Potentially multiple warnings.",
"items": {
"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"
}
}
}
}
}
}
},
"status": {
"type": "array",
"items": {
"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"
}
}
}
}
}
}