Amazon Q Knowledge Bases API

openapi: 3.2.0
info:
  title: QBusiness Knowledgebases Knowledge Bases API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://wisdom.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Knowledge Bases
paths:
  /knowledgeBases:
    post:
      operationId: CreateKnowledgeBase
      summary: Create Knowledge Base
      description: 'Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you''ll get an InvalidRequestException error. For example, you''re programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following: Call DeleteKnowledgeBase. Call DeleteDataIntegration. Call CreateDataIntegration to recreate the DataIntegration or a create different one. Call CreateKnowledgeBase.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateKnowledgeBaseResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomConflictException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomServiceQuotaExceededException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateKnowledgeBaseRequest'
      tags:
      - Knowledge Bases
    get:
      operationId: ListKnowledgeBases
      summary: List Knowledge Bases
      description: Lists the knowledge bases.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListKnowledgeBasesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListKnowledgeBasesRequest'
      tags:
      - Knowledge Bases
  /knowledgeBases/{knowledgeBaseId}:
    get:
      operationId: GetKnowledgeBase
      summary: Get Knowledge Base
      description: Retrieves information about the knowledge base.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKnowledgeBaseResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetKnowledgeBaseRequest'
      tags:
      - Knowledge Bases
    delete:
      operationId: DeleteKnowledgeBase
      summary: Delete Knowledge Base
      description: Deletes the knowledge base. When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteKnowledgeBaseResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteKnowledgeBaseRequest'
      tags:
      - Knowledge Bases
