openapi: 3.2.0
info:
  title: Amazon Web Services Knowledgebases API
  version: '1.0'
  description: 'Operations tagged Knowledgebases across 3 of this provider''s published API definitions: bedrock-agent-openapi-original.yml, bedrock-agent-runtime-openapi-original.yml, qconnect-openapi-original.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Knowledge Bases
paths:
  /knowledgebases/{knowledgeBaseId}/datasources/:
    POST:
      summary: Amazon Web Services Listdatasources
      description: List data sources
      operationId: amazonWebServicesListDataSources
      tags:
      - Knowledge Bases
  /knowledgebases/:
    POST:
      summary: Amazon Web Services Listknowledgebases
      description: List Knowledge Bases
      operationId: amazonWebServicesListKnowledgeBases
      tags:
      - Knowledge Bases
  /knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}:
    PUT:
      summary: Amazon Web Services Updatedatasource
      description: Update an existing data source
      operationId: amazonWebServicesUpdateDataSource
      tags:
      - Knowledge Bases
  /knowledgebases/{knowledgeBaseId}:
    PUT:
      summary: Amazon Web Services Updateknowledgebase
      description: Update an existing knowledge base
      operationId: amazonWebServicesUpdateKnowledgeBase
      tags:
      - Knowledge Bases
  /knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}:
    GET:
      summary: Amazon Web Services Getingestionjob
      description: Get an ingestion job
      operationId: amazonWebServicesGetIngestionJob
      tags:
      - Knowledge Bases
  /knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/:
    PUT:
      summary: Amazon Web Services Startingestionjob
      description: Start a new ingestion job
      operationId: amazonWebServicesStartIngestionJob
      tags:
      - Knowledge Bases
  /knowledgebases/{knowledgeBaseId}/retrieve:
    POST:
      summary: Amazon Web Services Retrieve
      description: Retrieve from knowledge base.
      operationId: amazonWebServicesRetrieve
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/contents:
    GET:
      summary: Amazon Web Services Listcontents
      description: Lists the content.
      operationId: amazonWebServicesListContents
      tags:
      - Knowledge Bases
  /knowledgeBases:
    GET:
      summary: Amazon Web Services Listknowledgebases
      description: Lists the knowledge bases.
      operationId: getKnowledgeBases
      tags:
      - Knowledge Bases
      x-operation-id-source: normalized
      x-operation-id-original: amazonWebServicesListKnowledgeBases
  /knowledgeBases/{knowledgeBaseId}/quickResponses:
    GET:
      summary: Amazon Web Services Listquickresponses
      description: Lists information about quick response.
      operationId: amazonWebServicesListQuickResponses
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/contents/{contentId}:
    POST:
      summary: Amazon Web Services Updatecontent
      description: Updates information about the content.
      operationId: amazonWebServicesUpdateContent
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}:
    GET:
      summary: Amazon Web Services Getimportjob
      description: Retrieves the started import job.
      operationId: amazonWebServicesGetImportJob
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}:
    GET:
      summary: Amazon Web Services Getknowledgebase
      description: Retrieves information about the knowledge base.
      operationId: amazonWebServicesGetKnowledgeBase
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}:
    POST:
      summary: Amazon Web Services Updatequickresponse
      description: Updates an existing Amazon Q quick response.
      operationId: amazonWebServicesUpdateQuickResponse
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary:
    GET:
      summary: Amazon Web Services Getcontentsummary
      description: Retrieves summary information about the content.
      operationId: amazonWebServicesGetContentSummary
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/importJobs:
    POST:
      summary: Amazon Web Services Startimportjob
      description: Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. For importing Amazon Q quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
      operationId: amazonWebServicesStartImportJob
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/templateUri:
    POST:
      summary: Amazon Web Services Updateknowledgebasetemplateuri
      description: Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Amazon Q using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
      operationId: amazonWebServicesUpdateKnowledgeBaseTemplateUri
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/search:
    POST:
      summary: Amazon Web Services Searchcontent
      description: Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
      operationId: amazonWebServicesSearchContent
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/search/quickResponses:
    POST:
      summary: Amazon Web Services Searchquickresponses
      description: Searches existing Amazon Q quick responses in an Amazon Q knowledge base.
      operationId: amazonWebServicesSearchQuickResponses
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}/upload:
    POST:
      summary: Amazon Web Services Startcontentupload
      description: Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
      operationId: amazonWebServicesStartContentUpload
      tags:
      - Knowledge Bases
x-refined-from:
- bedrock-agent-openapi-original.yml
- bedrock-agent-runtime-openapi-original.yml
- qconnect-openapi-original.yml