123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649 |
- {
- "version": "2.0",
- "metadata": {
- "apiVersion": "2020-10-19",
- "endpointPrefix": "wisdom",
- "jsonVersion": "1.1",
- "protocol": "rest-json",
- "serviceFullName": "Amazon Q Connect",
- "serviceId": "QConnect",
- "signatureVersion": "v4",
- "signingName": "wisdom",
- "uid": "qconnect-2020-10-19"
- },
- "operations": {
- "CreateAssistant": {
- "http": {
- "requestUri": "/assistants",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "name",
- "type"
- ],
- "members": {
- "clientToken": {
- "idempotencyToken": true
- },
- "description": {},
- "name": {},
- "serverSideEncryptionConfiguration": {
- "shape": "S5"
- },
- "tags": {
- "shape": "S7"
- },
- "type": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "assistant": {
- "shape": "Sc"
- }
- }
- },
- "idempotent": true
- },
- "CreateAssistantAssociation": {
- "http": {
- "requestUri": "/assistants/{assistantId}/associations",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "association",
- "associationType"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "association": {
- "type": "structure",
- "members": {
- "knowledgeBaseId": {}
- },
- "union": true
- },
- "associationType": {},
- "clientToken": {
- "idempotencyToken": true
- },
- "tags": {
- "shape": "S7"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "assistantAssociation": {
- "shape": "Sp"
- }
- }
- },
- "idempotent": true
- },
- "CreateContent": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "name",
- "uploadId"
- ],
- "members": {
- "clientToken": {
- "idempotencyToken": true
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "metadata": {
- "shape": "St"
- },
- "name": {},
- "overrideLinkOutUri": {},
- "tags": {
- "shape": "S7"
- },
- "title": {},
- "uploadId": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "content": {
- "shape": "Sy"
- }
- }
- },
- "idempotent": true
- },
- "CreateKnowledgeBase": {
- "http": {
- "requestUri": "/knowledgeBases",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseType",
- "name"
- ],
- "members": {
- "clientToken": {
- "idempotencyToken": true
- },
- "description": {},
- "knowledgeBaseType": {},
- "name": {},
- "renderingConfiguration": {
- "shape": "S15"
- },
- "serverSideEncryptionConfiguration": {
- "shape": "S5"
- },
- "sourceConfiguration": {
- "shape": "S16"
- },
- "tags": {
- "shape": "S7"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "knowledgeBase": {
- "shape": "S1a"
- }
- }
- },
- "idempotent": true
- },
- "CreateQuickResponse": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "content",
- "knowledgeBaseId",
- "name"
- ],
- "members": {
- "channels": {
- "shape": "S1d"
- },
- "clientToken": {
- "idempotencyToken": true
- },
- "content": {
- "shape": "S1f"
- },
- "contentType": {},
- "description": {},
- "groupingConfiguration": {
- "shape": "S1j"
- },
- "isActive": {
- "type": "boolean"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "language": {},
- "name": {},
- "shortcutKey": {},
- "tags": {
- "shape": "S7"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "quickResponse": {
- "shape": "S1s"
- }
- }
- },
- "idempotent": true
- },
- "CreateSession": {
- "http": {
- "requestUri": "/assistants/{assistantId}/sessions",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "name"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "clientToken": {
- "idempotencyToken": true
- },
- "description": {},
- "name": {},
- "tagFilter": {
- "shape": "S1x"
- },
- "tags": {
- "shape": "S7"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "session": {
- "shape": "S23"
- }
- }
- },
- "idempotent": true
- },
- "DeleteAssistant": {
- "http": {
- "method": "DELETE",
- "requestUri": "/assistants/{assistantId}",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteAssistantAssociation": {
- "http": {
- "method": "DELETE",
- "requestUri": "/assistants/{assistantId}/associations/{assistantAssociationId}",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantAssociationId",
- "assistantId"
- ],
- "members": {
- "assistantAssociationId": {
- "location": "uri",
- "locationName": "assistantAssociationId"
- },
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteContent": {
- "http": {
- "method": "DELETE",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "contentId",
- "knowledgeBaseId"
- ],
- "members": {
- "contentId": {
- "location": "uri",
- "locationName": "contentId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteImportJob": {
- "http": {
- "method": "DELETE",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "importJobId",
- "knowledgeBaseId"
- ],
- "members": {
- "importJobId": {
- "location": "uri",
- "locationName": "importJobId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteKnowledgeBase": {
- "http": {
- "method": "DELETE",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteQuickResponse": {
- "http": {
- "method": "DELETE",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "quickResponseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "quickResponseId": {
- "location": "uri",
- "locationName": "quickResponseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "GetAssistant": {
- "http": {
- "method": "GET",
- "requestUri": "/assistants/{assistantId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "assistant": {
- "shape": "Sc"
- }
- }
- }
- },
- "GetAssistantAssociation": {
- "http": {
- "method": "GET",
- "requestUri": "/assistants/{assistantId}/associations/{assistantAssociationId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantAssociationId",
- "assistantId"
- ],
- "members": {
- "assistantAssociationId": {
- "location": "uri",
- "locationName": "assistantAssociationId"
- },
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "assistantAssociation": {
- "shape": "Sp"
- }
- }
- }
- },
- "GetContent": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "contentId",
- "knowledgeBaseId"
- ],
- "members": {
- "contentId": {
- "location": "uri",
- "locationName": "contentId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "content": {
- "shape": "Sy"
- }
- }
- }
- },
- "GetContentSummary": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "contentId",
- "knowledgeBaseId"
- ],
- "members": {
- "contentId": {
- "location": "uri",
- "locationName": "contentId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "contentSummary": {
- "shape": "S2p"
- }
- }
- }
- },
- "GetImportJob": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "importJobId",
- "knowledgeBaseId"
- ],
- "members": {
- "importJobId": {
- "location": "uri",
- "locationName": "importJobId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "importJob": {
- "shape": "S2s"
- }
- }
- }
- },
- "GetKnowledgeBase": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "knowledgeBase": {
- "shape": "S1a"
- }
- }
- }
- },
- "GetQuickResponse": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "quickResponseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "quickResponseId": {
- "location": "uri",
- "locationName": "quickResponseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "quickResponse": {
- "shape": "S1s"
- }
- }
- }
- },
- "GetRecommendations": {
- "http": {
- "method": "GET",
- "requestUri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "sessionId"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "sessionId": {
- "location": "uri",
- "locationName": "sessionId"
- },
- "waitTimeSeconds": {
- "location": "querystring",
- "locationName": "waitTimeSeconds",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "recommendations"
- ],
- "members": {
- "recommendations": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "recommendationId"
- ],
- "members": {
- "data": {
- "shape": "S39"
- },
- "document": {
- "shape": "S3t"
- },
- "recommendationId": {},
- "relevanceLevel": {},
- "relevanceScore": {
- "type": "double"
- },
- "type": {}
- }
- }
- },
- "triggers": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "data",
- "id",
- "recommendationIds",
- "source",
- "type"
- ],
- "members": {
- "data": {
- "type": "structure",
- "members": {
- "query": {
- "type": "structure",
- "members": {
- "text": {
- "shape": "S40"
- }
- }
- }
- },
- "union": true
- },
- "id": {},
- "recommendationIds": {
- "shape": "S41"
- },
- "source": {},
- "type": {}
- }
- }
- }
- }
- },
- "deprecated": true,
- "deprecatedMessage": "GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications."
- },
- "GetSession": {
- "http": {
- "method": "GET",
- "requestUri": "/assistants/{assistantId}/sessions/{sessionId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "sessionId"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "sessionId": {
- "location": "uri",
- "locationName": "sessionId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "session": {
- "shape": "S23"
- }
- }
- }
- },
- "ListAssistantAssociations": {
- "http": {
- "method": "GET",
- "requestUri": "/assistants/{assistantId}/associations",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "assistantAssociationSummaries"
- ],
- "members": {
- "assistantAssociationSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "assistantArn",
- "assistantAssociationArn",
- "assistantAssociationId",
- "assistantId",
- "associationData",
- "associationType"
- ],
- "members": {
- "assistantArn": {},
- "assistantAssociationArn": {},
- "assistantAssociationId": {},
- "assistantId": {},
- "associationData": {
- "shape": "Sq"
- },
- "associationType": {},
- "tags": {
- "shape": "S7"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListAssistants": {
- "http": {
- "method": "GET",
- "requestUri": "/assistants",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "assistantSummaries"
- ],
- "members": {
- "assistantSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "assistantArn",
- "assistantId",
- "name",
- "status",
- "type"
- ],
- "members": {
- "assistantArn": {},
- "assistantId": {},
- "capabilityConfiguration": {
- "shape": "Sf"
- },
- "description": {},
- "integrationConfiguration": {
- "shape": "Sh"
- },
- "name": {},
- "serverSideEncryptionConfiguration": {
- "shape": "S5"
- },
- "status": {},
- "tags": {
- "shape": "S7"
- },
- "type": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListContents": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "contentSummaries"
- ],
- "members": {
- "contentSummaries": {
- "shape": "S4h"
- },
- "nextToken": {}
- }
- }
- },
- "ListImportJobs": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/importJobs",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "importJobSummaries"
- ],
- "members": {
- "importJobSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "createdTime",
- "importJobId",
- "importJobType",
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "lastModifiedTime",
- "status",
- "uploadId"
- ],
- "members": {
- "createdTime": {
- "shape": "S12"
- },
- "externalSourceConfiguration": {
- "shape": "S2t"
- },
- "importJobId": {},
- "importJobType": {},
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "lastModifiedTime": {
- "shape": "S12"
- },
- "metadata": {
- "shape": "St"
- },
- "status": {},
- "uploadId": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListKnowledgeBases": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "knowledgeBaseSummaries"
- ],
- "members": {
- "knowledgeBaseSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "knowledgeBaseType",
- "name",
- "status"
- ],
- "members": {
- "description": {},
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "knowledgeBaseType": {},
- "name": {},
- "renderingConfiguration": {
- "shape": "S15"
- },
- "serverSideEncryptionConfiguration": {
- "shape": "S5"
- },
- "sourceConfiguration": {
- "shape": "S16"
- },
- "status": {},
- "tags": {
- "shape": "S7"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListQuickResponses": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "quickResponseSummaries"
- ],
- "members": {
- "nextToken": {},
- "quickResponseSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "contentType",
- "createdTime",
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "lastModifiedTime",
- "name",
- "quickResponseArn",
- "quickResponseId",
- "status"
- ],
- "members": {
- "channels": {
- "shape": "S1d"
- },
- "contentType": {},
- "createdTime": {
- "shape": "S12"
- },
- "description": {},
- "isActive": {
- "type": "boolean"
- },
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "lastModifiedBy": {},
- "lastModifiedTime": {
- "shape": "S12"
- },
- "name": {},
- "quickResponseArn": {},
- "quickResponseId": {},
- "status": {},
- "tags": {
- "shape": "S7"
- }
- }
- }
- }
- }
- }
- },
- "ListTagsForResource": {
- "http": {
- "method": "GET",
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "tags": {
- "shape": "S7"
- }
- }
- }
- },
- "NotifyRecommendationsReceived": {
- "http": {
- "requestUri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "recommendationIds",
- "sessionId"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "recommendationIds": {
- "shape": "S41"
- },
- "sessionId": {
- "location": "uri",
- "locationName": "sessionId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "errors": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "message": {},
- "recommendationId": {}
- }
- }
- },
- "recommendationIds": {
- "shape": "S41"
- }
- }
- },
- "idempotent": true
- },
- "PutFeedback": {
- "http": {
- "method": "PUT",
- "requestUri": "/assistants/{assistantId}/feedback",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "contentFeedback",
- "targetId",
- "targetType"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "contentFeedback": {
- "shape": "S52"
- },
- "targetId": {},
- "targetType": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "assistantArn",
- "assistantId",
- "contentFeedback",
- "targetId",
- "targetType"
- ],
- "members": {
- "assistantArn": {},
- "assistantId": {},
- "contentFeedback": {
- "shape": "S52"
- },
- "targetId": {},
- "targetType": {}
- }
- },
- "idempotent": true
- },
- "QueryAssistant": {
- "http": {
- "requestUri": "/assistants/{assistantId}/query",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "queryText"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {},
- "queryCondition": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "single": {
- "type": "structure",
- "required": [
- "comparator",
- "field",
- "value"
- ],
- "members": {
- "comparator": {},
- "field": {},
- "value": {}
- }
- }
- },
- "union": true
- }
- },
- "queryText": {
- "shape": "S40"
- },
- "sessionId": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "results"
- ],
- "members": {
- "nextToken": {},
- "results": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "resultId"
- ],
- "members": {
- "data": {
- "shape": "S39"
- },
- "document": {
- "shape": "S3t"
- },
- "relevanceScore": {
- "type": "double"
- },
- "resultId": {},
- "type": {}
- }
- }
- }
- }
- },
- "deprecated": true,
- "deprecatedMessage": "QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications."
- },
- "RemoveKnowledgeBaseTemplateUri": {
- "http": {
- "method": "DELETE",
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/templateUri",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "SearchContent": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/search",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "searchExpression"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "searchExpression": {
- "shape": "S5k"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "contentSummaries"
- ],
- "members": {
- "contentSummaries": {
- "shape": "S4h"
- },
- "nextToken": {}
- }
- }
- },
- "SearchQuickResponses": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/search/quickResponses",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "searchExpression"
- ],
- "members": {
- "attributes": {
- "type": "map",
- "key": {},
- "value": {},
- "sensitive": true
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "searchExpression": {
- "type": "structure",
- "members": {
- "filters": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "name",
- "operator"
- ],
- "members": {
- "includeNoExistence": {
- "type": "boolean"
- },
- "name": {},
- "operator": {},
- "values": {
- "type": "list",
- "member": {}
- }
- }
- }
- },
- "orderOnField": {
- "type": "structure",
- "required": [
- "name"
- ],
- "members": {
- "name": {},
- "order": {}
- }
- },
- "queries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "name",
- "operator",
- "values"
- ],
- "members": {
- "allowFuzziness": {
- "type": "boolean"
- },
- "name": {},
- "operator": {},
- "priority": {},
- "values": {
- "type": "list",
- "member": {}
- }
- }
- }
- }
- }
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "results"
- ],
- "members": {
- "nextToken": {},
- "results": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "contentType",
- "contents",
- "createdTime",
- "isActive",
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "lastModifiedTime",
- "name",
- "quickResponseArn",
- "quickResponseId",
- "status"
- ],
- "members": {
- "attributesInterpolated": {
- "shape": "S6b"
- },
- "attributesNotInterpolated": {
- "shape": "S6b"
- },
- "channels": {
- "shape": "S1d"
- },
- "contentType": {},
- "contents": {
- "shape": "S1t"
- },
- "createdTime": {
- "shape": "S12"
- },
- "description": {},
- "groupingConfiguration": {
- "shape": "S1j"
- },
- "isActive": {
- "type": "boolean"
- },
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "language": {},
- "lastModifiedBy": {},
- "lastModifiedTime": {
- "shape": "S12"
- },
- "name": {},
- "quickResponseArn": {},
- "quickResponseId": {},
- "shortcutKey": {},
- "status": {},
- "tags": {
- "shape": "S7"
- }
- }
- }
- }
- }
- }
- },
- "SearchSessions": {
- "http": {
- "requestUri": "/assistants/{assistantId}/searchSessions",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "searchExpression"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "searchExpression": {
- "shape": "S5k"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "sessionSummaries"
- ],
- "members": {
- "nextToken": {},
- "sessionSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "assistantArn",
- "assistantId",
- "sessionArn",
- "sessionId"
- ],
- "members": {
- "assistantArn": {},
- "assistantId": {},
- "sessionArn": {},
- "sessionId": {}
- }
- }
- }
- }
- }
- },
- "StartContentUpload": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/upload",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "contentType",
- "knowledgeBaseId"
- ],
- "members": {
- "contentType": {},
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "presignedUrlTimeToLive": {
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "headersToInclude",
- "uploadId",
- "url",
- "urlExpiry"
- ],
- "members": {
- "headersToInclude": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "uploadId": {},
- "url": {
- "shape": "S11"
- },
- "urlExpiry": {
- "shape": "S12"
- }
- }
- }
- },
- "StartImportJob": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/importJobs",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "importJobType",
- "knowledgeBaseId",
- "uploadId"
- ],
- "members": {
- "clientToken": {
- "idempotencyToken": true
- },
- "externalSourceConfiguration": {
- "shape": "S2t"
- },
- "importJobType": {},
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "metadata": {
- "shape": "St"
- },
- "uploadId": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "importJob": {
- "shape": "S2s"
- }
- }
- },
- "idempotent": true
- },
- "TagResource": {
- "http": {
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn",
- "tags"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- },
- "tags": {
- "shape": "S7"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UntagResource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn",
- "tagKeys"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- },
- "tagKeys": {
- "location": "querystring",
- "locationName": "tagKeys",
- "type": "list",
- "member": {}
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateContent": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "contentId",
- "knowledgeBaseId"
- ],
- "members": {
- "contentId": {
- "location": "uri",
- "locationName": "contentId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "metadata": {
- "shape": "St"
- },
- "overrideLinkOutUri": {},
- "removeOverrideLinkOutUri": {
- "type": "boolean"
- },
- "revisionId": {},
- "title": {},
- "uploadId": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "content": {
- "shape": "Sy"
- }
- }
- }
- },
- "UpdateKnowledgeBaseTemplateUri": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/templateUri",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "templateUri"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "templateUri": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "knowledgeBase": {
- "shape": "S1a"
- }
- }
- }
- },
- "UpdateQuickResponse": {
- "http": {
- "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "quickResponseId"
- ],
- "members": {
- "channels": {
- "shape": "S1d"
- },
- "content": {
- "shape": "S1f"
- },
- "contentType": {},
- "description": {},
- "groupingConfiguration": {
- "shape": "S1j"
- },
- "isActive": {
- "type": "boolean"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "language": {},
- "name": {},
- "quickResponseId": {
- "location": "uri",
- "locationName": "quickResponseId"
- },
- "removeDescription": {
- "type": "boolean"
- },
- "removeGroupingConfiguration": {
- "type": "boolean"
- },
- "removeShortcutKey": {
- "type": "boolean"
- },
- "shortcutKey": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "quickResponse": {
- "shape": "S1s"
- }
- }
- }
- },
- "UpdateSession": {
- "http": {
- "requestUri": "/assistants/{assistantId}/sessions/{sessionId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "assistantId",
- "sessionId"
- ],
- "members": {
- "assistantId": {
- "location": "uri",
- "locationName": "assistantId"
- },
- "description": {},
- "sessionId": {
- "location": "uri",
- "locationName": "sessionId"
- },
- "tagFilter": {
- "shape": "S1x"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "session": {
- "shape": "S23"
- }
- }
- }
- }
- },
- "shapes": {
- "S5": {
- "type": "structure",
- "members": {
- "kmsKeyId": {}
- }
- },
- "S7": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "Sc": {
- "type": "structure",
- "required": [
- "assistantArn",
- "assistantId",
- "name",
- "status",
- "type"
- ],
- "members": {
- "assistantArn": {},
- "assistantId": {},
- "capabilityConfiguration": {
- "shape": "Sf"
- },
- "description": {},
- "integrationConfiguration": {
- "shape": "Sh"
- },
- "name": {},
- "serverSideEncryptionConfiguration": {
- "shape": "S5"
- },
- "status": {},
- "tags": {
- "shape": "S7"
- },
- "type": {}
- }
- },
- "Sf": {
- "type": "structure",
- "members": {
- "type": {}
- }
- },
- "Sh": {
- "type": "structure",
- "members": {
- "topicIntegrationArn": {}
- }
- },
- "Sp": {
- "type": "structure",
- "required": [
- "assistantArn",
- "assistantAssociationArn",
- "assistantAssociationId",
- "assistantId",
- "associationData",
- "associationType"
- ],
- "members": {
- "assistantArn": {},
- "assistantAssociationArn": {},
- "assistantAssociationId": {},
- "assistantId": {},
- "associationData": {
- "shape": "Sq"
- },
- "associationType": {},
- "tags": {
- "shape": "S7"
- }
- }
- },
- "Sq": {
- "type": "structure",
- "members": {
- "knowledgeBaseAssociation": {
- "type": "structure",
- "members": {
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {}
- }
- }
- },
- "union": true
- },
- "St": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "Sy": {
- "type": "structure",
- "required": [
- "contentArn",
- "contentId",
- "contentType",
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "metadata",
- "name",
- "revisionId",
- "status",
- "title",
- "url",
- "urlExpiry"
- ],
- "members": {
- "contentArn": {},
- "contentId": {},
- "contentType": {},
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "linkOutUri": {},
- "metadata": {
- "shape": "St"
- },
- "name": {},
- "revisionId": {},
- "status": {},
- "tags": {
- "shape": "S7"
- },
- "title": {},
- "url": {
- "shape": "S11"
- },
- "urlExpiry": {
- "shape": "S12"
- }
- }
- },
- "S11": {
- "type": "string",
- "sensitive": true
- },
- "S12": {
- "type": "timestamp",
- "timestampFormat": "unixTimestamp"
- },
- "S15": {
- "type": "structure",
- "members": {
- "templateUri": {}
- }
- },
- "S16": {
- "type": "structure",
- "members": {
- "appIntegrations": {
- "type": "structure",
- "required": [
- "appIntegrationArn"
- ],
- "members": {
- "appIntegrationArn": {},
- "objectFields": {
- "type": "list",
- "member": {}
- }
- }
- }
- },
- "union": true
- },
- "S1a": {
- "type": "structure",
- "required": [
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "knowledgeBaseType",
- "name",
- "status"
- ],
- "members": {
- "description": {},
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "knowledgeBaseType": {},
- "lastContentModificationTime": {
- "shape": "S12"
- },
- "name": {},
- "renderingConfiguration": {
- "shape": "S15"
- },
- "serverSideEncryptionConfiguration": {
- "shape": "S5"
- },
- "sourceConfiguration": {
- "shape": "S16"
- },
- "status": {},
- "tags": {
- "shape": "S7"
- }
- }
- },
- "S1d": {
- "type": "list",
- "member": {
- "type": "string",
- "sensitive": true
- }
- },
- "S1f": {
- "type": "structure",
- "members": {
- "content": {
- "shape": "S1g"
- }
- },
- "union": true
- },
- "S1g": {
- "type": "string",
- "sensitive": true
- },
- "S1j": {
- "type": "structure",
- "members": {
- "criteria": {
- "type": "string",
- "sensitive": true
- },
- "values": {
- "type": "list",
- "member": {
- "type": "string",
- "sensitive": true
- }
- }
- }
- },
- "S1s": {
- "type": "structure",
- "required": [
- "contentType",
- "createdTime",
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "lastModifiedTime",
- "name",
- "quickResponseArn",
- "quickResponseId",
- "status"
- ],
- "members": {
- "channels": {
- "shape": "S1d"
- },
- "contentType": {},
- "contents": {
- "shape": "S1t"
- },
- "createdTime": {
- "shape": "S12"
- },
- "description": {},
- "groupingConfiguration": {
- "shape": "S1j"
- },
- "isActive": {
- "type": "boolean"
- },
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "language": {},
- "lastModifiedBy": {},
- "lastModifiedTime": {
- "shape": "S12"
- },
- "name": {},
- "quickResponseArn": {},
- "quickResponseId": {},
- "shortcutKey": {},
- "status": {},
- "tags": {
- "shape": "S7"
- }
- }
- },
- "S1t": {
- "type": "structure",
- "members": {
- "markdown": {
- "shape": "S1u"
- },
- "plainText": {
- "shape": "S1u"
- }
- }
- },
- "S1u": {
- "type": "structure",
- "members": {
- "content": {
- "shape": "S1g"
- }
- },
- "union": true
- },
- "S1x": {
- "type": "structure",
- "members": {
- "andConditions": {
- "shape": "S1y"
- },
- "orConditions": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "andConditions": {
- "shape": "S1y"
- },
- "tagCondition": {
- "shape": "S1z"
- }
- },
- "union": true
- }
- },
- "tagCondition": {
- "shape": "S1z"
- }
- },
- "union": true
- },
- "S1y": {
- "type": "list",
- "member": {
- "shape": "S1z"
- }
- },
- "S1z": {
- "type": "structure",
- "required": [
- "key"
- ],
- "members": {
- "key": {},
- "value": {}
- }
- },
- "S23": {
- "type": "structure",
- "required": [
- "name",
- "sessionArn",
- "sessionId"
- ],
- "members": {
- "description": {},
- "integrationConfiguration": {
- "type": "structure",
- "members": {
- "topicIntegrationArn": {}
- }
- },
- "name": {},
- "sessionArn": {},
- "sessionId": {},
- "tagFilter": {
- "shape": "S1x"
- },
- "tags": {
- "shape": "S7"
- }
- }
- },
- "S2p": {
- "type": "structure",
- "required": [
- "contentArn",
- "contentId",
- "contentType",
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "metadata",
- "name",
- "revisionId",
- "status",
- "title"
- ],
- "members": {
- "contentArn": {},
- "contentId": {},
- "contentType": {},
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "metadata": {
- "shape": "St"
- },
- "name": {},
- "revisionId": {},
- "status": {},
- "tags": {
- "shape": "S7"
- },
- "title": {}
- }
- },
- "S2s": {
- "type": "structure",
- "required": [
- "createdTime",
- "importJobId",
- "importJobType",
- "knowledgeBaseArn",
- "knowledgeBaseId",
- "lastModifiedTime",
- "status",
- "uploadId",
- "url",
- "urlExpiry"
- ],
- "members": {
- "createdTime": {
- "shape": "S12"
- },
- "externalSourceConfiguration": {
- "shape": "S2t"
- },
- "failedRecordReport": {
- "shape": "S11"
- },
- "importJobId": {},
- "importJobType": {},
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {},
- "lastModifiedTime": {
- "shape": "S12"
- },
- "metadata": {
- "shape": "St"
- },
- "status": {},
- "uploadId": {},
- "url": {
- "shape": "S11"
- },
- "urlExpiry": {
- "shape": "S12"
- }
- }
- },
- "S2t": {
- "type": "structure",
- "required": [
- "configuration",
- "source"
- ],
- "members": {
- "configuration": {
- "type": "structure",
- "members": {
- "connectConfiguration": {
- "type": "structure",
- "members": {
- "instanceId": {}
- }
- }
- },
- "union": true
- },
- "source": {}
- }
- },
- "S39": {
- "type": "structure",
- "required": [
- "details",
- "reference"
- ],
- "members": {
- "details": {
- "type": "structure",
- "members": {
- "contentData": {
- "type": "structure",
- "required": [
- "rankingData",
- "textData"
- ],
- "members": {
- "rankingData": {
- "shape": "S3c"
- },
- "textData": {
- "shape": "S3f"
- }
- }
- },
- "generativeData": {
- "type": "structure",
- "required": [
- "completion",
- "rankingData",
- "references"
- ],
- "members": {
- "completion": {
- "shape": "S3k"
- },
- "rankingData": {
- "shape": "S3c"
- },
- "references": {
- "type": "list",
- "member": {
- "shape": "S39"
- }
- }
- }
- },
- "sourceContentData": {
- "type": "structure",
- "required": [
- "id",
- "rankingData",
- "textData",
- "type"
- ],
- "members": {
- "id": {},
- "rankingData": {
- "shape": "S3c"
- },
- "textData": {
- "shape": "S3f"
- },
- "type": {}
- }
- }
- },
- "union": true
- },
- "reference": {
- "type": "structure",
- "members": {
- "contentReference": {
- "shape": "S3q"
- },
- "generativeReference": {
- "type": "structure",
- "members": {
- "generationId": {},
- "modelId": {}
- }
- }
- },
- "union": true
- }
- }
- },
- "S3c": {
- "type": "structure",
- "members": {
- "relevanceLevel": {},
- "relevanceScore": {
- "type": "double"
- }
- }
- },
- "S3f": {
- "type": "structure",
- "members": {
- "excerpt": {
- "shape": "S3g"
- },
- "title": {
- "shape": "S3g"
- }
- }
- },
- "S3g": {
- "type": "structure",
- "members": {
- "highlights": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "beginOffsetInclusive": {
- "type": "integer"
- },
- "endOffsetExclusive": {
- "type": "integer"
- }
- }
- }
- },
- "text": {
- "shape": "S3k"
- }
- }
- },
- "S3k": {
- "type": "string",
- "sensitive": true
- },
- "S3q": {
- "type": "structure",
- "members": {
- "contentArn": {},
- "contentId": {},
- "knowledgeBaseArn": {},
- "knowledgeBaseId": {}
- }
- },
- "S3t": {
- "type": "structure",
- "required": [
- "contentReference"
- ],
- "members": {
- "contentReference": {
- "shape": "S3q"
- },
- "excerpt": {
- "shape": "S3g"
- },
- "title": {
- "shape": "S3g"
- }
- }
- },
- "S40": {
- "type": "string",
- "sensitive": true
- },
- "S41": {
- "type": "list",
- "member": {}
- },
- "S4h": {
- "type": "list",
- "member": {
- "shape": "S2p"
- }
- },
- "S52": {
- "type": "structure",
- "members": {
- "generativeContentFeedbackData": {
- "type": "structure",
- "required": [
- "relevance"
- ],
- "members": {
- "relevance": {}
- }
- }
- },
- "union": true
- },
- "S5k": {
- "type": "structure",
- "required": [
- "filters"
- ],
- "members": {
- "filters": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "field",
- "operator",
- "value"
- ],
- "members": {
- "field": {},
- "operator": {},
- "value": {}
- }
- }
- }
- }
- },
- "S6b": {
- "type": "list",
- "member": {},
- "sensitive": true
- }
- }
- }
|