components:
  schemas:
    AppIntegrationsConfiguration:
      type: object
      properties:
        appIntegrationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields. For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields. For Zendesk, your AppIntegrations DataIntegration
        objectFields:
          type: array
          items:
            type: string
          description: The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted. For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active. For Zendesk, you must include at least id, title, updated_at, and draft. Make sure to include additional fields. These fields are indexed and used to source recommendations.
      required:
      - appIntegrationArn
    RenderingConfiguration:
      type: object
      properties:
        templateUri:
          type: string
          description: 'A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted ServiceNow: number, short_description, sys_mod_count, workflow_state, or active Zendesk: id, title, updated_at, or draft The variable is replaced with the actual value for a piece of content when calling GetContent.'
    ListKnowledgeBasesRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
        maxResults:
          type: integer
          description: The maximum number of results to return per page.
    WisdomAccessDeniedException:
      type: object
      properties:
        message:
          type: string
    GetKnowledgeBaseResponse:
      type: object
      properties:
        knowledgeBase:
          $ref: '#/components/schemas/KnowledgeBaseData'
    WisdomResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The specified resource name.
    WisdomValidationException:
      type: object
      properties:
        message:
          type: string
    WisdomServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ListKnowledgeBasesResponse:
      type: object
      properties:
        knowledgeBaseSummaries:
          type: array
          items:
            $ref: '#/components/schemas/KnowledgeBaseSummary'
          description: Information about the knowledge bases.
        nextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
      required:
      - knowledgeBaseSummaries
    HierarchicalChunkingConfiguration:
      type: object
      properties:
        levelConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/HierarchicalChunkingLevelConfiguration'
          description: Token settings for each layer.
        overlapTokens:
          type: integer
          description: The number of tokens to repeat across chunks in the same layer.
      required:
      - levelConfigurations
      - overlapTokens
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    ServerSideEncryptionConfiguration:
      type: object
      properties:
        kmsKeyId:
          type: string
          description: The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
    WisdomConflictException:
      type: object
      properties:
        message:
          type: string
    VectorIngestionConfiguration:
      type: object
      properties:
        chunkingConfiguration:
          $ref: '#/components/schemas/ChunkingConfiguration'
        parsingConfiguration:
          $ref: '#/components/schemas/ParsingConfiguration'
    ChunkingConfiguration:
      type: object
      properties:
        chunkingStrategy:
          type: string
          description: 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.
        fixedSizeChunkingConfiguration:
          $ref: '#/components/schemas/FixedSizeChunkingConfiguration'
        hierarchicalChunkingConfiguration:
          $ref: '#/components/schemas/HierarchicalChunkingConfiguration'
        semanticChunkingConfiguration:
          $ref: '#/components/schemas/SemanticChunkingConfiguration'
      required:
      - chunkingStrategy
    SemanticChunkingConfiguration:
      type: object
      properties:
        maxTokens:
          type: integer
          description: The maximum number of tokens that a chunk can contain.
        bufferSize:
          type: integer
          description: The buffer size.
        breakpointPercentileThreshold:
          type: integer
          description: The dissimilarity threshold for splitting chunks.
      required:
      - maxTokens
      - bufferSize
      - breakpointPercentileThreshold
    SeedUrl:
      type: object
      properties:
        url:
          type: string
          description: URL for crawling
    BedrockFoundationModelConfigurationForParsing:
      type: object
      properties:
        modelArn:
          type: string
          description: The ARN of the foundation model.
        parsingPrompt:
          $ref: '#/components/schemas/ParsingPrompt'
      required:
      - modelArn
    KnowledgeBaseSummary:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        knowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the knowledge base.
        name:
          type: string
          description: The name of the knowledge base.
        knowledgeBaseType:
          type: string
          description: The type of knowledge base.
        status:
          type: string
          description: The status of the knowledge base summary.
        sourceConfiguration:
          $ref: '#/components/schemas/SourceConfiguration'
        vectorIngestionConfiguration:
          $ref: '#/components/schemas/VectorIngestionConfiguration'
        renderingConfiguration:
          $ref: '#/components/schemas/RenderingConfiguration'
        serverSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
        description:
          type: string
          description: The description of the knowledge base.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - knowledgeBaseId
      - knowledgeBaseArn
      - name
      - knowledgeBaseType
      - status
    ParsingConfiguration:
      type: object
      properties:
        parsingStrategy:
          type: string
          description: The parsing strategy for the data source.
        bedrockFoundationModelConfiguration:
          $ref: '#/components/schemas/BedrockFoundationModelConfigurationForParsing'
      required:
      - parsingStrategy
    ParsingPrompt:
      type: object
      properties:
        parsingPromptText:
          type: string
          description: Instructions for interpreting the contents of a document.
      required:
      - parsingPromptText
    WebCrawlerLimits:
      type: object
      properties:
        rateLimit:
          type: integer
          description: Rate of web URLs retrieved per minute.
    SourceConfiguration:
      type: object
      properties:
        appIntegrations:
          $ref: '#/components/schemas/AppIntegrationsConfiguration'
        managedSourceConfiguration:
          $ref: '#/components/schemas/ManagedSourceConfiguration'
      description: Exactly one member is set.
    ManagedSourceConfiguration:
      type: object
      properties:
        webCrawlerConfiguration:
          $ref: '#/components/schemas/WebCrawlerConfiguration'
      description: Exactly one member is set.
    CreateKnowledgeBaseRequest:
      type: object
      properties:
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
        name:
          type: string
          description: The name of the knowledge base.
        knowledgeBaseType:
          type: string
          description: The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
        sourceConfiguration:
          $ref: '#/components/schemas/SourceConfiguration'
        renderingConfiguration:
          $ref: '#/components/schemas/RenderingConfiguration'
        vectorIngestionConfiguration:
          $ref: '#/components/schemas/VectorIngestionConfiguration'
        serverSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
        description:
          type: string
          description: The description.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - name
      - knowledgeBaseType
    HierarchicalChunkingLevelConfiguration:
      type: object
      properties:
        maxTokens:
          type: integer
          description: The maximum number of tokens that a chunk can contain in this layer.
      required:
      - maxTokens
    DeleteKnowledgeBaseRequest:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - knowledgeBaseId
    DeleteKnowledgeBaseResponse:
      type: object
      properties: {}
    CreateKnowledgeBaseResponse:
      type: object
      properties:
        knowledgeBase:
          $ref: '#/components/schemas/KnowledgeBaseData'
    FixedSizeChunkingConfiguration:
      type: object
      properties:
        maxTokens:
          type: integer
          description: The maximum number of tokens to include in a chunk.
        overlapPercentage:
          type: integer
          description: The percentage of overlap between adjacent chunks of a data source.
      required:
      - maxTokens
      - overlapPercentage
    KnowledgeBaseData:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        knowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the knowledge base.
        name:
          type: string
          description: The name of the knowledge base.
        knowledgeBaseType:
          type: string
          description: The type of knowledge base.
        status:
          type: string
          description: The status of the knowledge base.
        lastContentModificationTime:
          type: string
          description: An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
        vectorIngestionConfiguration:
          $ref: '#/components/schemas/VectorIngestionConfiguration'
        sourceConfiguration:
          $ref: '#/components/schemas/SourceConfiguration'
        renderingConfiguration:
          $ref: '#/components/schemas/RenderingConfiguration'
        serverSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
        description:
          type: string
          description: The description.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        ingestionStatus:
          type: string
          description: Status of ingestion on data source.
        ingestionFailureReasons:
          type: array
          items:
            type: string
          description: List of failure reasons on ingestion per file.
      required:
      - knowledgeBaseId
      - knowledgeBaseArn
      - name
      - knowledgeBaseType
      - status
    WebCrawlerConfiguration:
      type: object
      properties:
        urlConfiguration:
          $ref: '#/components/schemas/UrlConfiguration'
        crawlerLimits:
          $ref: '#/components/schemas/WebCrawlerLimits'
        inclusionFilters:
          type: array
          items:
            type: string
          description: A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        exclusionFilters:
          type: array
          items:
            type: string
          description: A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        scope:
          type: string
          description: The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com.
      required:
      - urlConfiguration
    GetKnowledgeBaseRequest:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - knowledgeBaseId
    UrlConfiguration:
      type: object
      properties:
        seedUrls:
          type: array
          items:
            $ref: '#/components/schemas/SeedUrl'
          description: List of URLs for crawling.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: wisdom
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qconnect/service/2020-10-19/qconnect-2020-10-19.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)