Support group key response.

typesense · Aug 8, 2023 · 9a20a16 · 9a20a16
1 parent 7aa8800
commit 9a20a16
Show file tree

Hide file tree

Showing 6 changed files with 441 additions and 102 deletions.
diff --git a/typesense/api/client_gen.go b/typesense/api/client_gen.go
diff --git a/typesense/api/generator/generator.yml b/typesense/api/generator/generator.yml
@@ -87,7 +87,7 @@ components:
         - $ref: '#/components/schemas/CollectionSchema'
         - properties:
             created_at:
-              description: Timestamp of when the collection was created
+              description: Timestamp of when the collection was created (Unix epoch in seconds)
               format: int64
               readOnly: true
               type: integer
@@ -216,8 +216,34 @@ components:
         drop:
           example: true
           type: boolean
+        embed:
+          properties:
+            from:
+              items:
+                type: string
+              type: array
+            model_config:
+              properties:
+                access_token:
+                  type: string
+                api_key:
+                  type: string
+                client_id:
+                  type: string
+                client_secret:
+                  type: string
+                model_name:
+                  type: string
+                project_id:
+                  type: string
+              required:
+                - model_name
+              type: object
+          required:
+            - from
+            - model_config
+          type: object
         facet:
-          default: false
           example: false
           type: boolean
         index:
@@ -238,11 +264,9 @@ components:
           example: 256
           type: integer
         optional:
-          default: false
           example: true
           type: boolean
         sort:
-          default: false
           example: true
           type: boolean
         type:
@@ -380,6 +404,10 @@ components:
         prefix:
           description: Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true.
           type: string
+        preset:
+          description: |
+            Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
+          type: string
         prioritize_exact_match:
           description: |
             Set this parameter to true to ensure that an exact match is ranked above the others
@@ -393,6 +421,14 @@ components:
         query_by_weights:
           description: The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma.
           type: string
+        remote_embedding_num_tries:
+          description: |
+            Number of times to retry fetching remote embeddings.
+          type: integer
+        remote_embedding_timeout_ms:
+          description: |
+            Timeout (in milliseconds) for fetching remote embeddings.
+          type: integer
         search_cutoff_ms:
           description: |
             Typesense will attempt to return results early if the cutoff time has elapsed.  This is not a strict guarantee and facet computation is not bound by this parameter.
@@ -446,7 +482,7 @@ components:
       properties:
         group_key:
           items:
-            type: object
+            type: string
           type: array
         hits:
           description: The documents that matched the search query
@@ -696,6 +732,10 @@ components:
         prefix:
           description: Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true.
           type: string
+        preset:
+          description: |
+            Search using a bunch of search parameters by setting this parameter to the name of the existing Preset.
+          type: string
         prioritize_exact_match:
           description: |
             Set this parameter to true to ensure that an exact match is ranked above the others
@@ -713,6 +753,14 @@ components:
         query_by_weights:
           description: The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma.
           type: string
+        remote_embedding_num_tries:
+          description: |
+            Number of times to retry fetching remote embeddings.
+          type: integer
+        remote_embedding_timeout_ms:
+          description: |
+            Timeout (in milliseconds) for fetching remote embeddings.
+          type: integer
         search_cutoff_ms:
           description: |
             Typesense will attempt to return results early if the cutoff time has elapsed.  This is not a strict guarantee and facet computation is not bound by this parameter.
@@ -1447,6 +1495,10 @@ paths:
               - drop
               - reject
             type: string
+        - in: query
+          name: remote_embedding_batch_size
+          schema:
+            type: integer
       requestBody:
         content:
           application/octet-stream:
@@ -1615,6 +1667,10 @@ paths:
           name: prefix
           schema:
             type: string
+        - in: query
+          name: preset
+          schema:
+            type: string
         - in: query
           name: prioritize_exact_match
           schema:
@@ -1637,6 +1693,14 @@ paths:
           name: query_by_weights
           schema:
             type: string
+        - in: query
+          name: remote_embedding_num_tries
+          schema:
+            type: integer
+        - in: query
+          name: remote_embedding_timeout_ms
+          schema:
+            type: integer
         - in: query
           name: search_cutoff_ms
           schema:
@@ -2201,6 +2265,10 @@ paths:
           name: prefix
           schema:
             type: string
+        - in: query
+          name: preset
+          schema:
+            type: string
         - in: query
           name: prioritize_exact_match
           schema:
@@ -2221,6 +2289,14 @@ paths:
           name: query_by_weights
           schema:
             type: string
+        - in: query
+          name: remote_embedding_num_tries
+          schema:
+            type: integer
+        - in: query
+          name: remote_embedding_timeout_ms
+          schema:
+            type: integer
         - in: query
           name: search_cutoff_ms
           schema: