@relevanceai/sdk 1.56.0 → 1.58.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3979,7 +3979,7 @@ export interface components {
3979
3979
  /** @description The model url to use */
3980
3980
  model_url?: string;
3981
3981
  /** @description The model name to use. */
3982
- model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "sentence-transformers";
3982
+ model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
3983
3983
  /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
3984
3984
  body?: string;
3985
3985
  /** @description The document field to encode. */
@@ -4051,7 +4051,7 @@ export interface components {
4051
4051
  /** @description The model url to use */
4052
4052
  model_url?: string;
4053
4053
  /** @description The model name to use. */
4054
- model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "sentence-transformers";
4054
+ model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
4055
4055
  /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
4056
4056
  body?: string;
4057
4057
  /** @description The document field to encode. */
@@ -4777,7 +4777,7 @@ export interface components {
4777
4777
  /** @description The model url to use */
4778
4778
  model_url?: string;
4779
4779
  /** @description The model name to use. */
4780
- model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "sentence-transformers";
4780
+ model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
4781
4781
  /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
4782
4782
  body?: string;
4783
4783
  /** @description The document field to encode. */
@@ -4862,7 +4862,7 @@ export interface components {
4862
4862
  /** @description The model url to use */
4863
4863
  model_url?: string;
4864
4864
  /** @description The model name to use. */
4865
- model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "sentence-transformers";
4865
+ model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
4866
4866
  /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
4867
4867
  body?: string;
4868
4868
  /** @description The document field to encode. */
@@ -7024,6 +7024,19 @@ export interface components {
7024
7024
  * Example: true / false
7025
7025
  */
7026
7026
  includeVectors?: boolean;
7027
+ /**
7028
+ * @description Add _relevance field to each document containing the documents relevance based on the search criteria.
7029
+ *
7030
+ * Example: true
7031
+ * @default true
7032
+ */
7033
+ includeRelevance?: boolean;
7034
+ /**
7035
+ * @description Only return fields of documents listed in this array.
7036
+ *
7037
+ * Example: ["name","description_vector_"]
7038
+ */
7039
+ includeFields?: string[];
7027
7040
  };
7028
7041
  RecommendOutput: {
7029
7042
  /**
@@ -7327,7 +7340,7 @@ export interface components {
7327
7340
  /** @description The model url to use */
7328
7341
  model_url?: string;
7329
7342
  /** @description The model name to use. */
7330
- model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "sentence-transformers";
7343
+ model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
7331
7344
  /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
7332
7345
  body?: string;
7333
7346
  /** @description The document field to encode. */
@@ -7345,7 +7358,7 @@ export interface components {
7345
7358
  /** @description The model url to use */
7346
7359
  model_url?: string;
7347
7360
  /** @description The model name to use. */
7348
- model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "sentence-transformers";
7361
+ model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
7349
7362
  /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
7350
7363
  body?: string;
7351
7364
  /** @description The document field to encode. */
@@ -7372,7 +7385,7 @@ export interface components {
7372
7385
  /** @description The model url to use */
7373
7386
  model_url?: string;
7374
7387
  /** @description The model name to use. */
7375
- model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "sentence-transformers";
7388
+ model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
7376
7389
  /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
7377
7390
  body?: string;
7378
7391
  /** @description The document field to encode. */
@@ -7412,7 +7425,7 @@ export interface components {
7412
7425
  /** @description The model url to use */
7413
7426
  model_url?: string;
7414
7427
  /** @description The model name to use. */
7415
- model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "sentence-transformers";
7428
+ model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
7416
7429
  /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
7417
7430
  body?: string;
7418
7431
  /** @description The document field to encode. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@relevanceai/sdk",
3
- "version": "1.56.0",
3
+ "version": "1.58.0",
4
4
  "description": "Javascript client for RelevanceAI APIs. Browser, Node.js and typescript support.",
5
5
  "main": "./dist-cjs/index.js",
6
6
  "types": "./dist-types/index.d.ts",