openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Vectorize Beta (Deprecated) API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Vectorize Beta (Deprecated)
paths:
  /accounts/{account_id}/vectorize/indexes:
    get:
      deprecated: true
      description: Returns a list of Vectorize Indexes
      operationId: vectorize-(-deprecated)-list-vectorize-indexes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: List Vectorize Index Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-common'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/vectorize_create-index-response'
                      type: array
          description: List Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Vectorize Indexes (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-api-token-group:
      - Vectorize Write
      - Vectorize Read
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the GET `/accounts/{account_id}/vectorize/v2/indexes` endpoint.
        display: true
        id: vectorize_list_index_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.list
    post:
      deprecated: true
      description: Creates and returns a new Vectorize Index.
      operationId: vectorize-(-deprecated)-create-vectorize-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_create-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Create Vectorize Index Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_create-index-response'
          description: Create Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Vectorize Index (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-api-token-group:
      - Vectorize Write
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes` endpoint.
        display: true
        id: vectorize_create_index_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.create
  /accounts/{account_id}/vectorize/indexes/{index_name}:
    delete:
      deprecated: true
      description: Deletes the specified Vectorize Index.
      operationId: vectorize-(-deprecated)-delete-vectorize-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Vectorize Index Failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      nullable: true
                      type: object
          description: Delete Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Vectorize Index (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-api-token-group:
      - Vectorize Write
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the DELETE `/accounts/{account_id}/vectorize/v2/indexes/{index_name}` endpoint.
        display: true
        id: vectorize_delete_index_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.delete
    get:
      deprecated: true
      description: Returns the specified Vectorize Index.
      operationId: vectorize-(-deprecated)-get-vectorize-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectorize Index Failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_create-index-response'
          description: Get Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Vectorize Index (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-api-token-group:
      - Vectorize Write
      - Vectorize Read
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the GET `/accounts/{account_id}/vectorize/v2/indexes/{index_name}` endpoint.
        display: true
        id: vectorize_get_index_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.read
    put:
      deprecated: true
      description: Updates and returns the specified Vectorize Index.
      operationId: vectorize-(-deprecated)-update-vectorize-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_update-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Update Vectorize Index Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_create-index-response'
          description: Update Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Vectorize Index (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-api-token-group:
      - Vectorize Write
      x-cfDeprecation:
        description: This endpoint has been deprecated and will soon be removed.
        display: true
        id: vectorize_update_index_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/indexes/{index_name}/delete-by-ids:
    post:
      deprecated: true
      description: Delete a set of vectors from an index by their vector identifiers.
      operationId: vectorize-(-deprecated)-delete-vectors-by-id
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Vector Identifiers Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-response'
          description: Delete Vector Identifiers Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Vectors By Identifier (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids` endpoint.
        display: true
        id: vectorize_delete_by_ids_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids:
    post:
      deprecated: true
      description: Get a set of vectors from an index by their vector identifiers.
      operationId: vectorize-(-deprecated)-get-vectors-by-id
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectors By Identifier Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-response'
          description: Get Vectors By Identifier Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Vectors By Identifier (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids` endpoint.
        display: true
        id: vectorize_get_by_ids_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/indexes/{index_name}/insert:
    post:
      deprecated: true
      description: Inserts vectors into the specified index and returns the count of the vectors successfully inserted.
      operationId: vectorize-(-deprecated)-insert-vector
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/x-ndjson:
            schema:
              description: ndjson file containing vectors to insert.
              example: '@/path/to/vectors.ndjson'
              format: binary
              type: string
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Insert Vectors Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-insert-response'
          description: Insert Vectors Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Insert Vectors (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-api-token-group:
      - Vectorize Write
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert` endpoint.
        display: true
        id: vectorize_insert_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/indexes/{index_name}/query:
    post:
      deprecated: true
      description: Finds vectors closest to a given vector in an index.
      operationId: vectorize-(-deprecated)-query-vector
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-query-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Query Vectors Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-query-response'
          description: Query Vectors Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Query Vectors (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-api-token-group:
      - Vectorize Write
      - Vectorize Read
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query` endpoint.
        display: true
        id: vectorize_query_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/indexes/{index_name}/upsert:
    post:
      deprecated: true
      description: Upserts vectors into the specified index, creating them if they do not exist and returns the count of values and ids successfully inserted.
      operationId: vectorize-(-deprecated)-upsert-vector
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/x-ndjson:
            schema:
              description: ndjson file containing vectors to upsert.
              example: '@/path/to/vectors.ndjson'
              format: binary
              type: string
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Insert Vectors Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-upsert-response'
          description: Insert Vectors Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Upsert Vectors (Deprecated)
      tags:
      - Vectorize Beta (Deprecated)
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert` endpoint.
        display: true
        id: vectorize_upsert_deprecation
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.update
components:
  schemas:
    vectorize_index-query-response:
      properties:
        count:
          description: Specifies the count of vectors returned by the search
          type: integer
        matches:
          description: Array of vectors matched by the search
          items:
            properties:
              id:
                $ref: '#/components/schemas/vectorize_vector-identifier'
              metadata:
                nullable: true
                type: object
              score:
                description: The score of the vector according to the index's distance metric
                type: number
              values:
                items:
                  type: number
                nullable: true
                type: array
            type: object
          type: array
      type: object
    vectorize_index-insert-response:
      properties:
        count:
          description: Specifies the count of the vectors successfully inserted.
          example: 768
          type: integer
        ids:
          description: Array of vector identifiers of the vectors successfully inserted.
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/vectorize_messages'
        messages:
          $ref: '#/components/schemas/vectorize_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    vectorize_index-delete-vectors-by-id-request:
      properties:
        ids:
          description: A list of vector identifiers to delete from the index indicated by the path.
          example:
          - 5121db81354a40c6aedc3fe1ace51c59
          - f90eb49c2107486abdfd78c67e853430
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_index-get-vectors-by-id-response:
      description: Array of vectors with matching ids.
      example:
      - id: some-vector-id
        metadata:
          another-key: another-value
          customer-id: 442
        values:
        - 0.812
        - 0.621
        - 0.261
      - id: other-vector-id
        metadata:
          another-key: with-a-value
          customer-id: 2151
        namespace: namespaced
        values:
        - 0.961
        - 0.751
        - 0.661
      items:
        properties:
          id:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          metadata:
            type: object
          namespace:
            nullable: true
            type: string
          values:
            items:
              type: number
            type: array
        type: object
      type: array
    vectorize_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/vectorize_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/vectorize_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    vectorize_index-dimensions:
      description: Specifies the number of dimensions for the index
      example: 768
      maximum: 1536
      minimum: 1
      type: integer
    vectorize_index-name:
      example: example-index
      pattern: ^([a-z]+[a-z0-9_-]*[a-z0-9]+)$
      type: string
    vectorize_index-description:
      description: Specifies the description of the index.
      example: This is my example index.
      type: string
    vectorize_api-response-single:
      allOf:
      - $ref: '#/components/schemas/vectorize_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            nullable: true
            type: object
      type: object
    vectorize_index-dimension-configuration:
      properties:
        dimensions:
          $ref: '#/components/schemas/vectorize_index-dimensions'
        metric:
          $ref: '#/components/schemas/vectorize_index-metric'
      required:
      - dimensions
      - metric
      type: object
    vectorize_index-metric:
      description: Specifies the type of metric to use calculating distance.
      enum:
      - cosine
      - euclidean
      - dot-product
      type: string
    vectorize_index-delete-vectors-by-id-response:
      properties:
        count:
          description: The count of the vectors successfully deleted.
          example: 42
          type: integer
        ids:
          description: Array of vector identifiers of the vectors that were successfully processed for deletion.
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    vectorize_create-index-response:
      properties:
        config:
          $ref: '#/components/schemas/vectorize_index-dimension-configuration'
        created_on:
          description: Specifies the timestamp the resource was created as an ISO8601 string.
          example: '2022-11-15T18:25:44.442097Z'
          format: date-time
          readOnly: true
          type: string
        description:
          $ref: '#/components/schemas/vectorize_index-description'
        modified_on:
          description: Specifies the timestamp the resource was modified as an ISO8601 string.
          example: '2022-11-15T18:25:44.442097Z'
          format: date-time
          readOnly: true
          type: string
        name:
          $ref: '#/components/schemas/vectorize_index-name'
      type: object
    vectorize_index-preset:
      description: Specifies the preset to use for the index.
      enum:
      - '@cf/baai/bge-small-en-v1.5'
      - '@cf/baai/bge-base-en-v1.5'
      - '@cf/baai/bge-large-en-v1.5'
      - openai/text-embedding-ada-002
      - cohere/embed-multilingual-v2.0
      example: '@cf/baai/bge-small-en-v1.5'
      type: string
    vectorize_index-preset-configuration:
      properties:
        preset:
          $ref: '#/components/schemas/vectorize_index-preset'
      required:
      - preset
      type: object
    vectorize_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    vectorize_index-get-vectors-by-id-request:
      properties:
        ids:
          description: A list of vector identifiers to retrieve from the index indicated by the path.
          example:
          - 5121db81354a40c6aedc3fe1ace51c59
          - f90eb49c2107486abdfd78c67e853430
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_create-index-request:
      properties:
        config:
          allOf:
          - $ref: '#/components/schemas/vectorize_index-configuration'
        description:
          $ref: '#/components/schemas/vectorize_index-description'
        name:
          $ref: '#/components/schemas/vectorize_index-name'
      required:
      - name
      - config
      type: object
    vectorize_update-index-request:
      properties:
        description:
          $ref: '#/components/schemas/vectorize_index-description'
      required:
      - description
      type: object
    vectorize_index-query-request:
      properties:
        filter:
          description: A metadata filter expression used to limit nearest neighbor results.
          example:
            has_viewed:
              $ne: true
            streaming_platform: netflix
          type: object
        returnMetadata:
          default: false
          description: Whether to return the metadata associated with the closest vectors.
          type: boolean
        returnValues:
          default: false
          description: Whether to return the values associated with the closest vectors.
          type: boolean
        topK:
          default: 5
          description: The number of nearest neighbors to find.
          example: 5
          type: number
        vector:
          description: The search vector that will be used to find the nearest neighbors.
          example:
          - 0.5
          - 0.5
          - 0.5
          items:
            type: number
          type: array
      required:
      - vector
      type: object
    vectorize_vector-identifier:
      description: Identifier for a Vector
      example: some-vector-id-023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 64
      readOnly: true
      type: string
    vectorize_index-configuration:
      description: Specifies the type of configuration to use for the index.
      oneOf:
      - $ref: '#/components/schemas/vectorize_index-dimension-configuration'
      - $ref: '#/components/schemas/vectorize_index-preset-configuration'
    vectorize_index-upsert-response:
      properties:
        count:
          description: Specifies the count of the vectors successfully inserted.
          example: 768
          type: integer
        ids:
          description: Array of vector identifiers of the vectors successfully inserted.
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true