Amazon Q Q Search API

openapi: 3.2.0
info:
  title: QBusiness Search API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 3 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: Search
paths:
  /knowledgeBases/{knowledgeBaseId}/search:
    post:
      operationId: SearchContent
      summary: Search Content
      description: Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchContentResponse'
        '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/SearchContentRequest'
      tags:
      - Search
  /knowledgeBases/{knowledgeBaseId}/search/messageTemplates:
    post:
      operationId: SearchMessageTemplates
      summary: Search Message Templates
      description: Searches for Amazon Q in Connect message templates in the specified knowledge base.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchMessageTemplatesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchMessageTemplatesRequest'
      tags:
      - Search
  /knowledgeBases/{knowledgeBaseId}/search/quickResponses:
    post:
      operationId: SearchQuickResponses
      summary: Search Quick Responses
      description: Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchQuickResponsesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '408':
          description: RequestTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimeoutException'
        '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/SearchQuickResponsesRequest'
      tags:
      - Search
components:
  schemas:
    MessageTemplateOrderField:
      type: object
      properties:
        name:
          type: string
          description: The name of the message template.
        order:
          type: string
          description: The order at which the message templates are sorted by.
      required:
      - name
    QuickResponseQueryField:
      type: object
      properties:
        name:
          type: string
          description: The name of the attribute to query the quick responses by.
        values:
          type: array
          items:
            type: string
          description: The values of the attribute to query the quick responses by.
        operator:
          type: string
          description: The operator to use for matching attribute field values in the query.
        allowFuzziness:
          type: boolean
          description: Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
        priority:
          type: string
          description: The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
      required:
      - name
      - values
      - operator
    SearchQuickResponsesRequest:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
        searchExpression:
          $ref: '#/components/schemas/QuickResponseSearchExpression'
        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.
        attributes:
          type: object
          additionalProperties:
            type: string
          description: The user-defined Connect Customer contact attributes to be resolved when search results are returned.
      required:
      - knowledgeBaseId
      - searchExpression
    QuickResponseSearchExpression:
      type: object
      properties:
        queries:
          type: array
          items:
            $ref: '#/components/schemas/QuickResponseQueryField'
          description: The quick response query expressions.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/QuickResponseFilterField'
          description: The configuration of filtering rules applied to quick response query results.
        orderOnField:
          $ref: '#/components/schemas/QuickResponseOrderField'
    MessageTemplateSourceConfigurationSummary:
      type: object
      properties:
        whatsApp:
          $ref: '#/components/schemas/WhatsAppMessageTemplateSourceConfigurationSummary'
      description: Exactly one member is set.
    WisdomAccessDeniedException:
      type: object
      properties:
        message:
          type: string
    Filter:
      type: object
      properties:
        field:
          type: string
          description: The field on which to filter.
        operator:
          type: string
          description: The operator to use for comparing the field’s value with the provided value.
        value:
          type: string
          description: The desired field value on which to filter.
      required:
      - field
      - operator
      - value
    SearchContentRequest:
      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.
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
        searchExpression:
          $ref: '#/components/schemas/SearchExpression'
      required:
      - knowledgeBaseId
      - searchExpression
    SearchExpression:
      type: object
      properties:
        filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: The search expression filters.
      required:
      - filters
    MessageTemplateQueryField:
      type: object
      properties:
        name:
          type: string
          description: The name of the attribute to query the message templates by.
        values:
          type: array
          items:
            type: string
          description: The values of the attribute to query the message templates by.
        operator:
          type: string
          description: The operator to use for matching attribute field values in the query.
        allowFuzziness:
          type: boolean
          description: Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
        priority:
          type: string
          description: The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
      required:
      - name
      - values
      - operator
    SearchQuickResponsesResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/QuickResponseSearchResultData'
          description: The results of the quick response search.
        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.
      required:
      - results
    WisdomResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The specified resource name.
    RequestTimeoutException:
      type: object
      properties:
        message:
          type: string
    WisdomValidationException:
      type: object
      properties:
        message:
          type: string
    QuickResponseSearchResultData:
      type: object
      properties:
        quickResponseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the quick response.
        quickResponseId:
          type: string
          description: The identifier of the quick response.
        knowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the knowledge base.
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
        name:
          type: string
          description: The name of the quick response.
        contentType:
          type: string
          description: The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext.
        status:
          type: string
          description: The resource status of the quick response.
        contents:
          $ref: '#/components/schemas/QuickResponseContents'
        createdTime:
          type: string
          description: The timestamp when the quick response was created.
        lastModifiedTime:
          type: string
          description: The timestamp when the quick response search result data was last modified.
        isActive:
          type: boolean
          description: Whether the quick response is active.
        description:
          type: string
          description: The description of the quick response.
        groupingConfiguration:
          $ref: '#/components/schemas/GroupingConfiguration'
        shortcutKey:
          type: string
          description: The shortcut key of the quick response. The value should be unique across the knowledge base.
        lastModifiedBy:
          type: string
          description: The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
        channels:
          type: array
          items:
            type: string
          description: The Connect Customer contact channels this quick response applies to. The supported contact channel types include Chat.
        language:
          type: string
          description: The language code value for the language in which the quick response is written.
        attributesNotInterpolated:
          type: array
          items:
            type: string
          description: The user defined contact attributes that are not resolved when the search result is returned.
        attributesInterpolated:
          type: array
          items:
            type: string
          description: The user defined contact attributes that are resolved when the search result is returned.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - quickResponseArn
      - quickResponseId
      - knowledgeBaseArn
      - knowledgeBaseId
      - name
      - contentType
      - status
      - contents
      - createdTime
      - lastModifiedTime
      - isActive
    QuickResponseContentProvider:
      type: object
      properties:
        content:
          type: string
          description: The content of the quick response.
      description: Exactly one member is set.
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    SearchMessageTemplatesRequest:
      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.
        searchExpression:
          $ref: '#/components/schemas/MessageTemplateSearchExpression'
        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.
      required:
      - knowledgeBaseId
      - searchExpression
    MessageTemplateFilterField:
      type: object
      properties:
        name:
          type: string
          description: The name of the attribute field to filter the message templates by.
        values:
          type: array
          items:
            type: string
          description: The values of attribute field to filter the message template by.
        operator:
          type: string
          description: The operator to use for filtering.
        includeNoExistence:
          type: boolean
          description: Whether to treat null value as a match for the attribute field.
      required:
      - name
      - operator
    QuickResponseOrderField:
      type: object
      properties:
        name:
          type: string
          description: The name of the attribute to order the quick response query results by.
        order:
          type: string
          description: The order at which the quick responses are sorted by.
      required:
      - name
    MessageTemplateSearchResultData:
      type: object
      properties:
        messageTemplateArn:
          type: string
          description: The Amazon Resource Name (ARN) of the message template.
        messageTemplateId:
          type: string
          description: The identifier of the message template.
        knowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the knowledge base.
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        name:
          type: string
          description: The name of the message template.
        channel:
          type: string
          description: The channel of the message template.
        channelSubtype:
          type: string
          description: The channel subtype this message template applies to.
        createdTime:
          type: string
          description: The timestamp when the message template was created.
        lastModifiedTime:
          type: string
          description: The timestamp when the message template data was last modified.
        lastModifiedBy:
          type: string
          description: The Amazon Resource Name (ARN) of the user who last updated the message template data.
        isActive:
          type: boolean
          description: Whether the version of the message template is activated.
        versionNumber:
          type: integer
          description: The version number of the message template version.
        description:
          type: string
          description: The description of the message template.
        sourceConfigurationSummary:
          $ref: '#/components/schemas/MessageTemplateSourceConfigurationSummary'
        groupingConfiguration:
          $ref: '#/components/schemas/GroupingConfiguration'
        language:
          type: string
          description: The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - messageTemplateArn
      - messageTemplateId
      - knowledgeBaseArn
      - knowledgeBaseId
      - name
      - channelSubtype
      - createdTime
      - lastModifiedTime
      - lastModifiedBy
    WhatsAppMessageTemplateSourceConfigurationSummary:
      type: object
      properties:
        businessAccountId:
          type: string
          description: The ID of the End User Messaging WhatsApp Business Account to associate with this template.
        templateId:
          type: string
          description: The ID of WhatsApp template.
        name:
          type: string
          description: The name of the WhatsApp template.
        language:
          type: string
          description: The language of the WhatsApp template.
        components:
          type: array
          items:
            type: string
          description: The list of component mapping from WhatsApp template parameters to Message Template attributes.
        status:
          type: string
          description: The status of the message template.
        statusReason:
          type: string
          description: The status reason of the message template.
      required:
      - businessAccountId
      - templateId
    ContentSummary:
      type: object
      properties:
        contentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the content.
        contentId:
          type: string
          description: The identifier of the content.
        knowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the knowledge base.
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
        name:
          type: string
          description: The name of the content.
        revisionId:
          type: string
          description: The identifier of the revision of the content.
        title:
          type: string
          description: The title of the content.
        contentType:
          type: string
          description: The media type of the content.
        status:
          type: string
          description: The status of the content.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - contentArn
      - contentId
      - knowledgeBaseArn
      - knowledgeBaseId
      - name
      - revisionId
      - title
      - contentType
      - status
      - metadata
    MessageTemplateSearchExpression:
      type: object
      properties:
        queries:
          type: array
          items:
            $ref: '#/components/schemas/MessageTemplateQueryField'
          description: The message template query expressions.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/MessageTemplateFilterField'
          description: The configuration of filtering rules applied to message template query results.
        orderOnField:
          $ref: '#/components/schemas/MessageTemplateOrderField'
    SearchContentResponse:
      type: object
      properties:
        contentSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ContentSummary'
          description: Summary information about the content.
        nextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
      required:
      - contentSummaries
    QuickResponseFilterField:
      type: object
      properties:
        name:
          type: string
          description: The name of the attribute field to filter the quick responses by.
        values:
          type: array
          items:
            type: string
          description: The values of attribute field to filter the quick response by.
        operator:
          type: string
          description: The operator to use for filtering.
        includeNoExistence:
          type: boolean
          description: Whether to treat null value as a match for the attribute field.
      required:
      - name
      - operator
    GroupingConfiguration:
      type: object
      properties:
        criteria:
          type: string
          description: 'The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.'
        values:
          type: array
          items:
            type: string
          description: The list of values that define different groups of Amazon Q in Connect users. When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Connect Customer routing profiles as values of this parameter.
    SearchMessageTemplatesResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/MessageTemplateSearchResultData'
          description: The results of the message template search.
        nextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
      required:
      - results
    QuickResponseContents:
      type: object
      properties:
        plainText:
          $ref: '#/components/schemas/QuickResponseContentProvider'
        markdown:
          $ref: '#/components/schemas/QuickResponseContentProvider'
    WisdomThrottlingException:
      type: object
      properties:
        message:
          type: string
  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)