github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/wisdom/2020-10-19/api-2.json (about) 1 { 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2020-10-19", 5 "endpointPrefix":"wisdom", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"Amazon Connect Wisdom Service", 9 "serviceId":"Wisdom", 10 "signatureVersion":"v4", 11 "signingName":"wisdom", 12 "uid":"wisdom-2020-10-19" 13 }, 14 "operations":{ 15 "CreateAssistant":{ 16 "name":"CreateAssistant", 17 "http":{ 18 "method":"POST", 19 "requestUri":"/assistants", 20 "responseCode":200 21 }, 22 "input":{"shape":"CreateAssistantRequest"}, 23 "output":{"shape":"CreateAssistantResponse"}, 24 "errors":[ 25 {"shape":"ConflictException"}, 26 {"shape":"ValidationException"}, 27 {"shape":"ServiceQuotaExceededException"}, 28 {"shape":"AccessDeniedException"} 29 ], 30 "idempotent":true 31 }, 32 "CreateAssistantAssociation":{ 33 "name":"CreateAssistantAssociation", 34 "http":{ 35 "method":"POST", 36 "requestUri":"/assistants/{assistantId}/associations", 37 "responseCode":200 38 }, 39 "input":{"shape":"CreateAssistantAssociationRequest"}, 40 "output":{"shape":"CreateAssistantAssociationResponse"}, 41 "errors":[ 42 {"shape":"ConflictException"}, 43 {"shape":"ValidationException"}, 44 {"shape":"ServiceQuotaExceededException"}, 45 {"shape":"AccessDeniedException"}, 46 {"shape":"ResourceNotFoundException"} 47 ], 48 "idempotent":true 49 }, 50 "CreateContent":{ 51 "name":"CreateContent", 52 "http":{ 53 "method":"POST", 54 "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", 55 "responseCode":200 56 }, 57 "input":{"shape":"CreateContentRequest"}, 58 "output":{"shape":"CreateContentResponse"}, 59 "errors":[ 60 {"shape":"ConflictException"}, 61 {"shape":"ValidationException"}, 62 {"shape":"ServiceQuotaExceededException"}, 63 {"shape":"AccessDeniedException"}, 64 {"shape":"ResourceNotFoundException"} 65 ], 66 "idempotent":true 67 }, 68 "CreateKnowledgeBase":{ 69 "name":"CreateKnowledgeBase", 70 "http":{ 71 "method":"POST", 72 "requestUri":"/knowledgeBases", 73 "responseCode":200 74 }, 75 "input":{"shape":"CreateKnowledgeBaseRequest"}, 76 "output":{"shape":"CreateKnowledgeBaseResponse"}, 77 "errors":[ 78 {"shape":"ConflictException"}, 79 {"shape":"ValidationException"}, 80 {"shape":"ServiceQuotaExceededException"}, 81 {"shape":"AccessDeniedException"} 82 ], 83 "idempotent":true 84 }, 85 "CreateSession":{ 86 "name":"CreateSession", 87 "http":{ 88 "method":"POST", 89 "requestUri":"/assistants/{assistantId}/sessions", 90 "responseCode":200 91 }, 92 "input":{"shape":"CreateSessionRequest"}, 93 "output":{"shape":"CreateSessionResponse"}, 94 "errors":[ 95 {"shape":"ConflictException"}, 96 {"shape":"ValidationException"}, 97 {"shape":"ResourceNotFoundException"} 98 ], 99 "idempotent":true 100 }, 101 "DeleteAssistant":{ 102 "name":"DeleteAssistant", 103 "http":{ 104 "method":"DELETE", 105 "requestUri":"/assistants/{assistantId}", 106 "responseCode":204 107 }, 108 "input":{"shape":"DeleteAssistantRequest"}, 109 "output":{"shape":"DeleteAssistantResponse"}, 110 "errors":[ 111 {"shape":"ValidationException"}, 112 {"shape":"AccessDeniedException"}, 113 {"shape":"ResourceNotFoundException"} 114 ], 115 "idempotent":true 116 }, 117 "DeleteAssistantAssociation":{ 118 "name":"DeleteAssistantAssociation", 119 "http":{ 120 "method":"DELETE", 121 "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", 122 "responseCode":204 123 }, 124 "input":{"shape":"DeleteAssistantAssociationRequest"}, 125 "output":{"shape":"DeleteAssistantAssociationResponse"}, 126 "errors":[ 127 {"shape":"ValidationException"}, 128 {"shape":"AccessDeniedException"}, 129 {"shape":"ResourceNotFoundException"} 130 ], 131 "idempotent":true 132 }, 133 "DeleteContent":{ 134 "name":"DeleteContent", 135 "http":{ 136 "method":"DELETE", 137 "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", 138 "responseCode":204 139 }, 140 "input":{"shape":"DeleteContentRequest"}, 141 "output":{"shape":"DeleteContentResponse"}, 142 "errors":[ 143 {"shape":"ValidationException"}, 144 {"shape":"AccessDeniedException"}, 145 {"shape":"ResourceNotFoundException"} 146 ], 147 "idempotent":true 148 }, 149 "DeleteKnowledgeBase":{ 150 "name":"DeleteKnowledgeBase", 151 "http":{ 152 "method":"DELETE", 153 "requestUri":"/knowledgeBases/{knowledgeBaseId}", 154 "responseCode":204 155 }, 156 "input":{"shape":"DeleteKnowledgeBaseRequest"}, 157 "output":{"shape":"DeleteKnowledgeBaseResponse"}, 158 "errors":[ 159 {"shape":"ConflictException"}, 160 {"shape":"AccessDeniedException"}, 161 {"shape":"ResourceNotFoundException"} 162 ], 163 "idempotent":true 164 }, 165 "GetAssistant":{ 166 "name":"GetAssistant", 167 "http":{ 168 "method":"GET", 169 "requestUri":"/assistants/{assistantId}", 170 "responseCode":200 171 }, 172 "input":{"shape":"GetAssistantRequest"}, 173 "output":{"shape":"GetAssistantResponse"}, 174 "errors":[ 175 {"shape":"ValidationException"}, 176 {"shape":"AccessDeniedException"}, 177 {"shape":"ResourceNotFoundException"} 178 ] 179 }, 180 "GetAssistantAssociation":{ 181 "name":"GetAssistantAssociation", 182 "http":{ 183 "method":"GET", 184 "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", 185 "responseCode":200 186 }, 187 "input":{"shape":"GetAssistantAssociationRequest"}, 188 "output":{"shape":"GetAssistantAssociationResponse"}, 189 "errors":[ 190 {"shape":"ValidationException"}, 191 {"shape":"AccessDeniedException"}, 192 {"shape":"ResourceNotFoundException"} 193 ] 194 }, 195 "GetContent":{ 196 "name":"GetContent", 197 "http":{ 198 "method":"GET", 199 "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", 200 "responseCode":200 201 }, 202 "input":{"shape":"GetContentRequest"}, 203 "output":{"shape":"GetContentResponse"}, 204 "errors":[ 205 {"shape":"ValidationException"}, 206 {"shape":"AccessDeniedException"}, 207 {"shape":"ResourceNotFoundException"} 208 ] 209 }, 210 "GetContentSummary":{ 211 "name":"GetContentSummary", 212 "http":{ 213 "method":"GET", 214 "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", 215 "responseCode":200 216 }, 217 "input":{"shape":"GetContentSummaryRequest"}, 218 "output":{"shape":"GetContentSummaryResponse"}, 219 "errors":[ 220 {"shape":"ValidationException"}, 221 {"shape":"AccessDeniedException"}, 222 {"shape":"ResourceNotFoundException"} 223 ] 224 }, 225 "GetKnowledgeBase":{ 226 "name":"GetKnowledgeBase", 227 "http":{ 228 "method":"GET", 229 "requestUri":"/knowledgeBases/{knowledgeBaseId}", 230 "responseCode":200 231 }, 232 "input":{"shape":"GetKnowledgeBaseRequest"}, 233 "output":{"shape":"GetKnowledgeBaseResponse"}, 234 "errors":[ 235 {"shape":"ValidationException"}, 236 {"shape":"AccessDeniedException"}, 237 {"shape":"ResourceNotFoundException"} 238 ] 239 }, 240 "GetRecommendations":{ 241 "name":"GetRecommendations", 242 "http":{ 243 "method":"GET", 244 "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations", 245 "responseCode":200 246 }, 247 "input":{"shape":"GetRecommendationsRequest"}, 248 "output":{"shape":"GetRecommendationsResponse"}, 249 "errors":[ 250 {"shape":"ValidationException"}, 251 {"shape":"AccessDeniedException"}, 252 {"shape":"ResourceNotFoundException"} 253 ] 254 }, 255 "GetSession":{ 256 "name":"GetSession", 257 "http":{ 258 "method":"GET", 259 "requestUri":"/assistants/{assistantId}/sessions/{sessionId}", 260 "responseCode":200 261 }, 262 "input":{"shape":"GetSessionRequest"}, 263 "output":{"shape":"GetSessionResponse"}, 264 "errors":[ 265 {"shape":"ValidationException"}, 266 {"shape":"AccessDeniedException"}, 267 {"shape":"ResourceNotFoundException"} 268 ] 269 }, 270 "ListAssistantAssociations":{ 271 "name":"ListAssistantAssociations", 272 "http":{ 273 "method":"GET", 274 "requestUri":"/assistants/{assistantId}/associations", 275 "responseCode":200 276 }, 277 "input":{"shape":"ListAssistantAssociationsRequest"}, 278 "output":{"shape":"ListAssistantAssociationsResponse"}, 279 "errors":[ 280 {"shape":"ValidationException"}, 281 {"shape":"AccessDeniedException"}, 282 {"shape":"ResourceNotFoundException"} 283 ] 284 }, 285 "ListAssistants":{ 286 "name":"ListAssistants", 287 "http":{ 288 "method":"GET", 289 "requestUri":"/assistants", 290 "responseCode":200 291 }, 292 "input":{"shape":"ListAssistantsRequest"}, 293 "output":{"shape":"ListAssistantsResponse"}, 294 "errors":[ 295 {"shape":"ValidationException"}, 296 {"shape":"AccessDeniedException"} 297 ] 298 }, 299 "ListContents":{ 300 "name":"ListContents", 301 "http":{ 302 "method":"GET", 303 "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", 304 "responseCode":200 305 }, 306 "input":{"shape":"ListContentsRequest"}, 307 "output":{"shape":"ListContentsResponse"}, 308 "errors":[ 309 {"shape":"ValidationException"}, 310 {"shape":"AccessDeniedException"}, 311 {"shape":"ResourceNotFoundException"} 312 ] 313 }, 314 "ListKnowledgeBases":{ 315 "name":"ListKnowledgeBases", 316 "http":{ 317 "method":"GET", 318 "requestUri":"/knowledgeBases", 319 "responseCode":200 320 }, 321 "input":{"shape":"ListKnowledgeBasesRequest"}, 322 "output":{"shape":"ListKnowledgeBasesResponse"}, 323 "errors":[ 324 {"shape":"ValidationException"}, 325 {"shape":"AccessDeniedException"} 326 ] 327 }, 328 "ListTagsForResource":{ 329 "name":"ListTagsForResource", 330 "http":{ 331 "method":"GET", 332 "requestUri":"/tags/{resourceArn}", 333 "responseCode":200 334 }, 335 "input":{"shape":"ListTagsForResourceRequest"}, 336 "output":{"shape":"ListTagsForResourceResponse"}, 337 "errors":[ 338 {"shape":"ResourceNotFoundException"} 339 ] 340 }, 341 "NotifyRecommendationsReceived":{ 342 "name":"NotifyRecommendationsReceived", 343 "http":{ 344 "method":"POST", 345 "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify", 346 "responseCode":200 347 }, 348 "input":{"shape":"NotifyRecommendationsReceivedRequest"}, 349 "output":{"shape":"NotifyRecommendationsReceivedResponse"}, 350 "errors":[ 351 {"shape":"ValidationException"}, 352 {"shape":"AccessDeniedException"}, 353 {"shape":"ResourceNotFoundException"} 354 ], 355 "idempotent":true 356 }, 357 "QueryAssistant":{ 358 "name":"QueryAssistant", 359 "http":{ 360 "method":"POST", 361 "requestUri":"/assistants/{assistantId}/query", 362 "responseCode":200 363 }, 364 "input":{"shape":"QueryAssistantRequest"}, 365 "output":{"shape":"QueryAssistantResponse"}, 366 "errors":[ 367 {"shape":"ValidationException"}, 368 {"shape":"AccessDeniedException"}, 369 {"shape":"ResourceNotFoundException"} 370 ] 371 }, 372 "RemoveKnowledgeBaseTemplateUri":{ 373 "name":"RemoveKnowledgeBaseTemplateUri", 374 "http":{ 375 "method":"DELETE", 376 "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", 377 "responseCode":204 378 }, 379 "input":{"shape":"RemoveKnowledgeBaseTemplateUriRequest"}, 380 "output":{"shape":"RemoveKnowledgeBaseTemplateUriResponse"}, 381 "errors":[ 382 {"shape":"ValidationException"}, 383 {"shape":"AccessDeniedException"}, 384 {"shape":"ResourceNotFoundException"} 385 ] 386 }, 387 "SearchContent":{ 388 "name":"SearchContent", 389 "http":{ 390 "method":"POST", 391 "requestUri":"/knowledgeBases/{knowledgeBaseId}/search", 392 "responseCode":200 393 }, 394 "input":{"shape":"SearchContentRequest"}, 395 "output":{"shape":"SearchContentResponse"}, 396 "errors":[ 397 {"shape":"ValidationException"}, 398 {"shape":"AccessDeniedException"}, 399 {"shape":"ResourceNotFoundException"} 400 ] 401 }, 402 "SearchSessions":{ 403 "name":"SearchSessions", 404 "http":{ 405 "method":"POST", 406 "requestUri":"/assistants/{assistantId}/searchSessions", 407 "responseCode":200 408 }, 409 "input":{"shape":"SearchSessionsRequest"}, 410 "output":{"shape":"SearchSessionsResponse"}, 411 "errors":[ 412 {"shape":"ValidationException"}, 413 {"shape":"AccessDeniedException"}, 414 {"shape":"ResourceNotFoundException"} 415 ] 416 }, 417 "StartContentUpload":{ 418 "name":"StartContentUpload", 419 "http":{ 420 "method":"POST", 421 "requestUri":"/knowledgeBases/{knowledgeBaseId}/upload", 422 "responseCode":200 423 }, 424 "input":{"shape":"StartContentUploadRequest"}, 425 "output":{"shape":"StartContentUploadResponse"}, 426 "errors":[ 427 {"shape":"ValidationException"}, 428 {"shape":"AccessDeniedException"}, 429 {"shape":"ResourceNotFoundException"} 430 ] 431 }, 432 "TagResource":{ 433 "name":"TagResource", 434 "http":{ 435 "method":"POST", 436 "requestUri":"/tags/{resourceArn}", 437 "responseCode":200 438 }, 439 "input":{"shape":"TagResourceRequest"}, 440 "output":{"shape":"TagResourceResponse"}, 441 "errors":[ 442 {"shape":"TooManyTagsException"}, 443 {"shape":"ResourceNotFoundException"} 444 ], 445 "idempotent":true 446 }, 447 "UntagResource":{ 448 "name":"UntagResource", 449 "http":{ 450 "method":"DELETE", 451 "requestUri":"/tags/{resourceArn}", 452 "responseCode":200 453 }, 454 "input":{"shape":"UntagResourceRequest"}, 455 "output":{"shape":"UntagResourceResponse"}, 456 "errors":[ 457 {"shape":"ResourceNotFoundException"} 458 ], 459 "idempotent":true 460 }, 461 "UpdateContent":{ 462 "name":"UpdateContent", 463 "http":{ 464 "method":"POST", 465 "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", 466 "responseCode":200 467 }, 468 "input":{"shape":"UpdateContentRequest"}, 469 "output":{"shape":"UpdateContentResponse"}, 470 "errors":[ 471 {"shape":"ValidationException"}, 472 {"shape":"AccessDeniedException"}, 473 {"shape":"PreconditionFailedException"}, 474 {"shape":"ResourceNotFoundException"} 475 ] 476 }, 477 "UpdateKnowledgeBaseTemplateUri":{ 478 "name":"UpdateKnowledgeBaseTemplateUri", 479 "http":{ 480 "method":"POST", 481 "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", 482 "responseCode":200 483 }, 484 "input":{"shape":"UpdateKnowledgeBaseTemplateUriRequest"}, 485 "output":{"shape":"UpdateKnowledgeBaseTemplateUriResponse"}, 486 "errors":[ 487 {"shape":"ValidationException"}, 488 {"shape":"AccessDeniedException"}, 489 {"shape":"ResourceNotFoundException"} 490 ] 491 } 492 }, 493 "shapes":{ 494 "AccessDeniedException":{ 495 "type":"structure", 496 "members":{ 497 "message":{"shape":"String"} 498 }, 499 "error":{ 500 "httpStatusCode":403, 501 "senderFault":true 502 }, 503 "exception":true 504 }, 505 "AppIntegrationsConfiguration":{ 506 "type":"structure", 507 "required":[ 508 "appIntegrationArn", 509 "objectFields" 510 ], 511 "members":{ 512 "appIntegrationArn":{"shape":"GenericArn"}, 513 "objectFields":{"shape":"ObjectFieldsList"} 514 } 515 }, 516 "Arn":{ 517 "type":"string", 518 "pattern":"^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" 519 }, 520 "AssistantAssociationData":{ 521 "type":"structure", 522 "required":[ 523 "assistantArn", 524 "assistantAssociationArn", 525 "assistantAssociationId", 526 "assistantId", 527 "associationData", 528 "associationType" 529 ], 530 "members":{ 531 "assistantArn":{"shape":"Arn"}, 532 "assistantAssociationArn":{"shape":"Arn"}, 533 "assistantAssociationId":{"shape":"Uuid"}, 534 "assistantId":{"shape":"Uuid"}, 535 "associationData":{"shape":"AssistantAssociationOutputData"}, 536 "associationType":{"shape":"AssociationType"}, 537 "tags":{"shape":"Tags"} 538 } 539 }, 540 "AssistantAssociationInputData":{ 541 "type":"structure", 542 "members":{ 543 "knowledgeBaseId":{"shape":"Uuid"} 544 }, 545 "union":true 546 }, 547 "AssistantAssociationOutputData":{ 548 "type":"structure", 549 "members":{ 550 "knowledgeBaseAssociation":{"shape":"KnowledgeBaseAssociationData"} 551 }, 552 "union":true 553 }, 554 "AssistantAssociationSummary":{ 555 "type":"structure", 556 "required":[ 557 "assistantArn", 558 "assistantAssociationArn", 559 "assistantAssociationId", 560 "assistantId", 561 "associationData", 562 "associationType" 563 ], 564 "members":{ 565 "assistantArn":{"shape":"Arn"}, 566 "assistantAssociationArn":{"shape":"Arn"}, 567 "assistantAssociationId":{"shape":"Uuid"}, 568 "assistantId":{"shape":"Uuid"}, 569 "associationData":{"shape":"AssistantAssociationOutputData"}, 570 "associationType":{"shape":"AssociationType"}, 571 "tags":{"shape":"Tags"} 572 } 573 }, 574 "AssistantAssociationSummaryList":{ 575 "type":"list", 576 "member":{"shape":"AssistantAssociationSummary"} 577 }, 578 "AssistantData":{ 579 "type":"structure", 580 "required":[ 581 "assistantArn", 582 "assistantId", 583 "name", 584 "status", 585 "type" 586 ], 587 "members":{ 588 "assistantArn":{"shape":"Arn"}, 589 "assistantId":{"shape":"Uuid"}, 590 "description":{"shape":"Description"}, 591 "name":{"shape":"Name"}, 592 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 593 "status":{"shape":"AssistantStatus"}, 594 "tags":{"shape":"Tags"}, 595 "type":{"shape":"AssistantType"} 596 } 597 }, 598 "AssistantList":{ 599 "type":"list", 600 "member":{"shape":"AssistantSummary"} 601 }, 602 "AssistantStatus":{ 603 "type":"string", 604 "enum":[ 605 "CREATE_IN_PROGRESS", 606 "CREATE_FAILED", 607 "ACTIVE", 608 "DELETE_IN_PROGRESS", 609 "DELETE_FAILED", 610 "DELETED" 611 ] 612 }, 613 "AssistantSummary":{ 614 "type":"structure", 615 "required":[ 616 "assistantArn", 617 "assistantId", 618 "name", 619 "status", 620 "type" 621 ], 622 "members":{ 623 "assistantArn":{"shape":"Arn"}, 624 "assistantId":{"shape":"Uuid"}, 625 "description":{"shape":"Description"}, 626 "name":{"shape":"Name"}, 627 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 628 "status":{"shape":"AssistantStatus"}, 629 "tags":{"shape":"Tags"}, 630 "type":{"shape":"AssistantType"} 631 } 632 }, 633 "AssistantType":{ 634 "type":"string", 635 "enum":["AGENT"] 636 }, 637 "AssociationType":{ 638 "type":"string", 639 "enum":["KNOWLEDGE_BASE"] 640 }, 641 "Boolean":{ 642 "type":"boolean", 643 "box":true 644 }, 645 "ClientToken":{ 646 "type":"string", 647 "max":4096, 648 "min":1 649 }, 650 "ConflictException":{ 651 "type":"structure", 652 "members":{ 653 "message":{"shape":"String"} 654 }, 655 "error":{ 656 "httpStatusCode":409, 657 "senderFault":true 658 }, 659 "exception":true 660 }, 661 "ContentData":{ 662 "type":"structure", 663 "required":[ 664 "contentArn", 665 "contentId", 666 "contentType", 667 "knowledgeBaseArn", 668 "knowledgeBaseId", 669 "metadata", 670 "name", 671 "revisionId", 672 "status", 673 "title", 674 "url", 675 "urlExpiry" 676 ], 677 "members":{ 678 "contentArn":{"shape":"Arn"}, 679 "contentId":{"shape":"Uuid"}, 680 "contentType":{"shape":"ContentType"}, 681 "knowledgeBaseArn":{"shape":"Arn"}, 682 "knowledgeBaseId":{"shape":"Uuid"}, 683 "linkOutUri":{"shape":"Uri"}, 684 "metadata":{"shape":"ContentMetadata"}, 685 "name":{"shape":"Name"}, 686 "revisionId":{"shape":"NonEmptyString"}, 687 "status":{"shape":"ContentStatus"}, 688 "tags":{"shape":"Tags"}, 689 "title":{"shape":"ContentTitle"}, 690 "url":{"shape":"SyntheticContentDataUrl"}, 691 "urlExpiry":{"shape":"SyntheticTimestamp_epoch_seconds"} 692 } 693 }, 694 "ContentMetadata":{ 695 "type":"map", 696 "key":{"shape":"NonEmptyString"}, 697 "value":{"shape":"NonEmptyString"} 698 }, 699 "ContentReference":{ 700 "type":"structure", 701 "members":{ 702 "contentArn":{"shape":"Arn"}, 703 "contentId":{"shape":"Uuid"}, 704 "knowledgeBaseArn":{"shape":"Arn"}, 705 "knowledgeBaseId":{"shape":"Uuid"} 706 } 707 }, 708 "ContentStatus":{ 709 "type":"string", 710 "enum":[ 711 "CREATE_IN_PROGRESS", 712 "CREATE_FAILED", 713 "ACTIVE", 714 "DELETE_IN_PROGRESS", 715 "DELETE_FAILED", 716 "DELETED", 717 "UPDATE_FAILED" 718 ] 719 }, 720 "ContentSummary":{ 721 "type":"structure", 722 "required":[ 723 "contentArn", 724 "contentId", 725 "contentType", 726 "knowledgeBaseArn", 727 "knowledgeBaseId", 728 "metadata", 729 "name", 730 "revisionId", 731 "status", 732 "title" 733 ], 734 "members":{ 735 "contentArn":{"shape":"Arn"}, 736 "contentId":{"shape":"Uuid"}, 737 "contentType":{"shape":"ContentType"}, 738 "knowledgeBaseArn":{"shape":"Arn"}, 739 "knowledgeBaseId":{"shape":"Uuid"}, 740 "metadata":{"shape":"ContentMetadata"}, 741 "name":{"shape":"Name"}, 742 "revisionId":{"shape":"NonEmptyString"}, 743 "status":{"shape":"ContentStatus"}, 744 "tags":{"shape":"Tags"}, 745 "title":{"shape":"ContentTitle"} 746 } 747 }, 748 "ContentSummaryList":{ 749 "type":"list", 750 "member":{"shape":"ContentSummary"} 751 }, 752 "ContentTitle":{ 753 "type":"string", 754 "max":255, 755 "min":1 756 }, 757 "ContentType":{ 758 "type":"string", 759 "pattern":"^(text/(plain|html))|(application/x\\.wisdom-json;source=(salesforce|servicenow))$" 760 }, 761 "CreateAssistantAssociationRequest":{ 762 "type":"structure", 763 "required":[ 764 "assistantId", 765 "association", 766 "associationType" 767 ], 768 "members":{ 769 "assistantId":{ 770 "shape":"UuidOrArn", 771 "location":"uri", 772 "locationName":"assistantId" 773 }, 774 "association":{"shape":"AssistantAssociationInputData"}, 775 "associationType":{"shape":"AssociationType"}, 776 "clientToken":{ 777 "shape":"ClientToken", 778 "idempotencyToken":true 779 }, 780 "tags":{"shape":"Tags"} 781 } 782 }, 783 "CreateAssistantAssociationResponse":{ 784 "type":"structure", 785 "members":{ 786 "assistantAssociation":{"shape":"AssistantAssociationData"} 787 } 788 }, 789 "CreateAssistantRequest":{ 790 "type":"structure", 791 "required":[ 792 "name", 793 "type" 794 ], 795 "members":{ 796 "clientToken":{ 797 "shape":"ClientToken", 798 "idempotencyToken":true 799 }, 800 "description":{"shape":"Description"}, 801 "name":{"shape":"Name"}, 802 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 803 "tags":{"shape":"Tags"}, 804 "type":{"shape":"AssistantType"} 805 } 806 }, 807 "CreateAssistantResponse":{ 808 "type":"structure", 809 "members":{ 810 "assistant":{"shape":"AssistantData"} 811 } 812 }, 813 "CreateContentRequest":{ 814 "type":"structure", 815 "required":[ 816 "knowledgeBaseId", 817 "name", 818 "uploadId" 819 ], 820 "members":{ 821 "clientToken":{ 822 "shape":"NonEmptyString", 823 "idempotencyToken":true 824 }, 825 "knowledgeBaseId":{ 826 "shape":"UuidOrArn", 827 "location":"uri", 828 "locationName":"knowledgeBaseId" 829 }, 830 "metadata":{"shape":"ContentMetadata"}, 831 "name":{"shape":"Name"}, 832 "overrideLinkOutUri":{"shape":"Uri"}, 833 "tags":{"shape":"Tags"}, 834 "title":{"shape":"ContentTitle"}, 835 "uploadId":{"shape":"NonEmptyString"} 836 } 837 }, 838 "CreateContentResponse":{ 839 "type":"structure", 840 "members":{ 841 "content":{"shape":"ContentData"} 842 } 843 }, 844 "CreateKnowledgeBaseRequest":{ 845 "type":"structure", 846 "required":[ 847 "knowledgeBaseType", 848 "name" 849 ], 850 "members":{ 851 "clientToken":{ 852 "shape":"NonEmptyString", 853 "idempotencyToken":true 854 }, 855 "description":{"shape":"Description"}, 856 "knowledgeBaseType":{"shape":"KnowledgeBaseType"}, 857 "name":{"shape":"Name"}, 858 "renderingConfiguration":{"shape":"RenderingConfiguration"}, 859 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 860 "sourceConfiguration":{"shape":"SourceConfiguration"}, 861 "tags":{"shape":"Tags"} 862 } 863 }, 864 "CreateKnowledgeBaseResponse":{ 865 "type":"structure", 866 "members":{ 867 "knowledgeBase":{"shape":"KnowledgeBaseData"} 868 } 869 }, 870 "CreateSessionRequest":{ 871 "type":"structure", 872 "required":[ 873 "assistantId", 874 "name" 875 ], 876 "members":{ 877 "assistantId":{ 878 "shape":"UuidOrArn", 879 "location":"uri", 880 "locationName":"assistantId" 881 }, 882 "clientToken":{ 883 "shape":"ClientToken", 884 "idempotencyToken":true 885 }, 886 "description":{"shape":"Description"}, 887 "name":{"shape":"Name"}, 888 "tags":{"shape":"Tags"} 889 } 890 }, 891 "CreateSessionResponse":{ 892 "type":"structure", 893 "members":{ 894 "session":{"shape":"SessionData"} 895 } 896 }, 897 "DeleteAssistantAssociationRequest":{ 898 "type":"structure", 899 "required":[ 900 "assistantAssociationId", 901 "assistantId" 902 ], 903 "members":{ 904 "assistantAssociationId":{ 905 "shape":"UuidOrArn", 906 "location":"uri", 907 "locationName":"assistantAssociationId" 908 }, 909 "assistantId":{ 910 "shape":"UuidOrArn", 911 "location":"uri", 912 "locationName":"assistantId" 913 } 914 } 915 }, 916 "DeleteAssistantAssociationResponse":{ 917 "type":"structure", 918 "members":{ 919 } 920 }, 921 "DeleteAssistantRequest":{ 922 "type":"structure", 923 "required":["assistantId"], 924 "members":{ 925 "assistantId":{ 926 "shape":"UuidOrArn", 927 "location":"uri", 928 "locationName":"assistantId" 929 } 930 } 931 }, 932 "DeleteAssistantResponse":{ 933 "type":"structure", 934 "members":{ 935 } 936 }, 937 "DeleteContentRequest":{ 938 "type":"structure", 939 "required":[ 940 "contentId", 941 "knowledgeBaseId" 942 ], 943 "members":{ 944 "contentId":{ 945 "shape":"UuidOrArn", 946 "location":"uri", 947 "locationName":"contentId" 948 }, 949 "knowledgeBaseId":{ 950 "shape":"UuidOrArn", 951 "location":"uri", 952 "locationName":"knowledgeBaseId" 953 } 954 } 955 }, 956 "DeleteContentResponse":{ 957 "type":"structure", 958 "members":{ 959 } 960 }, 961 "DeleteKnowledgeBaseRequest":{ 962 "type":"structure", 963 "required":["knowledgeBaseId"], 964 "members":{ 965 "knowledgeBaseId":{ 966 "shape":"UuidOrArn", 967 "location":"uri", 968 "locationName":"knowledgeBaseId" 969 } 970 } 971 }, 972 "DeleteKnowledgeBaseResponse":{ 973 "type":"structure", 974 "members":{ 975 } 976 }, 977 "Description":{ 978 "type":"string", 979 "max":255, 980 "min":1, 981 "pattern":"^[a-zA-Z0-9\\s_.,-]+" 982 }, 983 "Document":{ 984 "type":"structure", 985 "required":["contentReference"], 986 "members":{ 987 "contentReference":{"shape":"ContentReference"}, 988 "excerpt":{"shape":"DocumentText"}, 989 "title":{"shape":"DocumentText"} 990 } 991 }, 992 "DocumentText":{ 993 "type":"structure", 994 "members":{ 995 "highlights":{"shape":"Highlights"}, 996 "text":{"shape":"SyntheticDocumentTextString"} 997 } 998 }, 999 "Filter":{ 1000 "type":"structure", 1001 "required":[ 1002 "field", 1003 "operator", 1004 "value" 1005 ], 1006 "members":{ 1007 "field":{"shape":"FilterField"}, 1008 "operator":{"shape":"FilterOperator"}, 1009 "value":{"shape":"NonEmptyString"} 1010 } 1011 }, 1012 "FilterField":{ 1013 "type":"string", 1014 "enum":["NAME"] 1015 }, 1016 "FilterList":{ 1017 "type":"list", 1018 "member":{"shape":"Filter"} 1019 }, 1020 "FilterOperator":{ 1021 "type":"string", 1022 "enum":["EQUALS"] 1023 }, 1024 "GenericArn":{ 1025 "type":"string", 1026 "max":2048, 1027 "min":1, 1028 "pattern":"^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" 1029 }, 1030 "GetAssistantAssociationRequest":{ 1031 "type":"structure", 1032 "required":[ 1033 "assistantAssociationId", 1034 "assistantId" 1035 ], 1036 "members":{ 1037 "assistantAssociationId":{ 1038 "shape":"UuidOrArn", 1039 "location":"uri", 1040 "locationName":"assistantAssociationId" 1041 }, 1042 "assistantId":{ 1043 "shape":"UuidOrArn", 1044 "location":"uri", 1045 "locationName":"assistantId" 1046 } 1047 } 1048 }, 1049 "GetAssistantAssociationResponse":{ 1050 "type":"structure", 1051 "members":{ 1052 "assistantAssociation":{"shape":"AssistantAssociationData"} 1053 } 1054 }, 1055 "GetAssistantRequest":{ 1056 "type":"structure", 1057 "required":["assistantId"], 1058 "members":{ 1059 "assistantId":{ 1060 "shape":"UuidOrArn", 1061 "location":"uri", 1062 "locationName":"assistantId" 1063 } 1064 } 1065 }, 1066 "GetAssistantResponse":{ 1067 "type":"structure", 1068 "members":{ 1069 "assistant":{"shape":"AssistantData"} 1070 } 1071 }, 1072 "GetContentRequest":{ 1073 "type":"structure", 1074 "required":[ 1075 "contentId", 1076 "knowledgeBaseId" 1077 ], 1078 "members":{ 1079 "contentId":{ 1080 "shape":"UuidOrArn", 1081 "location":"uri", 1082 "locationName":"contentId" 1083 }, 1084 "knowledgeBaseId":{ 1085 "shape":"UuidOrArn", 1086 "location":"uri", 1087 "locationName":"knowledgeBaseId" 1088 } 1089 } 1090 }, 1091 "GetContentResponse":{ 1092 "type":"structure", 1093 "members":{ 1094 "content":{"shape":"ContentData"} 1095 } 1096 }, 1097 "GetContentSummaryRequest":{ 1098 "type":"structure", 1099 "required":[ 1100 "contentId", 1101 "knowledgeBaseId" 1102 ], 1103 "members":{ 1104 "contentId":{ 1105 "shape":"UuidOrArn", 1106 "location":"uri", 1107 "locationName":"contentId" 1108 }, 1109 "knowledgeBaseId":{ 1110 "shape":"UuidOrArn", 1111 "location":"uri", 1112 "locationName":"knowledgeBaseId" 1113 } 1114 } 1115 }, 1116 "GetContentSummaryResponse":{ 1117 "type":"structure", 1118 "members":{ 1119 "contentSummary":{"shape":"ContentSummary"} 1120 } 1121 }, 1122 "GetKnowledgeBaseRequest":{ 1123 "type":"structure", 1124 "required":["knowledgeBaseId"], 1125 "members":{ 1126 "knowledgeBaseId":{ 1127 "shape":"UuidOrArn", 1128 "location":"uri", 1129 "locationName":"knowledgeBaseId" 1130 } 1131 } 1132 }, 1133 "GetKnowledgeBaseResponse":{ 1134 "type":"structure", 1135 "members":{ 1136 "knowledgeBase":{"shape":"KnowledgeBaseData"} 1137 } 1138 }, 1139 "GetRecommendationsRequest":{ 1140 "type":"structure", 1141 "required":[ 1142 "assistantId", 1143 "sessionId" 1144 ], 1145 "members":{ 1146 "assistantId":{ 1147 "shape":"UuidOrArn", 1148 "location":"uri", 1149 "locationName":"assistantId" 1150 }, 1151 "maxResults":{ 1152 "shape":"MaxResults", 1153 "location":"querystring", 1154 "locationName":"maxResults" 1155 }, 1156 "sessionId":{ 1157 "shape":"UuidOrArn", 1158 "location":"uri", 1159 "locationName":"sessionId" 1160 }, 1161 "waitTimeSeconds":{ 1162 "shape":"WaitTimeSeconds", 1163 "location":"querystring", 1164 "locationName":"waitTimeSeconds" 1165 } 1166 } 1167 }, 1168 "GetRecommendationsResponse":{ 1169 "type":"structure", 1170 "required":["recommendations"], 1171 "members":{ 1172 "recommendations":{"shape":"RecommendationList"} 1173 } 1174 }, 1175 "GetSessionRequest":{ 1176 "type":"structure", 1177 "required":[ 1178 "assistantId", 1179 "sessionId" 1180 ], 1181 "members":{ 1182 "assistantId":{ 1183 "shape":"UuidOrArn", 1184 "location":"uri", 1185 "locationName":"assistantId" 1186 }, 1187 "sessionId":{ 1188 "shape":"UuidOrArn", 1189 "location":"uri", 1190 "locationName":"sessionId" 1191 } 1192 } 1193 }, 1194 "GetSessionResponse":{ 1195 "type":"structure", 1196 "members":{ 1197 "session":{"shape":"SessionData"} 1198 } 1199 }, 1200 "Headers":{ 1201 "type":"map", 1202 "key":{"shape":"NonEmptyString"}, 1203 "value":{"shape":"NonEmptyString"} 1204 }, 1205 "Highlight":{ 1206 "type":"structure", 1207 "members":{ 1208 "beginOffsetInclusive":{"shape":"HighlightOffset"}, 1209 "endOffsetExclusive":{"shape":"HighlightOffset"} 1210 } 1211 }, 1212 "HighlightOffset":{"type":"integer"}, 1213 "Highlights":{ 1214 "type":"list", 1215 "member":{"shape":"Highlight"} 1216 }, 1217 "KnowledgeBaseAssociationData":{ 1218 "type":"structure", 1219 "members":{ 1220 "knowledgeBaseArn":{"shape":"Arn"}, 1221 "knowledgeBaseId":{"shape":"Uuid"} 1222 } 1223 }, 1224 "KnowledgeBaseData":{ 1225 "type":"structure", 1226 "required":[ 1227 "knowledgeBaseArn", 1228 "knowledgeBaseId", 1229 "knowledgeBaseType", 1230 "name", 1231 "status" 1232 ], 1233 "members":{ 1234 "description":{"shape":"Description"}, 1235 "knowledgeBaseArn":{"shape":"Arn"}, 1236 "knowledgeBaseId":{"shape":"Uuid"}, 1237 "knowledgeBaseType":{"shape":"KnowledgeBaseType"}, 1238 "lastContentModificationTime":{"shape":"SyntheticTimestamp_epoch_seconds"}, 1239 "name":{"shape":"Name"}, 1240 "renderingConfiguration":{"shape":"RenderingConfiguration"}, 1241 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 1242 "sourceConfiguration":{"shape":"SourceConfiguration"}, 1243 "status":{"shape":"KnowledgeBaseStatus"}, 1244 "tags":{"shape":"Tags"} 1245 } 1246 }, 1247 "KnowledgeBaseList":{ 1248 "type":"list", 1249 "member":{"shape":"KnowledgeBaseSummary"} 1250 }, 1251 "KnowledgeBaseStatus":{ 1252 "type":"string", 1253 "enum":[ 1254 "CREATE_IN_PROGRESS", 1255 "CREATE_FAILED", 1256 "ACTIVE", 1257 "DELETE_IN_PROGRESS", 1258 "DELETE_FAILED", 1259 "DELETED" 1260 ] 1261 }, 1262 "KnowledgeBaseSummary":{ 1263 "type":"structure", 1264 "required":[ 1265 "knowledgeBaseArn", 1266 "knowledgeBaseId", 1267 "knowledgeBaseType", 1268 "name", 1269 "status" 1270 ], 1271 "members":{ 1272 "description":{"shape":"Description"}, 1273 "knowledgeBaseArn":{"shape":"Arn"}, 1274 "knowledgeBaseId":{"shape":"Uuid"}, 1275 "knowledgeBaseType":{"shape":"KnowledgeBaseType"}, 1276 "name":{"shape":"Name"}, 1277 "renderingConfiguration":{"shape":"RenderingConfiguration"}, 1278 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 1279 "sourceConfiguration":{"shape":"SourceConfiguration"}, 1280 "status":{"shape":"KnowledgeBaseStatus"}, 1281 "tags":{"shape":"Tags"} 1282 } 1283 }, 1284 "KnowledgeBaseType":{ 1285 "type":"string", 1286 "enum":[ 1287 "EXTERNAL", 1288 "CUSTOM" 1289 ] 1290 }, 1291 "ListAssistantAssociationsRequest":{ 1292 "type":"structure", 1293 "required":["assistantId"], 1294 "members":{ 1295 "assistantId":{ 1296 "shape":"UuidOrArn", 1297 "location":"uri", 1298 "locationName":"assistantId" 1299 }, 1300 "maxResults":{ 1301 "shape":"MaxResults", 1302 "location":"querystring", 1303 "locationName":"maxResults" 1304 }, 1305 "nextToken":{ 1306 "shape":"NextToken", 1307 "location":"querystring", 1308 "locationName":"nextToken" 1309 } 1310 } 1311 }, 1312 "ListAssistantAssociationsResponse":{ 1313 "type":"structure", 1314 "required":["assistantAssociationSummaries"], 1315 "members":{ 1316 "assistantAssociationSummaries":{"shape":"AssistantAssociationSummaryList"}, 1317 "nextToken":{"shape":"NextToken"} 1318 } 1319 }, 1320 "ListAssistantsRequest":{ 1321 "type":"structure", 1322 "members":{ 1323 "maxResults":{ 1324 "shape":"MaxResults", 1325 "location":"querystring", 1326 "locationName":"maxResults" 1327 }, 1328 "nextToken":{ 1329 "shape":"NextToken", 1330 "location":"querystring", 1331 "locationName":"nextToken" 1332 } 1333 } 1334 }, 1335 "ListAssistantsResponse":{ 1336 "type":"structure", 1337 "required":["assistantSummaries"], 1338 "members":{ 1339 "assistantSummaries":{"shape":"AssistantList"}, 1340 "nextToken":{"shape":"NextToken"} 1341 } 1342 }, 1343 "ListContentsRequest":{ 1344 "type":"structure", 1345 "required":["knowledgeBaseId"], 1346 "members":{ 1347 "knowledgeBaseId":{ 1348 "shape":"UuidOrArn", 1349 "location":"uri", 1350 "locationName":"knowledgeBaseId" 1351 }, 1352 "maxResults":{ 1353 "shape":"MaxResults", 1354 "location":"querystring", 1355 "locationName":"maxResults" 1356 }, 1357 "nextToken":{ 1358 "shape":"NextToken", 1359 "location":"querystring", 1360 "locationName":"nextToken" 1361 } 1362 } 1363 }, 1364 "ListContentsResponse":{ 1365 "type":"structure", 1366 "required":["contentSummaries"], 1367 "members":{ 1368 "contentSummaries":{"shape":"ContentSummaryList"}, 1369 "nextToken":{"shape":"NextToken"} 1370 } 1371 }, 1372 "ListKnowledgeBasesRequest":{ 1373 "type":"structure", 1374 "members":{ 1375 "maxResults":{ 1376 "shape":"MaxResults", 1377 "location":"querystring", 1378 "locationName":"maxResults" 1379 }, 1380 "nextToken":{ 1381 "shape":"NonEmptyString", 1382 "location":"querystring", 1383 "locationName":"nextToken" 1384 } 1385 } 1386 }, 1387 "ListKnowledgeBasesResponse":{ 1388 "type":"structure", 1389 "required":["knowledgeBaseSummaries"], 1390 "members":{ 1391 "knowledgeBaseSummaries":{"shape":"KnowledgeBaseList"}, 1392 "nextToken":{"shape":"NonEmptyString"} 1393 } 1394 }, 1395 "ListTagsForResourceRequest":{ 1396 "type":"structure", 1397 "required":["resourceArn"], 1398 "members":{ 1399 "resourceArn":{ 1400 "shape":"Arn", 1401 "location":"uri", 1402 "locationName":"resourceArn" 1403 } 1404 } 1405 }, 1406 "ListTagsForResourceResponse":{ 1407 "type":"structure", 1408 "members":{ 1409 "tags":{"shape":"Tags"} 1410 } 1411 }, 1412 "MaxResults":{ 1413 "type":"integer", 1414 "box":true, 1415 "max":100, 1416 "min":1 1417 }, 1418 "Name":{ 1419 "type":"string", 1420 "max":255, 1421 "min":1, 1422 "pattern":"^[a-zA-Z0-9\\s_.,-]+" 1423 }, 1424 "NextToken":{ 1425 "type":"string", 1426 "max":2048, 1427 "min":1 1428 }, 1429 "NonEmptyString":{ 1430 "type":"string", 1431 "max":4096, 1432 "min":1 1433 }, 1434 "NotifyRecommendationsReceivedError":{ 1435 "type":"structure", 1436 "members":{ 1437 "message":{"shape":"NotifyRecommendationsReceivedErrorMessage"}, 1438 "recommendationId":{"shape":"String"} 1439 } 1440 }, 1441 "NotifyRecommendationsReceivedErrorList":{ 1442 "type":"list", 1443 "member":{"shape":"NotifyRecommendationsReceivedError"} 1444 }, 1445 "NotifyRecommendationsReceivedErrorMessage":{"type":"string"}, 1446 "NotifyRecommendationsReceivedRequest":{ 1447 "type":"structure", 1448 "required":[ 1449 "assistantId", 1450 "recommendationIds", 1451 "sessionId" 1452 ], 1453 "members":{ 1454 "assistantId":{ 1455 "shape":"UuidOrArn", 1456 "location":"uri", 1457 "locationName":"assistantId" 1458 }, 1459 "recommendationIds":{"shape":"RecommendationIdList"}, 1460 "sessionId":{ 1461 "shape":"UuidOrArn", 1462 "location":"uri", 1463 "locationName":"sessionId" 1464 } 1465 } 1466 }, 1467 "NotifyRecommendationsReceivedResponse":{ 1468 "type":"structure", 1469 "members":{ 1470 "errors":{"shape":"NotifyRecommendationsReceivedErrorList"}, 1471 "recommendationIds":{"shape":"RecommendationIdList"} 1472 } 1473 }, 1474 "ObjectFieldsList":{ 1475 "type":"list", 1476 "member":{"shape":"NonEmptyString"}, 1477 "max":100, 1478 "min":1 1479 }, 1480 "PreconditionFailedException":{ 1481 "type":"structure", 1482 "members":{ 1483 "message":{"shape":"String"} 1484 }, 1485 "error":{ 1486 "httpStatusCode":412, 1487 "senderFault":true 1488 }, 1489 "exception":true 1490 }, 1491 "QueryAssistantRequest":{ 1492 "type":"structure", 1493 "required":[ 1494 "assistantId", 1495 "queryText" 1496 ], 1497 "members":{ 1498 "assistantId":{ 1499 "shape":"UuidOrArn", 1500 "location":"uri", 1501 "locationName":"assistantId" 1502 }, 1503 "maxResults":{"shape":"MaxResults"}, 1504 "nextToken":{"shape":"NextToken"}, 1505 "queryText":{"shape":"QueryText"} 1506 } 1507 }, 1508 "QueryAssistantResponse":{ 1509 "type":"structure", 1510 "required":["results"], 1511 "members":{ 1512 "nextToken":{"shape":"NextToken"}, 1513 "results":{"shape":"QueryResultsList"} 1514 } 1515 }, 1516 "QueryResultsList":{ 1517 "type":"list", 1518 "member":{"shape":"ResultData"} 1519 }, 1520 "QueryText":{ 1521 "type":"string", 1522 "sensitive":true 1523 }, 1524 "RecommendationData":{ 1525 "type":"structure", 1526 "required":[ 1527 "document", 1528 "recommendationId" 1529 ], 1530 "members":{ 1531 "document":{"shape":"Document"}, 1532 "recommendationId":{"shape":"String"}, 1533 "relevanceLevel":{"shape":"RelevanceLevel"}, 1534 "relevanceScore":{"shape":"RelevanceScore"} 1535 } 1536 }, 1537 "RecommendationIdList":{ 1538 "type":"list", 1539 "member":{"shape":"String"} 1540 }, 1541 "RecommendationList":{ 1542 "type":"list", 1543 "member":{"shape":"RecommendationData"} 1544 }, 1545 "RelevanceLevel":{ 1546 "type":"string", 1547 "enum":[ 1548 "HIGH", 1549 "MEDIUM", 1550 "LOW" 1551 ] 1552 }, 1553 "RelevanceScore":{ 1554 "type":"double", 1555 "min":0.0 1556 }, 1557 "RemoveKnowledgeBaseTemplateUriRequest":{ 1558 "type":"structure", 1559 "required":["knowledgeBaseId"], 1560 "members":{ 1561 "knowledgeBaseId":{ 1562 "shape":"UuidOrArn", 1563 "location":"uri", 1564 "locationName":"knowledgeBaseId" 1565 } 1566 } 1567 }, 1568 "RemoveKnowledgeBaseTemplateUriResponse":{ 1569 "type":"structure", 1570 "members":{ 1571 } 1572 }, 1573 "RenderingConfiguration":{ 1574 "type":"structure", 1575 "members":{ 1576 "templateUri":{"shape":"Uri"} 1577 } 1578 }, 1579 "ResourceNotFoundException":{ 1580 "type":"structure", 1581 "members":{ 1582 "message":{"shape":"String"}, 1583 "resourceName":{"shape":"String"} 1584 }, 1585 "error":{ 1586 "httpStatusCode":404, 1587 "senderFault":true 1588 }, 1589 "exception":true 1590 }, 1591 "ResultData":{ 1592 "type":"structure", 1593 "required":[ 1594 "document", 1595 "resultId" 1596 ], 1597 "members":{ 1598 "document":{"shape":"Document"}, 1599 "relevanceScore":{"shape":"RelevanceScore"}, 1600 "resultId":{"shape":"Uuid"} 1601 } 1602 }, 1603 "SearchContentRequest":{ 1604 "type":"structure", 1605 "required":[ 1606 "knowledgeBaseId", 1607 "searchExpression" 1608 ], 1609 "members":{ 1610 "knowledgeBaseId":{ 1611 "shape":"UuidOrArn", 1612 "location":"uri", 1613 "locationName":"knowledgeBaseId" 1614 }, 1615 "maxResults":{ 1616 "shape":"MaxResults", 1617 "location":"querystring", 1618 "locationName":"maxResults" 1619 }, 1620 "nextToken":{ 1621 "shape":"NextToken", 1622 "location":"querystring", 1623 "locationName":"nextToken" 1624 }, 1625 "searchExpression":{"shape":"SearchExpression"} 1626 } 1627 }, 1628 "SearchContentResponse":{ 1629 "type":"structure", 1630 "required":["contentSummaries"], 1631 "members":{ 1632 "contentSummaries":{"shape":"ContentSummaryList"}, 1633 "nextToken":{"shape":"NextToken"} 1634 } 1635 }, 1636 "SearchExpression":{ 1637 "type":"structure", 1638 "required":["filters"], 1639 "members":{ 1640 "filters":{"shape":"FilterList"} 1641 } 1642 }, 1643 "SearchSessionsRequest":{ 1644 "type":"structure", 1645 "required":[ 1646 "assistantId", 1647 "searchExpression" 1648 ], 1649 "members":{ 1650 "assistantId":{ 1651 "shape":"UuidOrArn", 1652 "location":"uri", 1653 "locationName":"assistantId" 1654 }, 1655 "maxResults":{ 1656 "shape":"MaxResults", 1657 "location":"querystring", 1658 "locationName":"maxResults" 1659 }, 1660 "nextToken":{ 1661 "shape":"NextToken", 1662 "location":"querystring", 1663 "locationName":"nextToken" 1664 }, 1665 "searchExpression":{"shape":"SearchExpression"} 1666 } 1667 }, 1668 "SearchSessionsResponse":{ 1669 "type":"structure", 1670 "required":["sessionSummaries"], 1671 "members":{ 1672 "nextToken":{"shape":"NextToken"}, 1673 "sessionSummaries":{"shape":"SessionSummaries"} 1674 } 1675 }, 1676 "ServerSideEncryptionConfiguration":{ 1677 "type":"structure", 1678 "members":{ 1679 "kmsKeyId":{"shape":"NonEmptyString"} 1680 } 1681 }, 1682 "ServiceQuotaExceededException":{ 1683 "type":"structure", 1684 "members":{ 1685 "message":{"shape":"String"} 1686 }, 1687 "error":{ 1688 "httpStatusCode":402, 1689 "senderFault":true 1690 }, 1691 "exception":true 1692 }, 1693 "SessionData":{ 1694 "type":"structure", 1695 "required":[ 1696 "name", 1697 "sessionArn", 1698 "sessionId" 1699 ], 1700 "members":{ 1701 "description":{"shape":"Description"}, 1702 "name":{"shape":"Name"}, 1703 "sessionArn":{"shape":"Arn"}, 1704 "sessionId":{"shape":"Uuid"}, 1705 "tags":{"shape":"Tags"} 1706 } 1707 }, 1708 "SessionSummaries":{ 1709 "type":"list", 1710 "member":{"shape":"SessionSummary"} 1711 }, 1712 "SessionSummary":{ 1713 "type":"structure", 1714 "required":[ 1715 "assistantArn", 1716 "assistantId", 1717 "sessionArn", 1718 "sessionId" 1719 ], 1720 "members":{ 1721 "assistantArn":{"shape":"Arn"}, 1722 "assistantId":{"shape":"Uuid"}, 1723 "sessionArn":{"shape":"Arn"}, 1724 "sessionId":{"shape":"Uuid"} 1725 } 1726 }, 1727 "SourceConfiguration":{ 1728 "type":"structure", 1729 "members":{ 1730 "appIntegrations":{"shape":"AppIntegrationsConfiguration"} 1731 }, 1732 "union":true 1733 }, 1734 "StartContentUploadRequest":{ 1735 "type":"structure", 1736 "required":[ 1737 "contentType", 1738 "knowledgeBaseId" 1739 ], 1740 "members":{ 1741 "contentType":{"shape":"ContentType"}, 1742 "knowledgeBaseId":{ 1743 "shape":"UuidOrArn", 1744 "location":"uri", 1745 "locationName":"knowledgeBaseId" 1746 } 1747 } 1748 }, 1749 "StartContentUploadResponse":{ 1750 "type":"structure", 1751 "required":[ 1752 "headersToInclude", 1753 "uploadId", 1754 "url", 1755 "urlExpiry" 1756 ], 1757 "members":{ 1758 "headersToInclude":{"shape":"Headers"}, 1759 "uploadId":{"shape":"NonEmptyString"}, 1760 "url":{"shape":"SyntheticStartContentUploadResponseUrl"}, 1761 "urlExpiry":{"shape":"SyntheticTimestamp_epoch_seconds"} 1762 } 1763 }, 1764 "String":{"type":"string"}, 1765 "SyntheticContentDataUrl":{ 1766 "type":"string", 1767 "max":4096, 1768 "min":1, 1769 "sensitive":true 1770 }, 1771 "SyntheticDocumentTextString":{ 1772 "type":"string", 1773 "sensitive":true 1774 }, 1775 "SyntheticStartContentUploadResponseUrl":{ 1776 "type":"string", 1777 "max":4096, 1778 "min":1, 1779 "sensitive":true 1780 }, 1781 "SyntheticTimestamp_epoch_seconds":{ 1782 "type":"timestamp", 1783 "timestampFormat":"unixTimestamp" 1784 }, 1785 "TagKey":{ 1786 "type":"string", 1787 "max":128, 1788 "min":1, 1789 "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" 1790 }, 1791 "TagKeyList":{ 1792 "type":"list", 1793 "member":{"shape":"TagKey"}, 1794 "max":50, 1795 "min":1 1796 }, 1797 "TagResourceRequest":{ 1798 "type":"structure", 1799 "required":[ 1800 "resourceArn", 1801 "tags" 1802 ], 1803 "members":{ 1804 "resourceArn":{ 1805 "shape":"Arn", 1806 "location":"uri", 1807 "locationName":"resourceArn" 1808 }, 1809 "tags":{"shape":"Tags"} 1810 } 1811 }, 1812 "TagResourceResponse":{ 1813 "type":"structure", 1814 "members":{ 1815 } 1816 }, 1817 "TagValue":{ 1818 "type":"string", 1819 "max":256, 1820 "min":1 1821 }, 1822 "Tags":{ 1823 "type":"map", 1824 "key":{"shape":"TagKey"}, 1825 "value":{"shape":"TagValue"} 1826 }, 1827 "TooManyTagsException":{ 1828 "type":"structure", 1829 "members":{ 1830 "message":{"shape":"String"}, 1831 "resourceName":{"shape":"String"} 1832 }, 1833 "error":{ 1834 "httpStatusCode":400, 1835 "senderFault":true 1836 }, 1837 "exception":true 1838 }, 1839 "UntagResourceRequest":{ 1840 "type":"structure", 1841 "required":[ 1842 "resourceArn", 1843 "tagKeys" 1844 ], 1845 "members":{ 1846 "resourceArn":{ 1847 "shape":"Arn", 1848 "location":"uri", 1849 "locationName":"resourceArn" 1850 }, 1851 "tagKeys":{ 1852 "shape":"TagKeyList", 1853 "location":"querystring", 1854 "locationName":"tagKeys" 1855 } 1856 } 1857 }, 1858 "UntagResourceResponse":{ 1859 "type":"structure", 1860 "members":{ 1861 } 1862 }, 1863 "UpdateContentRequest":{ 1864 "type":"structure", 1865 "required":[ 1866 "contentId", 1867 "knowledgeBaseId" 1868 ], 1869 "members":{ 1870 "contentId":{ 1871 "shape":"UuidOrArn", 1872 "location":"uri", 1873 "locationName":"contentId" 1874 }, 1875 "knowledgeBaseId":{ 1876 "shape":"UuidOrArn", 1877 "location":"uri", 1878 "locationName":"knowledgeBaseId" 1879 }, 1880 "metadata":{"shape":"ContentMetadata"}, 1881 "overrideLinkOutUri":{"shape":"Uri"}, 1882 "removeOverrideLinkOutUri":{"shape":"Boolean"}, 1883 "revisionId":{"shape":"NonEmptyString"}, 1884 "title":{"shape":"ContentTitle"}, 1885 "uploadId":{"shape":"NonEmptyString"} 1886 } 1887 }, 1888 "UpdateContentResponse":{ 1889 "type":"structure", 1890 "members":{ 1891 "content":{"shape":"ContentData"} 1892 } 1893 }, 1894 "UpdateKnowledgeBaseTemplateUriRequest":{ 1895 "type":"structure", 1896 "required":[ 1897 "knowledgeBaseId", 1898 "templateUri" 1899 ], 1900 "members":{ 1901 "knowledgeBaseId":{ 1902 "shape":"UuidOrArn", 1903 "location":"uri", 1904 "locationName":"knowledgeBaseId" 1905 }, 1906 "templateUri":{"shape":"Uri"} 1907 } 1908 }, 1909 "UpdateKnowledgeBaseTemplateUriResponse":{ 1910 "type":"structure", 1911 "members":{ 1912 "knowledgeBase":{"shape":"KnowledgeBaseData"} 1913 } 1914 }, 1915 "Uri":{ 1916 "type":"string", 1917 "max":4096, 1918 "min":1 1919 }, 1920 "Uuid":{ 1921 "type":"string", 1922 "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" 1923 }, 1924 "UuidOrArn":{ 1925 "type":"string", 1926 "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" 1927 }, 1928 "ValidationException":{ 1929 "type":"structure", 1930 "members":{ 1931 "message":{"shape":"String"} 1932 }, 1933 "error":{ 1934 "httpStatusCode":400, 1935 "senderFault":true 1936 }, 1937 "exception":true 1938 }, 1939 "WaitTimeSeconds":{ 1940 "type":"integer", 1941 "max":20, 1942 "min":0 1943 } 1944 } 1945 }