Merge pull request #92 from tharropoulos/v29

Natural language

Author: jasonbosco

openapi.yml

@@ -66,7 +66,12 @@ tags:
     externalDocs:
       description: Find out more
       url: https://typesense.org/docs/28.0/api/stemming.html
-paths:
+  - name: nl_search_models
+    description: Manage NL search models
+    externalDocs:
+      description: Find out more
+      url: https://typesense.org/docs/29.0/api/natural-language-search.html
+
   /collections:
     get:
       tags:
@@ -1734,7 +1739,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/PresetSchema'
         '400':
-          description: Bad request, see error message for details.
+          description: Bad request, see error message for details
           content:
             application/json:
               schema:
@@ -1857,6 +1862,141 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ApiResponse"
+  /nl_search_models:
+    get:
+      tags:
+        - nl_search_models
+      summary: List all NL search models
+      description: Retrieve all NL search models.
+      operationId: retrieveAllNLSearchModels
+      responses:
+        '200':
+          description: List of all NL search models
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/NLSearchModelSchema'
+    post:
+      tags:
+        - nl_search_models
+      summary: Create a NL search model
+      description: Create a new NL search model.
+      operationId: createNLSearchModel
+      requestBody:
+        description: The NL search model to be created
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NLSearchModelCreateSchema'
+        required: true
+      responses:
+        '201':
+          description: NL search model successfully created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NLSearchModelSchema'
+        '400':
+          description: Bad request, see error message for details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiResponse'
+  /nl_search_models/{modelId}:
+    get:
+      tags:
+        - nl_search_models
+      summary: Retrieve a NL search model
+      description: Retrieve a specific NL search model by its ID.
+      operationId: retrieveNLSearchModel
+      parameters:
+        - name: modelId
+          in: path
+          description: The ID of the NL search model to retrieve
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: NL search model fetched
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NLSearchModelSchema'
+        '404':
+          description: NL search model not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiResponse'
+    put:
+      tags:
+        - nl_search_models
+      summary: Update a NL search model
+      description: Update an existing NL search model.
+      operationId: updateNLSearchModel
+      parameters:
+        - name: modelId
+          in: path
+          description: The ID of the NL search model to update
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: The NL search model fields to update
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NLSearchModelUpdateSchema'
+        required: true
+      responses:
+        '200':
+          description: NL search model successfully updated
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NLSearchModelSchema'
+        '400':
+          description: Bad request, see error message for details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiResponse'
+        '404':
+          description: NL search model not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiResponse'
+    delete:
+      tags:
+        - nl_search_models
+      summary: Delete a NL search model
+      description: Delete a specific NL search model by its ID.
+      operationId: deleteNLSearchModel
+      parameters:
+        - name: modelId
+          in: path
+          description: The ID of the NL search model to delete
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: NL search model successfully deleted
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NLSearchModelDeleteSchema'
+        '404':
+          description: NL search model not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiResponse'
+
 components:
   schemas:
     CollectionSchema:
@@ -2631,6 +2771,14 @@ components:
             against. Multiple fields are separated with a comma.
           type: string
 
+        nl_query:
+          description: Whether to use natural language processing to parse the query.
+          type: boolean
+
+        nl_model_id:
+          description: The ID of the natural language model to use.
+          type: string
+
         query_by_weights:
           description:
             The relative weight to give each `query_by` field when ranking results.
@@ -3783,6 +3931,98 @@ components:
                 type: string
                 description: The root form of the word
                 example: person
+    NLSearchModelBase:
+      type: object
+      properties:
+        model_name:
+          type: string
+          description: Name of the NL model to use
+        api_key:
+          type: string
+          description: API key for the NL model service
+        api_url:
+          type: string
+          description: Custom API URL for the NL model service
+        max_bytes:
+          type: integer
+          description: Maximum number of bytes to process
+        temperature:
+          type: number
+          description: Temperature parameter for the NL model
+        system_prompt:
+          type: string
+          description: System prompt for the NL model
+        top_p:
+          type: number
+          description: Top-p parameter for the NL model (Google-specific)
+        top_k:
+          type: integer
+          description: Top-k parameter for the NL model (Google-specific)
+        stop_sequences:
+          type: array
+          items:
+            type: string
+          description: Stop sequences for the NL model (Google-specific)
+        api_version:
+          type: string
+          description: API version for the NL model service
+        project_id:
+          type: string
+          description: Project ID for GCP Vertex AI
+        access_token:
+          type: string
+          description: Access token for GCP Vertex AI
+        refresh_token:
+          type: string
+          description: Refresh token for GCP Vertex AI
+        client_id:
+          type: string
+          description: Client ID for GCP Vertex AI
+        client_secret:
+          type: string
+          description: Client secret for GCP Vertex AI
+        region:
+          type: string
+          description: Region for GCP Vertex AI
+        max_output_tokens:
+          type: integer
+          description: Maximum output tokens for GCP Vertex AI
+        account_id:
+          type: string
+          description: Account ID for Cloudflare-specific models
+
+    NLSearchModelCreateSchema:
+      allOf:
+        - $ref: '#/components/schemas/NLSearchModelBase'
+        - type: object
+          properties:
+            id:
+              type: string
+              description: Optional ID for the NL search model
+
+    NLSearchModelSchema:
+      allOf:
+        - $ref: '#/components/schemas/NLSearchModelCreateSchema'
+        - type: object
+          required:
+            - id
+          properties:
+            id:
+              type: string
+              description: ID of the NL search model
+
+    NLSearchModelUpdateSchema:
+      $ref: '#/components/schemas/NLSearchModelCreateSchema'
+
+    NLSearchModelDeleteSchema:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          description: ID of the deleted NL search model
+
   securitySchemes:
     api_key_header:
       type: apiKey