bedrockagent.d.ts 109 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class BedrockAgent extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: BedrockAgent.Types.ClientConfiguration)
  13. config: Config & BedrockAgent.Types.ClientConfiguration;
  14. /**
  15. * Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
  16. */
  17. associateAgentKnowledgeBase(params: BedrockAgent.Types.AssociateAgentKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse, AWSError>;
  18. /**
  19. * Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
  20. */
  21. associateAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse, AWSError>;
  22. /**
  23. * Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
  24. */
  25. createAgent(params: BedrockAgent.Types.CreateAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentResponse) => void): Request<BedrockAgent.Types.CreateAgentResponse, AWSError>;
  26. /**
  27. * Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
  28. */
  29. createAgent(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentResponse) => void): Request<BedrockAgent.Types.CreateAgentResponse, AWSError>;
  30. /**
  31. * Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
  32. */
  33. createAgentActionGroup(params: BedrockAgent.Types.CreateAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.CreateAgentActionGroupResponse, AWSError>;
  34. /**
  35. * Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
  36. */
  37. createAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.CreateAgentActionGroupResponse, AWSError>;
  38. /**
  39. * Creates an alias of an agent that can be used to deploy the agent.
  40. */
  41. createAgentAlias(params: BedrockAgent.Types.CreateAgentAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentAliasResponse) => void): Request<BedrockAgent.Types.CreateAgentAliasResponse, AWSError>;
  42. /**
  43. * Creates an alias of an agent that can be used to deploy the agent.
  44. */
  45. createAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentAliasResponse) => void): Request<BedrockAgent.Types.CreateAgentAliasResponse, AWSError>;
  46. /**
  47. * Sets up a data source to be added to a knowledge base. You can't change the chunkingConfiguration after you create the data source.
  48. */
  49. createDataSource(params: BedrockAgent.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateDataSourceResponse) => void): Request<BedrockAgent.Types.CreateDataSourceResponse, AWSError>;
  50. /**
  51. * Sets up a data source to be added to a knowledge base. You can't change the chunkingConfiguration after you create the data source.
  52. */
  53. createDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.CreateDataSourceResponse) => void): Request<BedrockAgent.Types.CreateDataSourceResponse, AWSError>;
  54. /**
  55. * Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion. If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base. Provide the name and an optional description. Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field. Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object. Provide the configuration for your vector store in the storageConfiguration object. For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service. For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora. For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone. For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
  56. */
  57. createKnowledgeBase(params: BedrockAgent.Types.CreateKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.CreateKnowledgeBaseResponse, AWSError>;
  58. /**
  59. * Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion. If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base. Provide the name and an optional description. Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field. Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object. Provide the configuration for your vector store in the storageConfiguration object. For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service. For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora. For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone. For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
  60. */
  61. createKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.CreateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.CreateKnowledgeBaseResponse, AWSError>;
  62. /**
  63. * Deletes an agent.
  64. */
  65. deleteAgent(params: BedrockAgent.Types.DeleteAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentResponse) => void): Request<BedrockAgent.Types.DeleteAgentResponse, AWSError>;
  66. /**
  67. * Deletes an agent.
  68. */
  69. deleteAgent(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentResponse) => void): Request<BedrockAgent.Types.DeleteAgentResponse, AWSError>;
  70. /**
  71. * Deletes an action group in an agent.
  72. */
  73. deleteAgentActionGroup(params: BedrockAgent.Types.DeleteAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentActionGroupResponse) => void): Request<BedrockAgent.Types.DeleteAgentActionGroupResponse, AWSError>;
  74. /**
  75. * Deletes an action group in an agent.
  76. */
  77. deleteAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentActionGroupResponse) => void): Request<BedrockAgent.Types.DeleteAgentActionGroupResponse, AWSError>;
  78. /**
  79. * Deletes an alias of an agent.
  80. */
  81. deleteAgentAlias(params: BedrockAgent.Types.DeleteAgentAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentAliasResponse) => void): Request<BedrockAgent.Types.DeleteAgentAliasResponse, AWSError>;
  82. /**
  83. * Deletes an alias of an agent.
  84. */
  85. deleteAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentAliasResponse) => void): Request<BedrockAgent.Types.DeleteAgentAliasResponse, AWSError>;
  86. /**
  87. * Deletes a version of an agent.
  88. */
  89. deleteAgentVersion(params: BedrockAgent.Types.DeleteAgentVersionRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentVersionResponse) => void): Request<BedrockAgent.Types.DeleteAgentVersionResponse, AWSError>;
  90. /**
  91. * Deletes a version of an agent.
  92. */
  93. deleteAgentVersion(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentVersionResponse) => void): Request<BedrockAgent.Types.DeleteAgentVersionResponse, AWSError>;
  94. /**
  95. * Deletes a data source from a knowledge base.
  96. */
  97. deleteDataSource(params: BedrockAgent.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteDataSourceResponse) => void): Request<BedrockAgent.Types.DeleteDataSourceResponse, AWSError>;
  98. /**
  99. * Deletes a data source from a knowledge base.
  100. */
  101. deleteDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteDataSourceResponse) => void): Request<BedrockAgent.Types.DeleteDataSourceResponse, AWSError>;
  102. /**
  103. * Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
  104. */
  105. deleteKnowledgeBase(params: BedrockAgent.Types.DeleteKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DeleteKnowledgeBaseResponse, AWSError>;
  106. /**
  107. * Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
  108. */
  109. deleteKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DeleteKnowledgeBaseResponse, AWSError>;
  110. /**
  111. * Disassociates a knowledge base from an agent.
  112. */
  113. disassociateAgentKnowledgeBase(params: BedrockAgent.Types.DisassociateAgentKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DisassociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DisassociateAgentKnowledgeBaseResponse, AWSError>;
  114. /**
  115. * Disassociates a knowledge base from an agent.
  116. */
  117. disassociateAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.DisassociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DisassociateAgentKnowledgeBaseResponse, AWSError>;
  118. /**
  119. * Gets information about an agent.
  120. */
  121. getAgent(params: BedrockAgent.Types.GetAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentResponse) => void): Request<BedrockAgent.Types.GetAgentResponse, AWSError>;
  122. /**
  123. * Gets information about an agent.
  124. */
  125. getAgent(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentResponse) => void): Request<BedrockAgent.Types.GetAgentResponse, AWSError>;
  126. /**
  127. * Gets information about an action group for an agent.
  128. */
  129. getAgentActionGroup(params: BedrockAgent.Types.GetAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentActionGroupResponse) => void): Request<BedrockAgent.Types.GetAgentActionGroupResponse, AWSError>;
  130. /**
  131. * Gets information about an action group for an agent.
  132. */
  133. getAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentActionGroupResponse) => void): Request<BedrockAgent.Types.GetAgentActionGroupResponse, AWSError>;
  134. /**
  135. * Gets information about an alias of an agent.
  136. */
  137. getAgentAlias(params: BedrockAgent.Types.GetAgentAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentAliasResponse) => void): Request<BedrockAgent.Types.GetAgentAliasResponse, AWSError>;
  138. /**
  139. * Gets information about an alias of an agent.
  140. */
  141. getAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentAliasResponse) => void): Request<BedrockAgent.Types.GetAgentAliasResponse, AWSError>;
  142. /**
  143. * Gets information about a knowledge base associated with an agent.
  144. */
  145. getAgentKnowledgeBase(params: BedrockAgent.Types.GetAgentKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetAgentKnowledgeBaseResponse, AWSError>;
  146. /**
  147. * Gets information about a knowledge base associated with an agent.
  148. */
  149. getAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetAgentKnowledgeBaseResponse, AWSError>;
  150. /**
  151. * Gets details about a version of an agent.
  152. */
  153. getAgentVersion(params: BedrockAgent.Types.GetAgentVersionRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentVersionResponse) => void): Request<BedrockAgent.Types.GetAgentVersionResponse, AWSError>;
  154. /**
  155. * Gets details about a version of an agent.
  156. */
  157. getAgentVersion(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentVersionResponse) => void): Request<BedrockAgent.Types.GetAgentVersionResponse, AWSError>;
  158. /**
  159. * Gets information about a data source.
  160. */
  161. getDataSource(params: BedrockAgent.Types.GetDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetDataSourceResponse) => void): Request<BedrockAgent.Types.GetDataSourceResponse, AWSError>;
  162. /**
  163. * Gets information about a data source.
  164. */
  165. getDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.GetDataSourceResponse) => void): Request<BedrockAgent.Types.GetDataSourceResponse, AWSError>;
  166. /**
  167. * Gets information about a ingestion job, in which a data source is added to a knowledge base.
  168. */
  169. getIngestionJob(params: BedrockAgent.Types.GetIngestionJobRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetIngestionJobResponse) => void): Request<BedrockAgent.Types.GetIngestionJobResponse, AWSError>;
  170. /**
  171. * Gets information about a ingestion job, in which a data source is added to a knowledge base.
  172. */
  173. getIngestionJob(callback?: (err: AWSError, data: BedrockAgent.Types.GetIngestionJobResponse) => void): Request<BedrockAgent.Types.GetIngestionJobResponse, AWSError>;
  174. /**
  175. * Gets information about a knoweldge base.
  176. */
  177. getKnowledgeBase(params: BedrockAgent.Types.GetKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetKnowledgeBaseResponse, AWSError>;
  178. /**
  179. * Gets information about a knoweldge base.
  180. */
  181. getKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.GetKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetKnowledgeBaseResponse, AWSError>;
  182. /**
  183. * Lists the action groups for an agent and information about each one.
  184. */
  185. listAgentActionGroups(params: BedrockAgent.Types.ListAgentActionGroupsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentActionGroupsResponse) => void): Request<BedrockAgent.Types.ListAgentActionGroupsResponse, AWSError>;
  186. /**
  187. * Lists the action groups for an agent and information about each one.
  188. */
  189. listAgentActionGroups(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentActionGroupsResponse) => void): Request<BedrockAgent.Types.ListAgentActionGroupsResponse, AWSError>;
  190. /**
  191. * Lists the aliases of an agent and information about each one.
  192. */
  193. listAgentAliases(params: BedrockAgent.Types.ListAgentAliasesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentAliasesResponse) => void): Request<BedrockAgent.Types.ListAgentAliasesResponse, AWSError>;
  194. /**
  195. * Lists the aliases of an agent and information about each one.
  196. */
  197. listAgentAliases(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentAliasesResponse) => void): Request<BedrockAgent.Types.ListAgentAliasesResponse, AWSError>;
  198. /**
  199. * Lists knowledge bases associated with an agent and information about each one.
  200. */
  201. listAgentKnowledgeBases(params: BedrockAgent.Types.ListAgentKnowledgeBasesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListAgentKnowledgeBasesResponse, AWSError>;
  202. /**
  203. * Lists knowledge bases associated with an agent and information about each one.
  204. */
  205. listAgentKnowledgeBases(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListAgentKnowledgeBasesResponse, AWSError>;
  206. /**
  207. * Lists the versions of an agent and information about each version.
  208. */
  209. listAgentVersions(params: BedrockAgent.Types.ListAgentVersionsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentVersionsResponse) => void): Request<BedrockAgent.Types.ListAgentVersionsResponse, AWSError>;
  210. /**
  211. * Lists the versions of an agent and information about each version.
  212. */
  213. listAgentVersions(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentVersionsResponse) => void): Request<BedrockAgent.Types.ListAgentVersionsResponse, AWSError>;
  214. /**
  215. * Lists the agents belonging to an account and information about each agent.
  216. */
  217. listAgents(params: BedrockAgent.Types.ListAgentsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentsResponse) => void): Request<BedrockAgent.Types.ListAgentsResponse, AWSError>;
  218. /**
  219. * Lists the agents belonging to an account and information about each agent.
  220. */
  221. listAgents(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentsResponse) => void): Request<BedrockAgent.Types.ListAgentsResponse, AWSError>;
  222. /**
  223. * Lists the data sources in a knowledge base and information about each one.
  224. */
  225. listDataSources(params: BedrockAgent.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListDataSourcesResponse) => void): Request<BedrockAgent.Types.ListDataSourcesResponse, AWSError>;
  226. /**
  227. * Lists the data sources in a knowledge base and information about each one.
  228. */
  229. listDataSources(callback?: (err: AWSError, data: BedrockAgent.Types.ListDataSourcesResponse) => void): Request<BedrockAgent.Types.ListDataSourcesResponse, AWSError>;
  230. /**
  231. * Lists the ingestion jobs for a data source and information about each of them.
  232. */
  233. listIngestionJobs(params: BedrockAgent.Types.ListIngestionJobsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListIngestionJobsResponse) => void): Request<BedrockAgent.Types.ListIngestionJobsResponse, AWSError>;
  234. /**
  235. * Lists the ingestion jobs for a data source and information about each of them.
  236. */
  237. listIngestionJobs(callback?: (err: AWSError, data: BedrockAgent.Types.ListIngestionJobsResponse) => void): Request<BedrockAgent.Types.ListIngestionJobsResponse, AWSError>;
  238. /**
  239. * Lists the knowledge bases in an account and information about each of them.
  240. */
  241. listKnowledgeBases(params: BedrockAgent.Types.ListKnowledgeBasesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListKnowledgeBasesResponse, AWSError>;
  242. /**
  243. * Lists the knowledge bases in an account and information about each of them.
  244. */
  245. listKnowledgeBases(callback?: (err: AWSError, data: BedrockAgent.Types.ListKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListKnowledgeBasesResponse, AWSError>;
  246. /**
  247. * List all the tags for the resource you specify.
  248. */
  249. listTagsForResource(params: BedrockAgent.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListTagsForResourceResponse) => void): Request<BedrockAgent.Types.ListTagsForResourceResponse, AWSError>;
  250. /**
  251. * List all the tags for the resource you specify.
  252. */
  253. listTagsForResource(callback?: (err: AWSError, data: BedrockAgent.Types.ListTagsForResourceResponse) => void): Request<BedrockAgent.Types.ListTagsForResourceResponse, AWSError>;
  254. /**
  255. * Creates a DRAFT version of the agent that can be used for internal testing.
  256. */
  257. prepareAgent(params: BedrockAgent.Types.PrepareAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.PrepareAgentResponse) => void): Request<BedrockAgent.Types.PrepareAgentResponse, AWSError>;
  258. /**
  259. * Creates a DRAFT version of the agent that can be used for internal testing.
  260. */
  261. prepareAgent(callback?: (err: AWSError, data: BedrockAgent.Types.PrepareAgentResponse) => void): Request<BedrockAgent.Types.PrepareAgentResponse, AWSError>;
  262. /**
  263. * Begins an ingestion job, in which a data source is added to a knowledge base.
  264. */
  265. startIngestionJob(params: BedrockAgent.Types.StartIngestionJobRequest, callback?: (err: AWSError, data: BedrockAgent.Types.StartIngestionJobResponse) => void): Request<BedrockAgent.Types.StartIngestionJobResponse, AWSError>;
  266. /**
  267. * Begins an ingestion job, in which a data source is added to a knowledge base.
  268. */
  269. startIngestionJob(callback?: (err: AWSError, data: BedrockAgent.Types.StartIngestionJobResponse) => void): Request<BedrockAgent.Types.StartIngestionJobResponse, AWSError>;
  270. /**
  271. * Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
  272. */
  273. tagResource(params: BedrockAgent.Types.TagResourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.TagResourceResponse) => void): Request<BedrockAgent.Types.TagResourceResponse, AWSError>;
  274. /**
  275. * Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
  276. */
  277. tagResource(callback?: (err: AWSError, data: BedrockAgent.Types.TagResourceResponse) => void): Request<BedrockAgent.Types.TagResourceResponse, AWSError>;
  278. /**
  279. * Remove tags from a resource.
  280. */
  281. untagResource(params: BedrockAgent.Types.UntagResourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UntagResourceResponse) => void): Request<BedrockAgent.Types.UntagResourceResponse, AWSError>;
  282. /**
  283. * Remove tags from a resource.
  284. */
  285. untagResource(callback?: (err: AWSError, data: BedrockAgent.Types.UntagResourceResponse) => void): Request<BedrockAgent.Types.UntagResourceResponse, AWSError>;
  286. /**
  287. * Updates the configuration of an agent.
  288. */
  289. updateAgent(params: BedrockAgent.Types.UpdateAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentResponse) => void): Request<BedrockAgent.Types.UpdateAgentResponse, AWSError>;
  290. /**
  291. * Updates the configuration of an agent.
  292. */
  293. updateAgent(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentResponse) => void): Request<BedrockAgent.Types.UpdateAgentResponse, AWSError>;
  294. /**
  295. * Updates the configuration for an action group for an agent.
  296. */
  297. updateAgentActionGroup(params: BedrockAgent.Types.UpdateAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.UpdateAgentActionGroupResponse, AWSError>;
  298. /**
  299. * Updates the configuration for an action group for an agent.
  300. */
  301. updateAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.UpdateAgentActionGroupResponse, AWSError>;
  302. /**
  303. * Updates configurations for an alias of an agent.
  304. */
  305. updateAgentAlias(params: BedrockAgent.Types.UpdateAgentAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentAliasResponse) => void): Request<BedrockAgent.Types.UpdateAgentAliasResponse, AWSError>;
  306. /**
  307. * Updates configurations for an alias of an agent.
  308. */
  309. updateAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentAliasResponse) => void): Request<BedrockAgent.Types.UpdateAgentAliasResponse, AWSError>;
  310. /**
  311. * Updates the configuration for a knowledge base that has been associated with an agent.
  312. */
  313. updateAgentKnowledgeBase(params: BedrockAgent.Types.UpdateAgentKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse, AWSError>;
  314. /**
  315. * Updates the configuration for a knowledge base that has been associated with an agent.
  316. */
  317. updateAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse, AWSError>;
  318. /**
  319. * Updates configurations for a data source. You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
  320. */
  321. updateDataSource(params: BedrockAgent.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateDataSourceResponse) => void): Request<BedrockAgent.Types.UpdateDataSourceResponse, AWSError>;
  322. /**
  323. * Updates configurations for a data source. You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
  324. */
  325. updateDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateDataSourceResponse) => void): Request<BedrockAgent.Types.UpdateDataSourceResponse, AWSError>;
  326. /**
  327. * Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same. You can change the following fields: name description roleArn You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
  328. */
  329. updateKnowledgeBase(params: BedrockAgent.Types.UpdateKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateKnowledgeBaseResponse, AWSError>;
  330. /**
  331. * Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same. You can change the following fields: name description roleArn You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
  332. */
  333. updateKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateKnowledgeBaseResponse, AWSError>;
  334. }
  335. declare namespace BedrockAgent {
  336. export interface APISchema {
  337. /**
  338. * The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
  339. */
  340. payload?: Payload;
  341. /**
  342. * Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
  343. */
  344. s3?: S3Identifier;
  345. }
  346. export interface ActionGroupExecutor {
  347. /**
  348. * To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
  349. */
  350. customControl?: CustomControlMethod;
  351. /**
  352. * The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
  353. */
  354. lambda?: LambdaArn;
  355. }
  356. export type ActionGroupSignature = "AMAZON.UserInput"|string;
  357. export type ActionGroupState = "ENABLED"|"DISABLED"|string;
  358. export type ActionGroupSummaries = ActionGroupSummary[];
  359. export interface ActionGroupSummary {
  360. /**
  361. * The unique identifier of the action group.
  362. */
  363. actionGroupId: Id;
  364. /**
  365. * The name of the action group.
  366. */
  367. actionGroupName: Name;
  368. /**
  369. * Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
  370. */
  371. actionGroupState: ActionGroupState;
  372. /**
  373. * The description of the action group.
  374. */
  375. description?: Description;
  376. /**
  377. * The time at which the action group was last updated.
  378. */
  379. updatedAt: DateTimestamp;
  380. }
  381. export interface Agent {
  382. /**
  383. * The Amazon Resource Name (ARN) of the agent.
  384. */
  385. agentArn: AgentArn;
  386. /**
  387. * The unique identifier of the agent.
  388. */
  389. agentId: Id;
  390. /**
  391. * The name of the agent.
  392. */
  393. agentName: Name;
  394. /**
  395. * The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
  396. */
  397. agentResourceRoleArn: AgentRoleArn;
  398. /**
  399. * The status of the agent and whether it is ready for use. The following statuses are possible: CREATING – The agent is being created. PREPARING – The agent is being prepared. PREPARED – The agent is prepared and ready to be invoked. NOT_PREPARED – The agent has been created but not yet prepared. FAILED – The agent API operation failed. UPDATING – The agent is being updated. DELETING – The agent is being deleted.
  400. */
  401. agentStatus: AgentStatus;
  402. /**
  403. * The version of the agent.
  404. */
  405. agentVersion: DraftVersion;
  406. /**
  407. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  408. */
  409. clientToken?: ClientToken;
  410. /**
  411. * The time at which the agent was created.
  412. */
  413. createdAt: DateTimestamp;
  414. /**
  415. * The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
  416. */
  417. customerEncryptionKeyArn?: KmsKeyArn;
  418. /**
  419. * The description of the agent.
  420. */
  421. description?: Description;
  422. /**
  423. * Contains reasons that the agent-related API that you invoked failed.
  424. */
  425. failureReasons?: FailureReasons;
  426. /**
  427. * The foundation model used for orchestration by the agent.
  428. */
  429. foundationModel?: ModelIdentifier;
  430. /**
  431. * The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
  432. */
  433. idleSessionTTLInSeconds: SessionTTL;
  434. /**
  435. * Instructions that tell the agent what it should do and how it should interact with users.
  436. */
  437. instruction?: Instruction;
  438. /**
  439. * The time at which the agent was last prepared.
  440. */
  441. preparedAt?: DateTimestamp;
  442. /**
  443. * Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
  444. */
  445. promptOverrideConfiguration?: PromptOverrideConfiguration;
  446. /**
  447. * Contains recommended actions to take for the agent-related API that you invoked to succeed.
  448. */
  449. recommendedActions?: RecommendedActions;
  450. /**
  451. * The time at which the agent was last updated.
  452. */
  453. updatedAt: DateTimestamp;
  454. }
  455. export interface AgentActionGroup {
  456. /**
  457. * The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
  458. */
  459. actionGroupExecutor?: ActionGroupExecutor;
  460. /**
  461. * The unique identifier of the action group.
  462. */
  463. actionGroupId: Id;
  464. /**
  465. * The name of the action group.
  466. */
  467. actionGroupName: Name;
  468. /**
  469. * Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
  470. */
  471. actionGroupState: ActionGroupState;
  472. /**
  473. * The unique identifier of the agent to which the action group belongs.
  474. */
  475. agentId: Id;
  476. /**
  477. * The version of the agent to which the action group belongs.
  478. */
  479. agentVersion: Version;
  480. /**
  481. * Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
  482. */
  483. apiSchema?: APISchema;
  484. /**
  485. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  486. */
  487. clientToken?: ClientToken;
  488. /**
  489. * The time at which the action group was created.
  490. */
  491. createdAt: DateTimestamp;
  492. /**
  493. * The description of the action group.
  494. */
  495. description?: Description;
  496. /**
  497. * Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
  498. */
  499. functionSchema?: FunctionSchema;
  500. /**
  501. * If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group. During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
  502. */
  503. parentActionSignature?: ActionGroupSignature;
  504. /**
  505. * The time at which the action group was last updated.
  506. */
  507. updatedAt: DateTimestamp;
  508. }
  509. export interface AgentAlias {
  510. /**
  511. * The Amazon Resource Name (ARN) of the alias of the agent.
  512. */
  513. agentAliasArn: AgentAliasArn;
  514. /**
  515. * Contains details about the history of the alias.
  516. */
  517. agentAliasHistoryEvents?: AgentAliasHistoryEvents;
  518. /**
  519. * The unique identifier of the alias of the agent.
  520. */
  521. agentAliasId: AgentAliasId;
  522. /**
  523. * The name of the alias of the agent.
  524. */
  525. agentAliasName: Name;
  526. /**
  527. * The status of the alias of the agent and whether it is ready for use. The following statuses are possible: CREATING – The agent alias is being created. PREPARED – The agent alias is finished being created or updated and is ready to be invoked. FAILED – The agent alias API operation failed. UPDATING – The agent alias is being updated. DELETING – The agent alias is being deleted.
  528. */
  529. agentAliasStatus: AgentAliasStatus;
  530. /**
  531. * The unique identifier of the agent.
  532. */
  533. agentId: Id;
  534. /**
  535. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  536. */
  537. clientToken?: ClientToken;
  538. /**
  539. * The time at which the alias of the agent was created.
  540. */
  541. createdAt: DateTimestamp;
  542. /**
  543. * The description of the alias of the agent.
  544. */
  545. description?: Description;
  546. /**
  547. * Information on the failure of Provisioned Throughput assigned to an agent alias.
  548. */
  549. failureReasons?: FailureReasons;
  550. /**
  551. * Contains details about the routing configuration of the alias.
  552. */
  553. routingConfiguration: AgentAliasRoutingConfiguration;
  554. /**
  555. * The time at which the alias was last updated.
  556. */
  557. updatedAt: DateTimestamp;
  558. }
  559. export type AgentAliasArn = string;
  560. export interface AgentAliasHistoryEvent {
  561. /**
  562. * The date that the alias stopped being associated to the version in the routingConfiguration object
  563. */
  564. endDate?: DateTimestamp;
  565. /**
  566. * Contains details about the version of the agent with which the alias is associated.
  567. */
  568. routingConfiguration?: AgentAliasRoutingConfiguration;
  569. /**
  570. * The date that the alias began being associated to the version in the routingConfiguration object.
  571. */
  572. startDate?: DateTimestamp;
  573. }
  574. export type AgentAliasHistoryEvents = AgentAliasHistoryEvent[];
  575. export type AgentAliasId = string;
  576. export type AgentAliasRoutingConfiguration = AgentAliasRoutingConfigurationListItem[];
  577. export interface AgentAliasRoutingConfigurationListItem {
  578. /**
  579. * The version of the agent with which the alias is associated.
  580. */
  581. agentVersion?: Version;
  582. /**
  583. * Information on the Provisioned Throughput assigned to an agent alias.
  584. */
  585. provisionedThroughput?: ProvisionedModelIdentifier;
  586. }
  587. export type AgentAliasStatus = "CREATING"|"PREPARED"|"FAILED"|"UPDATING"|"DELETING"|string;
  588. export type AgentAliasSummaries = AgentAliasSummary[];
  589. export interface AgentAliasSummary {
  590. /**
  591. * Contains details about
  592. */
  593. agentAliasId: AgentAliasId;
  594. /**
  595. * The name of the alias.
  596. */
  597. agentAliasName: Name;
  598. /**
  599. * The status of the alias.
  600. */
  601. agentAliasStatus: AgentAliasStatus;
  602. /**
  603. * The time at which the alias of the agent was created.
  604. */
  605. createdAt: DateTimestamp;
  606. /**
  607. * The description of the alias.
  608. */
  609. description?: Description;
  610. /**
  611. * Contains details about the version of the agent with which the alias is associated.
  612. */
  613. routingConfiguration?: AgentAliasRoutingConfiguration;
  614. /**
  615. * The time at which the alias was last updated.
  616. */
  617. updatedAt: DateTimestamp;
  618. }
  619. export type AgentArn = string;
  620. export interface AgentKnowledgeBase {
  621. /**
  622. * The unique identifier of the agent with which the knowledge base is associated.
  623. */
  624. agentId: Id;
  625. /**
  626. * The version of the agent with which the knowledge base is associated.
  627. */
  628. agentVersion: Version;
  629. /**
  630. * The time at which the association between the agent and the knowledge base was created.
  631. */
  632. createdAt: DateTimestamp;
  633. /**
  634. * The description of the association between the agent and the knowledge base.
  635. */
  636. description: Description;
  637. /**
  638. * The unique identifier of the association between the agent and the knowledge base.
  639. */
  640. knowledgeBaseId: Id;
  641. /**
  642. * Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
  643. */
  644. knowledgeBaseState: KnowledgeBaseState;
  645. /**
  646. * The time at which the association between the agent and the knowledge base was last updated.
  647. */
  648. updatedAt: DateTimestamp;
  649. }
  650. export type AgentKnowledgeBaseSummaries = AgentKnowledgeBaseSummary[];
  651. export interface AgentKnowledgeBaseSummary {
  652. /**
  653. * The description of the knowledge base associated with an agent.
  654. */
  655. description?: Description;
  656. /**
  657. * The unique identifier of the knowledge base associated with an agent.
  658. */
  659. knowledgeBaseId: Id;
  660. /**
  661. * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
  662. */
  663. knowledgeBaseState: KnowledgeBaseState;
  664. /**
  665. * The time at which the knowledge base associated with an agent was last updated.
  666. */
  667. updatedAt: DateTimestamp;
  668. }
  669. export type AgentRoleArn = string;
  670. export type AgentStatus = "CREATING"|"PREPARING"|"PREPARED"|"NOT_PREPARED"|"DELETING"|"FAILED"|"VERSIONING"|"UPDATING"|string;
  671. export type AgentSummaries = AgentSummary[];
  672. export interface AgentSummary {
  673. /**
  674. * The unique identifier of the agent.
  675. */
  676. agentId: Id;
  677. /**
  678. * The name of the agent.
  679. */
  680. agentName: Name;
  681. /**
  682. * The status of the agent.
  683. */
  684. agentStatus: AgentStatus;
  685. /**
  686. * The description of the agent.
  687. */
  688. description?: Description;
  689. /**
  690. * The latest version of the agent.
  691. */
  692. latestAgentVersion?: Version;
  693. /**
  694. * The time at which the agent was last updated.
  695. */
  696. updatedAt: DateTimestamp;
  697. }
  698. export interface AgentVersion {
  699. /**
  700. * The Amazon Resource Name (ARN) of the agent that the version belongs to.
  701. */
  702. agentArn: AgentArn;
  703. /**
  704. * The unique identifier of the agent that the version belongs to.
  705. */
  706. agentId: Id;
  707. /**
  708. * The name of the agent that the version belongs to.
  709. */
  710. agentName: Name;
  711. /**
  712. * The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
  713. */
  714. agentResourceRoleArn: AgentRoleArn;
  715. /**
  716. * The status of the agent that the version belongs to.
  717. */
  718. agentStatus: AgentStatus;
  719. /**
  720. * The time at which the version was created.
  721. */
  722. createdAt: DateTimestamp;
  723. /**
  724. * The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
  725. */
  726. customerEncryptionKeyArn?: KmsKeyArn;
  727. /**
  728. * The description of the version.
  729. */
  730. description?: Description;
  731. /**
  732. * A list of reasons that the API operation on the version failed.
  733. */
  734. failureReasons?: FailureReasons;
  735. /**
  736. * The foundation model that the version invokes.
  737. */
  738. foundationModel?: ModelIdentifier;
  739. /**
  740. * The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
  741. */
  742. idleSessionTTLInSeconds: SessionTTL;
  743. /**
  744. * The instructions provided to the agent.
  745. */
  746. instruction?: Instruction;
  747. /**
  748. * Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
  749. */
  750. promptOverrideConfiguration?: PromptOverrideConfiguration;
  751. /**
  752. * A list of recommended actions to take for the failed API operation on the version to succeed.
  753. */
  754. recommendedActions?: RecommendedActions;
  755. /**
  756. * The time at which the version was last updated.
  757. */
  758. updatedAt: DateTimestamp;
  759. /**
  760. * The version number.
  761. */
  762. version: NumericalVersion;
  763. }
  764. export type AgentVersionSummaries = AgentVersionSummary[];
  765. export interface AgentVersionSummary {
  766. /**
  767. * The name of the agent to which the version belongs.
  768. */
  769. agentName: Name;
  770. /**
  771. * The status of the agent to which the version belongs.
  772. */
  773. agentStatus: AgentStatus;
  774. /**
  775. * The version of the agent.
  776. */
  777. agentVersion: Version;
  778. /**
  779. * The time at which the version was created.
  780. */
  781. createdAt: DateTimestamp;
  782. /**
  783. * The description of the version of the agent.
  784. */
  785. description?: Description;
  786. /**
  787. * The time at which the version was last updated.
  788. */
  789. updatedAt: DateTimestamp;
  790. }
  791. export interface AssociateAgentKnowledgeBaseRequest {
  792. /**
  793. * The unique identifier of the agent with which you want to associate the knowledge base.
  794. */
  795. agentId: Id;
  796. /**
  797. * The version of the agent with which you want to associate the knowledge base.
  798. */
  799. agentVersion: DraftVersion;
  800. /**
  801. * A description of what the agent should use the knowledge base for.
  802. */
  803. description: Description;
  804. /**
  805. * The unique identifier of the knowledge base to associate with the agent.
  806. */
  807. knowledgeBaseId: Id;
  808. /**
  809. * Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
  810. */
  811. knowledgeBaseState?: KnowledgeBaseState;
  812. }
  813. export interface AssociateAgentKnowledgeBaseResponse {
  814. /**
  815. * Contains details about the knowledge base that has been associated with the agent.
  816. */
  817. agentKnowledgeBase: AgentKnowledgeBase;
  818. }
  819. export type BasePromptTemplate = string;
  820. export type BedrockEmbeddingModelArn = string;
  821. export type Boolean = boolean;
  822. export type BucketOwnerAccountId = string;
  823. export interface ChunkingConfiguration {
  824. /**
  825. * Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration. NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
  826. */
  827. chunkingStrategy: ChunkingStrategy;
  828. /**
  829. * Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
  830. */
  831. fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration;
  832. }
  833. export type ChunkingStrategy = "FIXED_SIZE"|"NONE"|string;
  834. export type ClientToken = string;
  835. export type ColumnName = string;
  836. export interface CreateAgentActionGroupRequest {
  837. /**
  838. * The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
  839. */
  840. actionGroupExecutor?: ActionGroupExecutor;
  841. /**
  842. * The name to give the action group.
  843. */
  844. actionGroupName: Name;
  845. /**
  846. * Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
  847. */
  848. actionGroupState?: ActionGroupState;
  849. /**
  850. * The unique identifier of the agent for which to create the action group.
  851. */
  852. agentId: Id;
  853. /**
  854. * The version of the agent for which to create the action group.
  855. */
  856. agentVersion: DraftVersion;
  857. /**
  858. * Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
  859. */
  860. apiSchema?: APISchema;
  861. /**
  862. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  863. */
  864. clientToken?: ClientToken;
  865. /**
  866. * A description of the action group.
  867. */
  868. description?: Description;
  869. /**
  870. * Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
  871. */
  872. functionSchema?: FunctionSchema;
  873. /**
  874. * To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
  875. */
  876. parentActionGroupSignature?: ActionGroupSignature;
  877. }
  878. export interface CreateAgentActionGroupResponse {
  879. /**
  880. * Contains details about the action group that was created.
  881. */
  882. agentActionGroup: AgentActionGroup;
  883. }
  884. export interface CreateAgentAliasRequest {
  885. /**
  886. * The name of the alias.
  887. */
  888. agentAliasName: Name;
  889. /**
  890. * The unique identifier of the agent.
  891. */
  892. agentId: Id;
  893. /**
  894. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  895. */
  896. clientToken?: ClientToken;
  897. /**
  898. * A description of the alias of the agent.
  899. */
  900. description?: Description;
  901. /**
  902. * Contains details about the routing configuration of the alias.
  903. */
  904. routingConfiguration?: AgentAliasRoutingConfiguration;
  905. /**
  906. * Any tags that you want to attach to the alias of the agent.
  907. */
  908. tags?: TagsMap;
  909. }
  910. export interface CreateAgentAliasResponse {
  911. /**
  912. * Contains details about the alias that was created.
  913. */
  914. agentAlias: AgentAlias;
  915. }
  916. export interface CreateAgentRequest {
  917. /**
  918. * A name for the agent that you create.
  919. */
  920. agentName: Name;
  921. /**
  922. * The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
  923. */
  924. agentResourceRoleArn?: AgentRoleArn;
  925. /**
  926. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  927. */
  928. clientToken?: ClientToken;
  929. /**
  930. * The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
  931. */
  932. customerEncryptionKeyArn?: KmsKeyArn;
  933. /**
  934. * A description of the agent.
  935. */
  936. description?: Description;
  937. /**
  938. * The foundation model to be used for orchestration by the agent you create.
  939. */
  940. foundationModel?: ModelIdentifier;
  941. /**
  942. * The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
  943. */
  944. idleSessionTTLInSeconds?: SessionTTL;
  945. /**
  946. * Instructions that tell the agent what it should do and how it should interact with users.
  947. */
  948. instruction?: Instruction;
  949. /**
  950. * Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
  951. */
  952. promptOverrideConfiguration?: PromptOverrideConfiguration;
  953. /**
  954. * Any tags that you want to attach to the agent.
  955. */
  956. tags?: TagsMap;
  957. }
  958. export interface CreateAgentResponse {
  959. /**
  960. * Contains details about the agent created.
  961. */
  962. agent: Agent;
  963. }
  964. export interface CreateDataSourceRequest {
  965. /**
  966. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  967. */
  968. clientToken?: ClientToken;
  969. /**
  970. * The data deletion policy assigned to the data source.
  971. */
  972. dataDeletionPolicy?: DataDeletionPolicy;
  973. /**
  974. * Contains metadata about where the data source is stored.
  975. */
  976. dataSourceConfiguration: DataSourceConfiguration;
  977. /**
  978. * A description of the data source.
  979. */
  980. description?: Description;
  981. /**
  982. * The unique identifier of the knowledge base to which to add the data source.
  983. */
  984. knowledgeBaseId: Id;
  985. /**
  986. * The name of the data source.
  987. */
  988. name: Name;
  989. /**
  990. * Contains details about the server-side encryption for the data source.
  991. */
  992. serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
  993. /**
  994. * Contains details about how to ingest the documents in the data source.
  995. */
  996. vectorIngestionConfiguration?: VectorIngestionConfiguration;
  997. }
  998. export interface CreateDataSourceResponse {
  999. /**
  1000. * Contains details about the data source.
  1001. */
  1002. dataSource: DataSource;
  1003. }
  1004. export interface CreateKnowledgeBaseRequest {
  1005. /**
  1006. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  1007. */
  1008. clientToken?: ClientToken;
  1009. /**
  1010. * A description of the knowledge base.
  1011. */
  1012. description?: Description;
  1013. /**
  1014. * Contains details about the embeddings model used for the knowledge base.
  1015. */
  1016. knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
  1017. /**
  1018. * A name for the knowledge base.
  1019. */
  1020. name: Name;
  1021. /**
  1022. * The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
  1023. */
  1024. roleArn: KnowledgeBaseRoleArn;
  1025. /**
  1026. * Contains details about the configuration of the vector database used for the knowledge base.
  1027. */
  1028. storageConfiguration: StorageConfiguration;
  1029. /**
  1030. * Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
  1031. */
  1032. tags?: TagsMap;
  1033. }
  1034. export interface CreateKnowledgeBaseResponse {
  1035. /**
  1036. * Contains details about the knowledge base.
  1037. */
  1038. knowledgeBase: KnowledgeBase;
  1039. }
  1040. export type CreationMode = "DEFAULT"|"OVERRIDDEN"|string;
  1041. export type CustomControlMethod = "RETURN_CONTROL"|string;
  1042. export type DataDeletionPolicy = "RETAIN"|"DELETE"|string;
  1043. export interface DataSource {
  1044. /**
  1045. * The time at which the data source was created.
  1046. */
  1047. createdAt: DateTimestamp;
  1048. /**
  1049. * The data deletion policy for a data source.
  1050. */
  1051. dataDeletionPolicy?: DataDeletionPolicy;
  1052. /**
  1053. * Contains details about how the data source is stored.
  1054. */
  1055. dataSourceConfiguration: DataSourceConfiguration;
  1056. /**
  1057. * The unique identifier of the data source.
  1058. */
  1059. dataSourceId: Id;
  1060. /**
  1061. * The description of the data source.
  1062. */
  1063. description?: Description;
  1064. /**
  1065. * The detailed reasons on the failure to delete a data source.
  1066. */
  1067. failureReasons?: FailureReasons;
  1068. /**
  1069. * The unique identifier of the knowledge base to which the data source belongs.
  1070. */
  1071. knowledgeBaseId: Id;
  1072. /**
  1073. * The name of the data source.
  1074. */
  1075. name: Name;
  1076. /**
  1077. * Contains details about the configuration of the server-side encryption.
  1078. */
  1079. serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
  1080. /**
  1081. * The status of the data source. The following statuses are possible: Available – The data source has been created and is ready for ingestion into the knowledge base. Deleting – The data source is being deleted.
  1082. */
  1083. status: DataSourceStatus;
  1084. /**
  1085. * The time at which the data source was last updated.
  1086. */
  1087. updatedAt: DateTimestamp;
  1088. /**
  1089. * Contains details about how to ingest the documents in the data source.
  1090. */
  1091. vectorIngestionConfiguration?: VectorIngestionConfiguration;
  1092. }
  1093. export interface DataSourceConfiguration {
  1094. /**
  1095. * Contains details about the configuration of the S3 object containing the data source.
  1096. */
  1097. s3Configuration?: S3DataSourceConfiguration;
  1098. /**
  1099. * The type of storage for the data source.
  1100. */
  1101. type: DataSourceType;
  1102. }
  1103. export type DataSourceStatus = "AVAILABLE"|"DELETING"|"DELETE_UNSUCCESSFUL"|string;
  1104. export type DataSourceSummaries = DataSourceSummary[];
  1105. export interface DataSourceSummary {
  1106. /**
  1107. * The unique identifier of the data source.
  1108. */
  1109. dataSourceId: Id;
  1110. /**
  1111. * The description of the data source.
  1112. */
  1113. description?: Description;
  1114. /**
  1115. * The unique identifier of the knowledge base to which the data source belongs.
  1116. */
  1117. knowledgeBaseId: Id;
  1118. /**
  1119. * The name of the data source.
  1120. */
  1121. name: Name;
  1122. /**
  1123. * The status of the data source.
  1124. */
  1125. status: DataSourceStatus;
  1126. /**
  1127. * The time at which the data source was last updated.
  1128. */
  1129. updatedAt: DateTimestamp;
  1130. }
  1131. export type DataSourceType = "S3"|string;
  1132. export type DateTimestamp = Date;
  1133. export interface DeleteAgentActionGroupRequest {
  1134. /**
  1135. * The unique identifier of the action group to delete.
  1136. */
  1137. actionGroupId: Id;
  1138. /**
  1139. * The unique identifier of the agent that the action group belongs to.
  1140. */
  1141. agentId: Id;
  1142. /**
  1143. * The version of the agent that the action group belongs to.
  1144. */
  1145. agentVersion: DraftVersion;
  1146. /**
  1147. * By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
  1148. */
  1149. skipResourceInUseCheck?: Boolean;
  1150. }
  1151. export interface DeleteAgentActionGroupResponse {
  1152. }
  1153. export interface DeleteAgentAliasRequest {
  1154. /**
  1155. * The unique identifier of the alias to delete.
  1156. */
  1157. agentAliasId: AgentAliasId;
  1158. /**
  1159. * The unique identifier of the agent that the alias belongs to.
  1160. */
  1161. agentId: Id;
  1162. }
  1163. export interface DeleteAgentAliasResponse {
  1164. /**
  1165. * The unique identifier of the alias that was deleted.
  1166. */
  1167. agentAliasId: AgentAliasId;
  1168. /**
  1169. * The status of the alias.
  1170. */
  1171. agentAliasStatus: AgentAliasStatus;
  1172. /**
  1173. * The unique identifier of the agent that the alias belongs to.
  1174. */
  1175. agentId: Id;
  1176. }
  1177. export interface DeleteAgentRequest {
  1178. /**
  1179. * The unique identifier of the agent to delete.
  1180. */
  1181. agentId: Id;
  1182. /**
  1183. * By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
  1184. */
  1185. skipResourceInUseCheck?: Boolean;
  1186. }
  1187. export interface DeleteAgentResponse {
  1188. /**
  1189. * The unique identifier of the agent that was deleted.
  1190. */
  1191. agentId: Id;
  1192. /**
  1193. * The status of the agent.
  1194. */
  1195. agentStatus: AgentStatus;
  1196. }
  1197. export interface DeleteAgentVersionRequest {
  1198. /**
  1199. * The unique identifier of the agent that the version belongs to.
  1200. */
  1201. agentId: Id;
  1202. /**
  1203. * The version of the agent to delete.
  1204. */
  1205. agentVersion: NumericalVersion;
  1206. /**
  1207. * By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
  1208. */
  1209. skipResourceInUseCheck?: Boolean;
  1210. }
  1211. export interface DeleteAgentVersionResponse {
  1212. /**
  1213. * The unique identifier of the agent that the version belongs to.
  1214. */
  1215. agentId: Id;
  1216. /**
  1217. * The status of the agent version.
  1218. */
  1219. agentStatus: AgentStatus;
  1220. /**
  1221. * The version that was deleted.
  1222. */
  1223. agentVersion: NumericalVersion;
  1224. }
  1225. export interface DeleteDataSourceRequest {
  1226. /**
  1227. * The unique identifier of the data source to delete.
  1228. */
  1229. dataSourceId: Id;
  1230. /**
  1231. * The unique identifier of the knowledge base from which to delete the data source.
  1232. */
  1233. knowledgeBaseId: Id;
  1234. }
  1235. export interface DeleteDataSourceResponse {
  1236. /**
  1237. * The unique identifier of the data source that was deleted.
  1238. */
  1239. dataSourceId: Id;
  1240. /**
  1241. * The unique identifier of the knowledge base to which the data source that was deleted belonged.
  1242. */
  1243. knowledgeBaseId: Id;
  1244. /**
  1245. * The status of the data source.
  1246. */
  1247. status: DataSourceStatus;
  1248. }
  1249. export interface DeleteKnowledgeBaseRequest {
  1250. /**
  1251. * The unique identifier of the knowledge base to delete.
  1252. */
  1253. knowledgeBaseId: Id;
  1254. }
  1255. export interface DeleteKnowledgeBaseResponse {
  1256. /**
  1257. * The unique identifier of the knowledge base that was deleted.
  1258. */
  1259. knowledgeBaseId: Id;
  1260. /**
  1261. * The status of the knowledge base and whether it has been successfully deleted.
  1262. */
  1263. status: KnowledgeBaseStatus;
  1264. }
  1265. export type Description = string;
  1266. export interface DisassociateAgentKnowledgeBaseRequest {
  1267. /**
  1268. * The unique identifier of the agent from which to disassociate the knowledge base.
  1269. */
  1270. agentId: Id;
  1271. /**
  1272. * The version of the agent from which to disassociate the knowledge base.
  1273. */
  1274. agentVersion: DraftVersion;
  1275. /**
  1276. * The unique identifier of the knowledge base to disassociate.
  1277. */
  1278. knowledgeBaseId: Id;
  1279. }
  1280. export interface DisassociateAgentKnowledgeBaseResponse {
  1281. }
  1282. export type DraftVersion = string;
  1283. export type FailureReason = string;
  1284. export type FailureReasons = FailureReason[];
  1285. export type FieldName = string;
  1286. export interface FixedSizeChunkingConfiguration {
  1287. /**
  1288. * The maximum number of tokens to include in a chunk.
  1289. */
  1290. maxTokens: FixedSizeChunkingConfigurationMaxTokensInteger;
  1291. /**
  1292. * The percentage of overlap between adjacent chunks of a data source.
  1293. */
  1294. overlapPercentage: FixedSizeChunkingConfigurationOverlapPercentageInteger;
  1295. }
  1296. export type FixedSizeChunkingConfigurationMaxTokensInteger = number;
  1297. export type FixedSizeChunkingConfigurationOverlapPercentageInteger = number;
  1298. export interface Function {
  1299. /**
  1300. * A description of the function and its purpose.
  1301. */
  1302. description?: FunctionDescription;
  1303. /**
  1304. * A name for the function.
  1305. */
  1306. name: Name;
  1307. /**
  1308. * The parameters that the agent elicits from the user to fulfill the function.
  1309. */
  1310. parameters?: ParameterMap;
  1311. }
  1312. export type FunctionDescription = string;
  1313. export interface FunctionSchema {
  1314. /**
  1315. * A list of functions that each define an action in the action group.
  1316. */
  1317. functions?: Functions;
  1318. }
  1319. export type Functions = Function[];
  1320. export interface GetAgentActionGroupRequest {
  1321. /**
  1322. * The unique identifier of the action group for which to get information.
  1323. */
  1324. actionGroupId: Id;
  1325. /**
  1326. * The unique identifier of the agent that the action group belongs to.
  1327. */
  1328. agentId: Id;
  1329. /**
  1330. * The version of the agent that the action group belongs to.
  1331. */
  1332. agentVersion: Version;
  1333. }
  1334. export interface GetAgentActionGroupResponse {
  1335. /**
  1336. * Contains details about the action group.
  1337. */
  1338. agentActionGroup: AgentActionGroup;
  1339. }
  1340. export interface GetAgentAliasRequest {
  1341. /**
  1342. * The unique identifier of the alias for which to get information.
  1343. */
  1344. agentAliasId: AgentAliasId;
  1345. /**
  1346. * The unique identifier of the agent to which the alias to get information belongs.
  1347. */
  1348. agentId: Id;
  1349. }
  1350. export interface GetAgentAliasResponse {
  1351. /**
  1352. * Contains information about the alias.
  1353. */
  1354. agentAlias: AgentAlias;
  1355. }
  1356. export interface GetAgentKnowledgeBaseRequest {
  1357. /**
  1358. * The unique identifier of the agent with which the knowledge base is associated.
  1359. */
  1360. agentId: Id;
  1361. /**
  1362. * The version of the agent with which the knowledge base is associated.
  1363. */
  1364. agentVersion: Version;
  1365. /**
  1366. * The unique identifier of the knowledge base associated with the agent.
  1367. */
  1368. knowledgeBaseId: Id;
  1369. }
  1370. export interface GetAgentKnowledgeBaseResponse {
  1371. /**
  1372. * Contains details about a knowledge base attached to an agent.
  1373. */
  1374. agentKnowledgeBase: AgentKnowledgeBase;
  1375. }
  1376. export interface GetAgentRequest {
  1377. /**
  1378. * The unique identifier of the agent.
  1379. */
  1380. agentId: Id;
  1381. }
  1382. export interface GetAgentResponse {
  1383. /**
  1384. * Contains details about the agent.
  1385. */
  1386. agent: Agent;
  1387. }
  1388. export interface GetAgentVersionRequest {
  1389. /**
  1390. * The unique identifier of the agent.
  1391. */
  1392. agentId: Id;
  1393. /**
  1394. * The version of the agent.
  1395. */
  1396. agentVersion: NumericalVersion;
  1397. }
  1398. export interface GetAgentVersionResponse {
  1399. /**
  1400. * Contains details about the version of the agent.
  1401. */
  1402. agentVersion: AgentVersion;
  1403. }
  1404. export interface GetDataSourceRequest {
  1405. /**
  1406. * The unique identifier of the data source.
  1407. */
  1408. dataSourceId: Id;
  1409. /**
  1410. * The unique identifier of the knowledge base that the data source was added to.
  1411. */
  1412. knowledgeBaseId: Id;
  1413. }
  1414. export interface GetDataSourceResponse {
  1415. /**
  1416. * Contains details about the data source.
  1417. */
  1418. dataSource: DataSource;
  1419. }
  1420. export interface GetIngestionJobRequest {
  1421. /**
  1422. * The unique identifier of the data source in the ingestion job.
  1423. */
  1424. dataSourceId: Id;
  1425. /**
  1426. * The unique identifier of the ingestion job.
  1427. */
  1428. ingestionJobId: Id;
  1429. /**
  1430. * The unique identifier of the knowledge base for which the ingestion job applies.
  1431. */
  1432. knowledgeBaseId: Id;
  1433. }
  1434. export interface GetIngestionJobResponse {
  1435. /**
  1436. * Contains details about the ingestion job.
  1437. */
  1438. ingestionJob: IngestionJob;
  1439. }
  1440. export interface GetKnowledgeBaseRequest {
  1441. /**
  1442. * The unique identifier of the knowledge base for which to get information.
  1443. */
  1444. knowledgeBaseId: Id;
  1445. }
  1446. export interface GetKnowledgeBaseResponse {
  1447. /**
  1448. * Contains details about the knowledge base.
  1449. */
  1450. knowledgeBase: KnowledgeBase;
  1451. }
  1452. export type Id = string;
  1453. export interface InferenceConfiguration {
  1454. /**
  1455. * The maximum number of tokens to allow in the generated response.
  1456. */
  1457. maximumLength?: MaximumLength;
  1458. /**
  1459. * A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
  1460. */
  1461. stopSequences?: StopSequences;
  1462. /**
  1463. * The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
  1464. */
  1465. temperature?: Temperature;
  1466. /**
  1467. * While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
  1468. */
  1469. topK?: TopK;
  1470. /**
  1471. * While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
  1472. */
  1473. topP?: TopP;
  1474. }
  1475. export interface IngestionJob {
  1476. /**
  1477. * The unique identifier of the ingested data source.
  1478. */
  1479. dataSourceId: Id;
  1480. /**
  1481. * The description of the ingestion job.
  1482. */
  1483. description?: Description;
  1484. /**
  1485. * A list of reasons that the ingestion job failed.
  1486. */
  1487. failureReasons?: FailureReasons;
  1488. /**
  1489. * The unique identifier of the ingestion job.
  1490. */
  1491. ingestionJobId: Id;
  1492. /**
  1493. * The unique identifier of the knowledge base to which the data source is being added.
  1494. */
  1495. knowledgeBaseId: Id;
  1496. /**
  1497. * The time at which the ingestion job started.
  1498. */
  1499. startedAt: DateTimestamp;
  1500. /**
  1501. * Contains statistics about the ingestion job.
  1502. */
  1503. statistics?: IngestionJobStatistics;
  1504. /**
  1505. * The status of the ingestion job.
  1506. */
  1507. status: IngestionJobStatus;
  1508. /**
  1509. * The time at which the ingestion job was last updated.
  1510. */
  1511. updatedAt: DateTimestamp;
  1512. }
  1513. export interface IngestionJobFilter {
  1514. /**
  1515. * The attribute by which to filter the results.
  1516. */
  1517. attribute: IngestionJobFilterAttribute;
  1518. /**
  1519. * The operation to carry out between the attribute and the values.
  1520. */
  1521. operator: IngestionJobFilterOperator;
  1522. /**
  1523. * A list of values for the attribute.
  1524. */
  1525. values: IngestionJobFilterValues;
  1526. }
  1527. export type IngestionJobFilterAttribute = "STATUS"|string;
  1528. export type IngestionJobFilterOperator = "EQ"|string;
  1529. export type IngestionJobFilterValue = string;
  1530. export type IngestionJobFilterValues = IngestionJobFilterValue[];
  1531. export type IngestionJobFilters = IngestionJobFilter[];
  1532. export interface IngestionJobSortBy {
  1533. /**
  1534. * The attribute by which to sort the results.
  1535. */
  1536. attribute: IngestionJobSortByAttribute;
  1537. /**
  1538. * The order by which to sort the results.
  1539. */
  1540. order: SortOrder;
  1541. }
  1542. export type IngestionJobSortByAttribute = "STATUS"|"STARTED_AT"|string;
  1543. export interface IngestionJobStatistics {
  1544. /**
  1545. * The number of source documents that was deleted.
  1546. */
  1547. numberOfDocumentsDeleted?: PrimitiveLong;
  1548. /**
  1549. * The number of source documents that failed to be ingested.
  1550. */
  1551. numberOfDocumentsFailed?: PrimitiveLong;
  1552. /**
  1553. * The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
  1554. */
  1555. numberOfDocumentsScanned?: PrimitiveLong;
  1556. /**
  1557. * The number of metadata files that were updated or deleted.
  1558. */
  1559. numberOfMetadataDocumentsModified?: PrimitiveLong;
  1560. /**
  1561. * The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
  1562. */
  1563. numberOfMetadataDocumentsScanned?: PrimitiveLong;
  1564. /**
  1565. * The number of modified source documents in the data source that were successfully indexed.
  1566. */
  1567. numberOfModifiedDocumentsIndexed?: PrimitiveLong;
  1568. /**
  1569. * The number of new source documents in the data source that were successfully indexed.
  1570. */
  1571. numberOfNewDocumentsIndexed?: PrimitiveLong;
  1572. }
  1573. export type IngestionJobStatus = "STARTING"|"IN_PROGRESS"|"COMPLETE"|"FAILED"|string;
  1574. export type IngestionJobSummaries = IngestionJobSummary[];
  1575. export interface IngestionJobSummary {
  1576. /**
  1577. * The unique identifier of the data source in the ingestion job.
  1578. */
  1579. dataSourceId: Id;
  1580. /**
  1581. * The description of the ingestion job.
  1582. */
  1583. description?: Description;
  1584. /**
  1585. * The unique identifier of the ingestion job.
  1586. */
  1587. ingestionJobId: Id;
  1588. /**
  1589. * The unique identifier of the knowledge base to which the data source is added.
  1590. */
  1591. knowledgeBaseId: Id;
  1592. /**
  1593. * The time at which the ingestion job was started.
  1594. */
  1595. startedAt: DateTimestamp;
  1596. /**
  1597. * Contains statistics for the ingestion job.
  1598. */
  1599. statistics?: IngestionJobStatistics;
  1600. /**
  1601. * The status of the ingestion job.
  1602. */
  1603. status: IngestionJobStatus;
  1604. /**
  1605. * The time at which the ingestion job was last updated.
  1606. */
  1607. updatedAt: DateTimestamp;
  1608. }
  1609. export type Instruction = string;
  1610. export type KmsKeyArn = string;
  1611. export interface KnowledgeBase {
  1612. /**
  1613. * The time at which the knowledge base was created.
  1614. */
  1615. createdAt: DateTimestamp;
  1616. /**
  1617. * The description of the knowledge base.
  1618. */
  1619. description?: Description;
  1620. /**
  1621. * A list of reasons that the API operation on the knowledge base failed.
  1622. */
  1623. failureReasons?: FailureReasons;
  1624. /**
  1625. * The Amazon Resource Name (ARN) of the knowledge base.
  1626. */
  1627. knowledgeBaseArn: KnowledgeBaseArn;
  1628. /**
  1629. * Contains details about the embeddings configuration of the knowledge base.
  1630. */
  1631. knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
  1632. /**
  1633. * The unique identifier of the knowledge base.
  1634. */
  1635. knowledgeBaseId: Id;
  1636. /**
  1637. * The name of the knowledge base.
  1638. */
  1639. name: Name;
  1640. /**
  1641. * The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
  1642. */
  1643. roleArn: KnowledgeBaseRoleArn;
  1644. /**
  1645. * The status of the knowledge base. The following statuses are possible: CREATING – The knowledge base is being created. ACTIVE – The knowledge base is ready to be queried. DELETING – The knowledge base is being deleted. UPDATING – The knowledge base is being updated. FAILED – The knowledge base API operation failed.
  1646. */
  1647. status: KnowledgeBaseStatus;
  1648. /**
  1649. * Contains details about the storage configuration of the knowledge base.
  1650. */
  1651. storageConfiguration: StorageConfiguration;
  1652. /**
  1653. * The time at which the knowledge base was last updated.
  1654. */
  1655. updatedAt: DateTimestamp;
  1656. }
  1657. export type KnowledgeBaseArn = string;
  1658. export interface KnowledgeBaseConfiguration {
  1659. /**
  1660. * The type of data that the data source is converted into for the knowledge base.
  1661. */
  1662. type: KnowledgeBaseType;
  1663. /**
  1664. * Contains details about the embeddings model that'sused to convert the data source.
  1665. */
  1666. vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration;
  1667. }
  1668. export type KnowledgeBaseRoleArn = string;
  1669. export type KnowledgeBaseState = "ENABLED"|"DISABLED"|string;
  1670. export type KnowledgeBaseStatus = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"FAILED"|"DELETE_UNSUCCESSFUL"|string;
  1671. export type KnowledgeBaseStorageType = "OPENSEARCH_SERVERLESS"|"PINECONE"|"REDIS_ENTERPRISE_CLOUD"|"RDS"|"MONGO_DB_ATLAS"|string;
  1672. export type KnowledgeBaseSummaries = KnowledgeBaseSummary[];
  1673. export interface KnowledgeBaseSummary {
  1674. /**
  1675. * The description of the knowledge base.
  1676. */
  1677. description?: Description;
  1678. /**
  1679. * The unique identifier of the knowledge base.
  1680. */
  1681. knowledgeBaseId: Id;
  1682. /**
  1683. * The name of the knowledge base.
  1684. */
  1685. name: Name;
  1686. /**
  1687. * The status of the knowledge base.
  1688. */
  1689. status: KnowledgeBaseStatus;
  1690. /**
  1691. * The time at which the knowledge base was last updated.
  1692. */
  1693. updatedAt: DateTimestamp;
  1694. }
  1695. export type KnowledgeBaseType = "VECTOR"|string;
  1696. export type LambdaArn = string;
  1697. export interface ListAgentActionGroupsRequest {
  1698. /**
  1699. * The unique identifier of the agent.
  1700. */
  1701. agentId: Id;
  1702. /**
  1703. * The version of the agent.
  1704. */
  1705. agentVersion: Version;
  1706. /**
  1707. * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
  1708. */
  1709. maxResults?: MaxResults;
  1710. /**
  1711. * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
  1712. */
  1713. nextToken?: NextToken;
  1714. }
  1715. export interface ListAgentActionGroupsResponse {
  1716. /**
  1717. * A list of objects, each of which contains information about an action group.
  1718. */
  1719. actionGroupSummaries: ActionGroupSummaries;
  1720. /**
  1721. * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
  1722. */
  1723. nextToken?: NextToken;
  1724. }
  1725. export interface ListAgentAliasesRequest {
  1726. /**
  1727. * The unique identifier of the agent.
  1728. */
  1729. agentId: Id;
  1730. /**
  1731. * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
  1732. */
  1733. maxResults?: MaxResults;
  1734. /**
  1735. * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
  1736. */
  1737. nextToken?: NextToken;
  1738. }
  1739. export interface ListAgentAliasesResponse {
  1740. /**
  1741. * A list of objects, each of which contains information about an alias of the agent.
  1742. */
  1743. agentAliasSummaries: AgentAliasSummaries;
  1744. /**
  1745. * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
  1746. */
  1747. nextToken?: NextToken;
  1748. }
  1749. export interface ListAgentKnowledgeBasesRequest {
  1750. /**
  1751. * The unique identifier of the agent for which to return information about knowledge bases associated with it.
  1752. */
  1753. agentId: Id;
  1754. /**
  1755. * The version of the agent for which to return information about knowledge bases associated with it.
  1756. */
  1757. agentVersion: Version;
  1758. /**
  1759. * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
  1760. */
  1761. maxResults?: MaxResults;
  1762. /**
  1763. * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
  1764. */
  1765. nextToken?: NextToken;
  1766. }
  1767. export interface ListAgentKnowledgeBasesResponse {
  1768. /**
  1769. * A list of objects, each of which contains information about a knowledge base associated with the agent.
  1770. */
  1771. agentKnowledgeBaseSummaries: AgentKnowledgeBaseSummaries;
  1772. /**
  1773. * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
  1774. */
  1775. nextToken?: NextToken;
  1776. }
  1777. export interface ListAgentVersionsRequest {
  1778. /**
  1779. * The unique identifier of the agent.
  1780. */
  1781. agentId: Id;
  1782. /**
  1783. * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
  1784. */
  1785. maxResults?: MaxResults;
  1786. /**
  1787. * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
  1788. */
  1789. nextToken?: NextToken;
  1790. }
  1791. export interface ListAgentVersionsResponse {
  1792. /**
  1793. * A list of objects, each of which contains information about a version of the agent.
  1794. */
  1795. agentVersionSummaries: AgentVersionSummaries;
  1796. /**
  1797. * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
  1798. */
  1799. nextToken?: NextToken;
  1800. }
  1801. export interface ListAgentsRequest {
  1802. /**
  1803. * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
  1804. */
  1805. maxResults?: MaxResults;
  1806. /**
  1807. * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
  1808. */
  1809. nextToken?: NextToken;
  1810. }
  1811. export interface ListAgentsResponse {
  1812. /**
  1813. * A list of objects, each of which contains information about an agent.
  1814. */
  1815. agentSummaries: AgentSummaries;
  1816. /**
  1817. * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
  1818. */
  1819. nextToken?: NextToken;
  1820. }
  1821. export interface ListDataSourcesRequest {
  1822. /**
  1823. * The unique identifier of the knowledge base for which to return a list of information.
  1824. */
  1825. knowledgeBaseId: Id;
  1826. /**
  1827. * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
  1828. */
  1829. maxResults?: MaxResults;
  1830. /**
  1831. * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
  1832. */
  1833. nextToken?: NextToken;
  1834. }
  1835. export interface ListDataSourcesResponse {
  1836. /**
  1837. * A list of objects, each of which contains information about a data source.
  1838. */
  1839. dataSourceSummaries: DataSourceSummaries;
  1840. /**
  1841. * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
  1842. */
  1843. nextToken?: NextToken;
  1844. }
  1845. export interface ListIngestionJobsRequest {
  1846. /**
  1847. * The unique identifier of the data source for which to return ingestion jobs.
  1848. */
  1849. dataSourceId: Id;
  1850. /**
  1851. * Contains a definition of a filter for which to filter the results.
  1852. */
  1853. filters?: IngestionJobFilters;
  1854. /**
  1855. * The unique identifier of the knowledge base for which to return ingestion jobs.
  1856. */
  1857. knowledgeBaseId: Id;
  1858. /**
  1859. * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
  1860. */
  1861. maxResults?: MaxResults;
  1862. /**
  1863. * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
  1864. */
  1865. nextToken?: NextToken;
  1866. /**
  1867. * Contains details about how to sort the results.
  1868. */
  1869. sortBy?: IngestionJobSortBy;
  1870. }
  1871. export interface ListIngestionJobsResponse {
  1872. /**
  1873. * A list of objects, each of which contains information about an ingestion job.
  1874. */
  1875. ingestionJobSummaries: IngestionJobSummaries;
  1876. /**
  1877. * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
  1878. */
  1879. nextToken?: NextToken;
  1880. }
  1881. export interface ListKnowledgeBasesRequest {
  1882. /**
  1883. * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
  1884. */
  1885. maxResults?: MaxResults;
  1886. /**
  1887. * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
  1888. */
  1889. nextToken?: NextToken;
  1890. }
  1891. export interface ListKnowledgeBasesResponse {
  1892. /**
  1893. * A list of objects, each of which contains information about a knowledge base.
  1894. */
  1895. knowledgeBaseSummaries: KnowledgeBaseSummaries;
  1896. /**
  1897. * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
  1898. */
  1899. nextToken?: NextToken;
  1900. }
  1901. export interface ListTagsForResourceRequest {
  1902. /**
  1903. * The Amazon Resource Name (ARN) of the resource for which to list tags.
  1904. */
  1905. resourceArn: TaggableResourcesArn;
  1906. }
  1907. export interface ListTagsForResourceResponse {
  1908. /**
  1909. * The key-value pairs for the tags associated with the resource.
  1910. */
  1911. tags?: TagsMap;
  1912. }
  1913. export type MaxResults = number;
  1914. export type MaximumLength = number;
  1915. export type ModelIdentifier = string;
  1916. export type MongoDbAtlasCollectionName = string;
  1917. export interface MongoDbAtlasConfiguration {
  1918. /**
  1919. * The collection name of the knowledge base in MongoDB Atlas.
  1920. */
  1921. collectionName: MongoDbAtlasCollectionName;
  1922. /**
  1923. * The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
  1924. */
  1925. credentialsSecretArn: SecretArn;
  1926. /**
  1927. * The database name in your MongoDB Atlas cluster for your knowledge base.
  1928. */
  1929. databaseName: MongoDbAtlasDatabaseName;
  1930. /**
  1931. * The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
  1932. */
  1933. endpoint: MongoDbAtlasEndpoint;
  1934. /**
  1935. * The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
  1936. */
  1937. endpointServiceName?: MongoDbAtlasEndpointServiceName;
  1938. /**
  1939. * Contains the names of the fields to which to map information about the vector store.
  1940. */
  1941. fieldMapping: MongoDbAtlasFieldMapping;
  1942. /**
  1943. * The name of the MongoDB Atlas vector search index.
  1944. */
  1945. vectorIndexName: MongoDbAtlasIndexName;
  1946. }
  1947. export type MongoDbAtlasDatabaseName = string;
  1948. export type MongoDbAtlasEndpoint = string;
  1949. export type MongoDbAtlasEndpointServiceName = string;
  1950. export interface MongoDbAtlasFieldMapping {
  1951. /**
  1952. * The name of the field in which Amazon Bedrock stores metadata about the vector store.
  1953. */
  1954. metadataField: FieldName;
  1955. /**
  1956. * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
  1957. */
  1958. textField: FieldName;
  1959. /**
  1960. * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
  1961. */
  1962. vectorField: FieldName;
  1963. }
  1964. export type MongoDbAtlasIndexName = string;
  1965. export type Name = string;
  1966. export type NextToken = string;
  1967. export type NumericalVersion = string;
  1968. export type OpenSearchServerlessCollectionArn = string;
  1969. export interface OpenSearchServerlessConfiguration {
  1970. /**
  1971. * The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
  1972. */
  1973. collectionArn: OpenSearchServerlessCollectionArn;
  1974. /**
  1975. * Contains the names of the fields to which to map information about the vector store.
  1976. */
  1977. fieldMapping: OpenSearchServerlessFieldMapping;
  1978. /**
  1979. * The name of the vector store.
  1980. */
  1981. vectorIndexName: OpenSearchServerlessIndexName;
  1982. }
  1983. export interface OpenSearchServerlessFieldMapping {
  1984. /**
  1985. * The name of the field in which Amazon Bedrock stores metadata about the vector store.
  1986. */
  1987. metadataField: FieldName;
  1988. /**
  1989. * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
  1990. */
  1991. textField: FieldName;
  1992. /**
  1993. * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
  1994. */
  1995. vectorField: FieldName;
  1996. }
  1997. export type OpenSearchServerlessIndexName = string;
  1998. export type ParameterDescription = string;
  1999. export interface ParameterDetail {
  2000. /**
  2001. * A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
  2002. */
  2003. description?: ParameterDescription;
  2004. /**
  2005. * Whether the parameter is required for the agent to complete the function for action group invocation.
  2006. */
  2007. required?: Boolean;
  2008. /**
  2009. * The data type of the parameter.
  2010. */
  2011. type: Type;
  2012. }
  2013. export type ParameterMap = {[key: string]: ParameterDetail};
  2014. export type Payload = string;
  2015. export interface PineconeConfiguration {
  2016. /**
  2017. * The endpoint URL for your index management page.
  2018. */
  2019. connectionString: PineconeConnectionString;
  2020. /**
  2021. * The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
  2022. */
  2023. credentialsSecretArn: SecretArn;
  2024. /**
  2025. * Contains the names of the fields to which to map information about the vector store.
  2026. */
  2027. fieldMapping: PineconeFieldMapping;
  2028. /**
  2029. * The namespace to be used to write new data to your database.
  2030. */
  2031. namespace?: PineconeNamespace;
  2032. }
  2033. export type PineconeConnectionString = string;
  2034. export interface PineconeFieldMapping {
  2035. /**
  2036. * The name of the field in which Amazon Bedrock stores metadata about the vector store.
  2037. */
  2038. metadataField: FieldName;
  2039. /**
  2040. * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
  2041. */
  2042. textField: FieldName;
  2043. }
  2044. export type PineconeNamespace = string;
  2045. export interface PrepareAgentRequest {
  2046. /**
  2047. * The unique identifier of the agent for which to create a DRAFT version.
  2048. */
  2049. agentId: Id;
  2050. }
  2051. export interface PrepareAgentResponse {
  2052. /**
  2053. * The unique identifier of the agent for which the DRAFT version was created.
  2054. */
  2055. agentId: Id;
  2056. /**
  2057. * The status of the DRAFT version and whether it is ready for use.
  2058. */
  2059. agentStatus: AgentStatus;
  2060. /**
  2061. * The version of the agent.
  2062. */
  2063. agentVersion: Version;
  2064. /**
  2065. * The time at which the DRAFT version of the agent was last prepared.
  2066. */
  2067. preparedAt: DateTimestamp;
  2068. }
  2069. export type PrimitiveLong = number;
  2070. export interface PromptConfiguration {
  2071. /**
  2072. * Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.
  2073. */
  2074. basePromptTemplate?: BasePromptTemplate;
  2075. /**
  2076. * Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
  2077. */
  2078. inferenceConfiguration?: InferenceConfiguration;
  2079. /**
  2080. * Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
  2081. */
  2082. parserMode?: CreationMode;
  2083. /**
  2084. * Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
  2085. */
  2086. promptCreationMode?: CreationMode;
  2087. /**
  2088. * Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows. PRE_PROCESSING – ENABLED ORCHESTRATION – ENABLED KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED POST_PROCESSING – DISABLED
  2089. */
  2090. promptState?: PromptState;
  2091. /**
  2092. * The step in the agent sequence that this prompt configuration applies to.
  2093. */
  2094. promptType?: PromptType;
  2095. }
  2096. export type PromptConfigurations = PromptConfiguration[];
  2097. export interface PromptOverrideConfiguration {
  2098. /**
  2099. * The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.
  2100. */
  2101. overrideLambda?: LambdaArn;
  2102. /**
  2103. * Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
  2104. */
  2105. promptConfigurations: PromptConfigurations;
  2106. }
  2107. export type PromptState = "ENABLED"|"DISABLED"|string;
  2108. export type PromptType = "PRE_PROCESSING"|"ORCHESTRATION"|"POST_PROCESSING"|"KNOWLEDGE_BASE_RESPONSE_GENERATION"|string;
  2109. export type ProvisionedModelIdentifier = string;
  2110. export type RdsArn = string;
  2111. export interface RdsConfiguration {
  2112. /**
  2113. * The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
  2114. */
  2115. credentialsSecretArn: SecretArn;
  2116. /**
  2117. * The name of your Amazon RDS database.
  2118. */
  2119. databaseName: RdsDatabaseName;
  2120. /**
  2121. * Contains the names of the fields to which to map information about the vector store.
  2122. */
  2123. fieldMapping: RdsFieldMapping;
  2124. /**
  2125. * The Amazon Resource Name (ARN) of the vector store.
  2126. */
  2127. resourceArn: RdsArn;
  2128. /**
  2129. * The name of the table in the database.
  2130. */
  2131. tableName: RdsTableName;
  2132. }
  2133. export type RdsDatabaseName = string;
  2134. export interface RdsFieldMapping {
  2135. /**
  2136. * The name of the field in which Amazon Bedrock stores metadata about the vector store.
  2137. */
  2138. metadataField: ColumnName;
  2139. /**
  2140. * The name of the field in which Amazon Bedrock stores the ID for each entry.
  2141. */
  2142. primaryKeyField: ColumnName;
  2143. /**
  2144. * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
  2145. */
  2146. textField: ColumnName;
  2147. /**
  2148. * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
  2149. */
  2150. vectorField: ColumnName;
  2151. }
  2152. export type RdsTableName = string;
  2153. export type RecommendedAction = string;
  2154. export type RecommendedActions = RecommendedAction[];
  2155. export interface RedisEnterpriseCloudConfiguration {
  2156. /**
  2157. * The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
  2158. */
  2159. credentialsSecretArn: SecretArn;
  2160. /**
  2161. * The endpoint URL of the Redis Enterprise Cloud database.
  2162. */
  2163. endpoint: RedisEnterpriseCloudEndpoint;
  2164. /**
  2165. * Contains the names of the fields to which to map information about the vector store.
  2166. */
  2167. fieldMapping: RedisEnterpriseCloudFieldMapping;
  2168. /**
  2169. * The name of the vector index.
  2170. */
  2171. vectorIndexName: RedisEnterpriseCloudIndexName;
  2172. }
  2173. export type RedisEnterpriseCloudEndpoint = string;
  2174. export interface RedisEnterpriseCloudFieldMapping {
  2175. /**
  2176. * The name of the field in which Amazon Bedrock stores metadata about the vector store.
  2177. */
  2178. metadataField: FieldName;
  2179. /**
  2180. * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
  2181. */
  2182. textField: FieldName;
  2183. /**
  2184. * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
  2185. */
  2186. vectorField: FieldName;
  2187. }
  2188. export type RedisEnterpriseCloudIndexName = string;
  2189. export type S3BucketArn = string;
  2190. export type S3BucketName = string;
  2191. export interface S3DataSourceConfiguration {
  2192. /**
  2193. * The Amazon Resource Name (ARN) of the bucket that contains the data source.
  2194. */
  2195. bucketArn: S3BucketArn;
  2196. /**
  2197. * The bucket account owner ID for the S3 bucket.
  2198. */
  2199. bucketOwnerAccountId?: BucketOwnerAccountId;
  2200. /**
  2201. * A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
  2202. */
  2203. inclusionPrefixes?: S3Prefixes;
  2204. }
  2205. export interface S3Identifier {
  2206. /**
  2207. * The name of the S3 bucket.
  2208. */
  2209. s3BucketName?: S3BucketName;
  2210. /**
  2211. * The S3 object key containing the resource.
  2212. */
  2213. s3ObjectKey?: S3ObjectKey;
  2214. }
  2215. export type S3ObjectKey = string;
  2216. export type S3Prefix = string;
  2217. export type S3Prefixes = S3Prefix[];
  2218. export type SecretArn = string;
  2219. export interface ServerSideEncryptionConfiguration {
  2220. /**
  2221. * The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
  2222. */
  2223. kmsKeyArn?: KmsKeyArn;
  2224. }
  2225. export type SessionTTL = number;
  2226. export type SortOrder = "ASCENDING"|"DESCENDING"|string;
  2227. export interface StartIngestionJobRequest {
  2228. /**
  2229. * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  2230. */
  2231. clientToken?: ClientToken;
  2232. /**
  2233. * The unique identifier of the data source to ingest.
  2234. */
  2235. dataSourceId: Id;
  2236. /**
  2237. * A description of the ingestion job.
  2238. */
  2239. description?: Description;
  2240. /**
  2241. * The unique identifier of the knowledge base to which to add the data source.
  2242. */
  2243. knowledgeBaseId: Id;
  2244. }
  2245. export interface StartIngestionJobResponse {
  2246. /**
  2247. * An object containing information about the ingestion job.
  2248. */
  2249. ingestionJob: IngestionJob;
  2250. }
  2251. export type StopSequences = String[];
  2252. export interface StorageConfiguration {
  2253. /**
  2254. * Contains the storage configuration of the knowledge base in MongoDB Atlas.
  2255. */
  2256. mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration;
  2257. /**
  2258. * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
  2259. */
  2260. opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration;
  2261. /**
  2262. * Contains the storage configuration of the knowledge base in Pinecone.
  2263. */
  2264. pineconeConfiguration?: PineconeConfiguration;
  2265. /**
  2266. * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
  2267. */
  2268. rdsConfiguration?: RdsConfiguration;
  2269. /**
  2270. * Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
  2271. */
  2272. redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration;
  2273. /**
  2274. * The vector store service in which the knowledge base is stored.
  2275. */
  2276. type: KnowledgeBaseStorageType;
  2277. }
  2278. export type String = string;
  2279. export type TagKey = string;
  2280. export type TagKeyList = TagKey[];
  2281. export interface TagResourceRequest {
  2282. /**
  2283. * The Amazon Resource Name (ARN) of the resource to tag.
  2284. */
  2285. resourceArn: TaggableResourcesArn;
  2286. /**
  2287. * An object containing key-value pairs that define the tags to attach to the resource.
  2288. */
  2289. tags: TagsMap;
  2290. }
  2291. export interface TagResourceResponse {
  2292. }
  2293. export type TagValue = string;
  2294. export type TaggableResourcesArn = string;
  2295. export type TagsMap = {[key: string]: TagValue};
  2296. export type Temperature = number;
  2297. export type TopK = number;
  2298. export type TopP = number;
  2299. export type Type = "string"|"number"|"integer"|"boolean"|"array"|string;
  2300. export interface UntagResourceRequest {
  2301. /**
  2302. * The Amazon Resource Name (ARN) of the resource from which to remove tags.
  2303. */
  2304. resourceArn: TaggableResourcesArn;
  2305. /**
  2306. * A list of keys of the tags to remove from the resource.
  2307. */
  2308. tagKeys: TagKeyList;
  2309. }
  2310. export interface UntagResourceResponse {
  2311. }
  2312. export interface UpdateAgentActionGroupRequest {
  2313. /**
  2314. * The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
  2315. */
  2316. actionGroupExecutor?: ActionGroupExecutor;
  2317. /**
  2318. * The unique identifier of the action group.
  2319. */
  2320. actionGroupId: Id;
  2321. /**
  2322. * Specifies a new name for the action group.
  2323. */
  2324. actionGroupName: Name;
  2325. /**
  2326. * Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
  2327. */
  2328. actionGroupState?: ActionGroupState;
  2329. /**
  2330. * The unique identifier of the agent for which to update the action group.
  2331. */
  2332. agentId: Id;
  2333. /**
  2334. * The unique identifier of the agent version for which to update the action group.
  2335. */
  2336. agentVersion: DraftVersion;
  2337. /**
  2338. * Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
  2339. */
  2340. apiSchema?: APISchema;
  2341. /**
  2342. * Specifies a new name for the action group.
  2343. */
  2344. description?: Description;
  2345. /**
  2346. * Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
  2347. */
  2348. functionSchema?: FunctionSchema;
  2349. /**
  2350. * To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
  2351. */
  2352. parentActionGroupSignature?: ActionGroupSignature;
  2353. }
  2354. export interface UpdateAgentActionGroupResponse {
  2355. /**
  2356. * Contains details about the action group that was updated.
  2357. */
  2358. agentActionGroup: AgentActionGroup;
  2359. }
  2360. export interface UpdateAgentAliasRequest {
  2361. /**
  2362. * The unique identifier of the alias.
  2363. */
  2364. agentAliasId: AgentAliasId;
  2365. /**
  2366. * Specifies a new name for the alias.
  2367. */
  2368. agentAliasName: Name;
  2369. /**
  2370. * The unique identifier of the agent.
  2371. */
  2372. agentId: Id;
  2373. /**
  2374. * Specifies a new description for the alias.
  2375. */
  2376. description?: Description;
  2377. /**
  2378. * Contains details about the routing configuration of the alias.
  2379. */
  2380. routingConfiguration?: AgentAliasRoutingConfiguration;
  2381. }
  2382. export interface UpdateAgentAliasResponse {
  2383. /**
  2384. * Contains details about the alias that was updated.
  2385. */
  2386. agentAlias: AgentAlias;
  2387. }
  2388. export interface UpdateAgentKnowledgeBaseRequest {
  2389. /**
  2390. * The unique identifier of the agent associated with the knowledge base that you want to update.
  2391. */
  2392. agentId: Id;
  2393. /**
  2394. * The version of the agent associated with the knowledge base that you want to update.
  2395. */
  2396. agentVersion: DraftVersion;
  2397. /**
  2398. * Specifies a new description for the knowledge base associated with an agent.
  2399. */
  2400. description?: Description;
  2401. /**
  2402. * The unique identifier of the knowledge base that has been associated with an agent.
  2403. */
  2404. knowledgeBaseId: Id;
  2405. /**
  2406. * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
  2407. */
  2408. knowledgeBaseState?: KnowledgeBaseState;
  2409. }
  2410. export interface UpdateAgentKnowledgeBaseResponse {
  2411. /**
  2412. * Contains details about the knowledge base that has been associated with an agent.
  2413. */
  2414. agentKnowledgeBase: AgentKnowledgeBase;
  2415. }
  2416. export interface UpdateAgentRequest {
  2417. /**
  2418. * The unique identifier of the agent.
  2419. */
  2420. agentId: Id;
  2421. /**
  2422. * Specifies a new name for the agent.
  2423. */
  2424. agentName: Name;
  2425. /**
  2426. * The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
  2427. */
  2428. agentResourceRoleArn: AgentRoleArn;
  2429. /**
  2430. * The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
  2431. */
  2432. customerEncryptionKeyArn?: KmsKeyArn;
  2433. /**
  2434. * Specifies a new description of the agent.
  2435. */
  2436. description?: Description;
  2437. /**
  2438. * Specifies a new foundation model to be used for orchestration by the agent.
  2439. */
  2440. foundationModel: ModelIdentifier;
  2441. /**
  2442. * The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
  2443. */
  2444. idleSessionTTLInSeconds?: SessionTTL;
  2445. /**
  2446. * Specifies new instructions that tell the agent what it should do and how it should interact with users.
  2447. */
  2448. instruction?: Instruction;
  2449. /**
  2450. * Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
  2451. */
  2452. promptOverrideConfiguration?: PromptOverrideConfiguration;
  2453. }
  2454. export interface UpdateAgentResponse {
  2455. /**
  2456. * Contains details about the agent that was updated.
  2457. */
  2458. agent: Agent;
  2459. }
  2460. export interface UpdateDataSourceRequest {
  2461. /**
  2462. * The data deletion policy of the updated data source.
  2463. */
  2464. dataDeletionPolicy?: DataDeletionPolicy;
  2465. /**
  2466. * Contains details about the storage configuration of the data source.
  2467. */
  2468. dataSourceConfiguration: DataSourceConfiguration;
  2469. /**
  2470. * The unique identifier of the data source.
  2471. */
  2472. dataSourceId: Id;
  2473. /**
  2474. * Specifies a new description for the data source.
  2475. */
  2476. description?: Description;
  2477. /**
  2478. * The unique identifier of the knowledge base to which the data source belongs.
  2479. */
  2480. knowledgeBaseId: Id;
  2481. /**
  2482. * Specifies a new name for the data source.
  2483. */
  2484. name: Name;
  2485. /**
  2486. * Contains details about server-side encryption of the data source.
  2487. */
  2488. serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
  2489. /**
  2490. * Contains details about how to ingest the documents in the data source.
  2491. */
  2492. vectorIngestionConfiguration?: VectorIngestionConfiguration;
  2493. }
  2494. export interface UpdateDataSourceResponse {
  2495. /**
  2496. * Contains details about the data source.
  2497. */
  2498. dataSource: DataSource;
  2499. }
  2500. export interface UpdateKnowledgeBaseRequest {
  2501. /**
  2502. * Specifies a new description for the knowledge base.
  2503. */
  2504. description?: Description;
  2505. /**
  2506. * Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
  2507. */
  2508. knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
  2509. /**
  2510. * The unique identifier of the knowledge base to update.
  2511. */
  2512. knowledgeBaseId: Id;
  2513. /**
  2514. * Specifies a new name for the knowledge base.
  2515. */
  2516. name: Name;
  2517. /**
  2518. * Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
  2519. */
  2520. roleArn: KnowledgeBaseRoleArn;
  2521. /**
  2522. * Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
  2523. */
  2524. storageConfiguration: StorageConfiguration;
  2525. }
  2526. export interface UpdateKnowledgeBaseResponse {
  2527. /**
  2528. * Contains details about the knowledge base.
  2529. */
  2530. knowledgeBase: KnowledgeBase;
  2531. }
  2532. export interface VectorIngestionConfiguration {
  2533. /**
  2534. * Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
  2535. */
  2536. chunkingConfiguration?: ChunkingConfiguration;
  2537. }
  2538. export interface VectorKnowledgeBaseConfiguration {
  2539. /**
  2540. * The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
  2541. */
  2542. embeddingModelArn: BedrockEmbeddingModelArn;
  2543. }
  2544. export type Version = string;
  2545. /**
  2546. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  2547. */
  2548. export type apiVersion = "2023-06-05"|"latest"|string;
  2549. export interface ClientApiVersions {
  2550. /**
  2551. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  2552. */
  2553. apiVersion?: apiVersion;
  2554. }
  2555. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2556. /**
  2557. * Contains interfaces for use with the BedrockAgent client.
  2558. */
  2559. export import Types = BedrockAgent;
  2560. }
  2561. export = BedrockAgent;