update api/manager.yaml

api/manager.yaml

@@ -18,6 +18,8 @@ tags:
   name: Account
 - description: Manage Custom Domains
   name: Custom Domains
+- description: Import Botify Crawl data to KG
+  name: Botify Crawl Imports
 - description: Retrieve Add-ons data
   name: AddOns
 - description: Data URI for a Web page URL.
@@ -35,8 +37,12 @@ tags:
 - description: "Import Analytics data to the KG using different sources, e.g. Google\
     \ Search Console."
   name: Analytics Imports
+- description: Manage vector search nodes embeddings.
+  name: Vector Search Nodes
 - description: Manage redeem codes.
   name: Redeem Codes
+- description: Create vector search queries.
+  name: Vector Search Queries
 - description: The list of included or excluded URLs from the WordPress configuration
   name: Include Excludes (WordPress plugin)
 - description: Manage Accounts
@@ -101,6 +107,12 @@ paths:
         required: false
         schema:
           type: string
+      - description: The dataset id
+        in: query
+        name: ng_dataset_id
+        required: false
+        schema:
+          type: string
       responses:
         "200":
           content:
@@ -403,6 +415,32 @@ paths:
       summary: Create
       tags:
       - Analytics Imports
+  /botify-crawl-imports:
+    post:
+      description: Create a Botify Crawl Import
+      operationId: createBotifyCrawlImport
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/BotifyCrawlImportRequest'
+        required: true
+      responses:
+        "200":
+          content:
+            application/x-ndjson:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/WebPage'
+          description: Success
+        "401":
+          description: Authentication Failure
+      security:
+      - ApiKey: []
+      summary: Create
+      tags:
+      - Botify Crawl Imports
   /data-uri:
     get:
       description: |
@@ -1070,6 +1108,57 @@ paths:
       summary: Validate
       tags:
       - Custom Domains
+  /vector-search/nodes-collection:
+    put:
+      operationId: updateNodesCollection
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: array
+              description: A list of node requests.
+              items:
+                $ref: '#/components/schemas/NodeRequest'
+        required: true
+      responses:
+        "200":
+          description: Found.
+        "401":
+          description: Authentication Failure
+        "404":
+          description: Not Found
+      security:
+      - ApiKey: []
+      summary: Update
+      tags:
+      - Vector Search Nodes
+  /vector-search/queries:
+    put:
+      operationId: createQuery
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/QueryRequest'
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+          description: Found.
+        "401":
+          description: Authentication Failure
+        "404":
+          description: Not Found
+      security:
+      - ApiKey: []
+      summary: Create
+      tags:
+      - Vector Search Queries
 components:
   schemas:
     Account:
@@ -1286,6 +1375,44 @@ components:
             type: string
             description: An array of URLs.
           uniqueItems: true
+    BotifyCrawlImportRequest:
+      type: object
+      description: The Botify Crawl Import request
+      properties:
+        collection:
+          type: string
+        description:
+          type: array
+          items:
+            type: string
+        filters:
+          type: array
+          items:
+            $ref: '#/components/schemas/Filter'
+        headline:
+          type: string
+        limit:
+          type: integer
+          format: int32
+        offset:
+          type: integer
+          format: int32
+        regex:
+          type: string
+        request_embeddings:
+          type: array
+          items:
+            type: string
+        text:
+          type: array
+          items:
+            type: string
+        types:
+          type: array
+          items:
+            type: string
+        url:
+          type: string
     BuildAuthorizeUriRequest:
       type: object
       description: The request of the `buildAuthorizeUri` endpoint.
@@ -1394,6 +1521,33 @@ components:
         token_type:
           type: string
           description: "The token type, usually Bearer"
+    Filter:
+      type: object
+      description: A query request filter.
+      properties:
+        key:
+          type: string
+          description: The filter key.
+        operator:
+          type: string
+          description: A query request filter operator.
+          enum:
+          - EQ
+          - GT
+          - LT
+          - NE
+          - GTE
+          - LTE
+          - IN
+          - NIN
+          - TEXT_MATCH
+        value:
+          type: string
+          description: The filter value.
+      required:
+      - key
+      - operator
+      - value
     IncludeExclude:
       type: object
       properties:
@@ -1761,6 +1915,35 @@ components:
       readOnly: true
       required:
       - datasetUri
+    NodeRequest:
+      type: object
+      description: A node request.
+      properties:
+        embeddings:
+          type: array
+          description: A list of embeddings.
+          items:
+            type: number
+            format: double
+            description: A list of embeddings.
+        entity_id:
+          type: string
+          description: "The entity id in the form on an IRI, e.g. https://data.example.org/dataset/entity."
+        metadata:
+          type: object
+          additionalProperties:
+            type: object
+            description: A map of metadata properties.
+          description: A map of metadata properties.
+        node_id:
+          type: string
+          description: The node id generally expressed in the form of a UUID.
+        text:
+          type: string
+          description: The original text.
+      required:
+      - entity_id
+      - node_id
     OAuth2AuthorizedClient:
       type: object
       description: A OAuth2 Authorized Client
@@ -2139,6 +2322,30 @@ components:
         type:
           type: string
           format: uri
+    QueryRequest:
+      type: object
+      description: A query request.
+      properties:
+        filters:
+          type: array
+          description: A list of prefilters.
+          items:
+            $ref: '#/components/schemas/Filter'
+        query_embedding:
+          type: array
+          description: The list of embeddings.
+          items:
+            type: number
+            format: double
+            description: The list of embeddings.
+        similarity_top_k:
+          type: integer
+          format: int32
+          description: The similarity top K.
+          minimum: 1
+      required:
+      - query_embedding
+      - similarity_top_k
     Request:
       type: object
       properties: