@semantha/sdk 11.2.1 → 11.3.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.
package/dist/index.d.mts CHANGED
@@ -1803,6 +1803,7 @@ declare class AnswersEndpoint {
1803
1803
  * @param maximagereferences number? - Maximum number of returned image references.
1804
1804
  * @param maxanswerreferences number? - Limits the number of references used to answer the question.
1805
1805
  * @param similaritythreshold number? - Threshold used to find matches in library
1806
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
1806
1807
  * @param language string? - The language for the answer text.
1807
1808
  * Supported Languages:
1808
1809
  * "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
@@ -1816,6 +1817,7 @@ declare class AnswersEndpoint {
1816
1817
  maximagereferences?: number;
1817
1818
  maxanswerreferences?: number;
1818
1819
  similaritythreshold?: number;
1820
+ imagesimilaritythreshold?: number;
1819
1821
  language?: string;
1820
1822
  tags?: string;
1821
1823
  }): Promise<Answer>;
@@ -2258,6 +2260,7 @@ declare class BulkdomainsReferencesEndpoint {
2258
2260
  tags?: string;
2259
2261
  documentclassids?: string;
2260
2262
  similaritythreshold?: number;
2263
+ imagesimilaritythreshold?: number;
2261
2264
  synonymousthreshold?: number;
2262
2265
  marknomatch?: boolean;
2263
2266
  withreferencetext?: boolean;
@@ -3530,6 +3533,7 @@ declare class ReferencesEndpoint {
3530
3533
  * Each value can be either the documentclass UUID `id` or its numeric `shortId`; numeric values are resolved server-side to the matching documentclass UUID. UUIDs and shortIds may be mixed in the same request.
3531
3534
  * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
3532
3535
  * In general, the higher the threshold, the more precise the results.
3536
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
3533
3537
  * @param synonymousthreshold number? - Threshold for good matches.
3534
3538
  * @param marknomatch boolean? - Marks the paragraphs that have not matched
3535
3539
  * @param withreferencetext boolean? - Provide the reference text in the result JSON. If set to false, you have to query the library to resolve the references yourself.
@@ -3555,6 +3559,7 @@ declare class ReferencesEndpoint {
3555
3559
  tags?: string;
3556
3560
  documentclassids?: string[];
3557
3561
  similaritythreshold?: number;
3562
+ imagesimilaritythreshold?: number;
3558
3563
  synonymousthreshold?: number;
3559
3564
  marknomatch?: boolean;
3560
3565
  withreferencetext?: boolean;
@@ -3586,6 +3591,7 @@ declare class ReferencesEndpoint {
3586
3591
  * Each value can be either the documentclass UUID `id` or its numeric `shortId`; numeric values are resolved server-side to the matching documentclass UUID. UUIDs and shortIds may be mixed in the same request.
3587
3592
  * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
3588
3593
  * In general, the higher the threshold, the more precise the results.
3594
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
3589
3595
  * @param synonymousthreshold number? - Threshold for good matches.
3590
3596
  * @param marknomatch boolean? - Marks the paragraphs that have not matched
3591
3597
  * @param withreferencetext boolean? - Provide the reference text in the result JSON. If set to false, you have to query the library to resolve the references yourself.
@@ -3611,6 +3617,7 @@ declare class ReferencesEndpoint {
3611
3617
  tags?: string;
3612
3618
  documentclassids?: string[];
3613
3619
  similaritythreshold?: number;
3620
+ imagesimilaritythreshold?: number;
3614
3621
  synonymousthreshold?: number;
3615
3622
  marknomatch?: boolean;
3616
3623
  withreferencetext?: boolean;
@@ -3642,6 +3649,7 @@ declare class ReferencesEndpoint {
3642
3649
  * Each value can be either the documentclass UUID `id` or its numeric `shortId`; numeric values are resolved server-side to the matching documentclass UUID. UUIDs and shortIds may be mixed in the same request.
3643
3650
  * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
3644
3651
  * In general, the higher the threshold, the more precise the results.
3652
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
3645
3653
  * @param synonymousthreshold number? - Threshold for good matches.
3646
3654
  * @param marknomatch boolean? - Marks the paragraphs that have not matched
3647
3655
  * @param withreferencetext boolean? - Provide the reference text in the result JSON. If set to false, you have to query the library to resolve the references yourself.
@@ -3667,6 +3675,7 @@ declare class ReferencesEndpoint {
3667
3675
  tags?: string;
3668
3676
  documentclassids?: string[];
3669
3677
  similaritythreshold?: number;
3678
+ imagesimilaritythreshold?: number;
3670
3679
  synonymousthreshold?: number;
3671
3680
  marknomatch?: boolean;
3672
3681
  withreferencetext?: boolean;
@@ -3698,6 +3707,7 @@ declare class ReferencesEndpoint {
3698
3707
  * Each value can be either the documentclass UUID `id` or its numeric `shortId`; numeric values are resolved server-side to the matching documentclass UUID. UUIDs and shortIds may be mixed in the same request.
3699
3708
  * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
3700
3709
  * In general, the higher the threshold, the more precise the results.
3710
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
3701
3711
  * @param synonymousthreshold number? - Threshold for good matches.
3702
3712
  * @param marknomatch boolean? - Marks the paragraphs that have not matched
3703
3713
  * @param withreferencetext boolean? - Provide the reference text in the result JSON. If set to false, you have to query the library to resolve the references yourself.
@@ -3723,6 +3733,7 @@ declare class ReferencesEndpoint {
3723
3733
  tags?: string;
3724
3734
  documentclassids?: string[];
3725
3735
  similaritythreshold?: number;
3736
+ imagesimilaritythreshold?: number;
3726
3737
  synonymousthreshold?: number;
3727
3738
  marknomatch?: boolean;
3728
3739
  withreferencetext?: boolean;
package/dist/index.d.ts CHANGED
@@ -1803,6 +1803,7 @@ declare class AnswersEndpoint {
1803
1803
  * @param maximagereferences number? - Maximum number of returned image references.
1804
1804
  * @param maxanswerreferences number? - Limits the number of references used to answer the question.
1805
1805
  * @param similaritythreshold number? - Threshold used to find matches in library
1806
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
1806
1807
  * @param language string? - The language for the answer text.
1807
1808
  * Supported Languages:
1808
1809
  * "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
@@ -1816,6 +1817,7 @@ declare class AnswersEndpoint {
1816
1817
  maximagereferences?: number;
1817
1818
  maxanswerreferences?: number;
1818
1819
  similaritythreshold?: number;
1820
+ imagesimilaritythreshold?: number;
1819
1821
  language?: string;
1820
1822
  tags?: string;
1821
1823
  }): Promise<Answer>;
@@ -2258,6 +2260,7 @@ declare class BulkdomainsReferencesEndpoint {
2258
2260
  tags?: string;
2259
2261
  documentclassids?: string;
2260
2262
  similaritythreshold?: number;
2263
+ imagesimilaritythreshold?: number;
2261
2264
  synonymousthreshold?: number;
2262
2265
  marknomatch?: boolean;
2263
2266
  withreferencetext?: boolean;
@@ -3530,6 +3533,7 @@ declare class ReferencesEndpoint {
3530
3533
  * Each value can be either the documentclass UUID `id` or its numeric `shortId`; numeric values are resolved server-side to the matching documentclass UUID. UUIDs and shortIds may be mixed in the same request.
3531
3534
  * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
3532
3535
  * In general, the higher the threshold, the more precise the results.
3536
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
3533
3537
  * @param synonymousthreshold number? - Threshold for good matches.
3534
3538
  * @param marknomatch boolean? - Marks the paragraphs that have not matched
3535
3539
  * @param withreferencetext boolean? - Provide the reference text in the result JSON. If set to false, you have to query the library to resolve the references yourself.
@@ -3555,6 +3559,7 @@ declare class ReferencesEndpoint {
3555
3559
  tags?: string;
3556
3560
  documentclassids?: string[];
3557
3561
  similaritythreshold?: number;
3562
+ imagesimilaritythreshold?: number;
3558
3563
  synonymousthreshold?: number;
3559
3564
  marknomatch?: boolean;
3560
3565
  withreferencetext?: boolean;
@@ -3586,6 +3591,7 @@ declare class ReferencesEndpoint {
3586
3591
  * Each value can be either the documentclass UUID `id` or its numeric `shortId`; numeric values are resolved server-side to the matching documentclass UUID. UUIDs and shortIds may be mixed in the same request.
3587
3592
  * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
3588
3593
  * In general, the higher the threshold, the more precise the results.
3594
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
3589
3595
  * @param synonymousthreshold number? - Threshold for good matches.
3590
3596
  * @param marknomatch boolean? - Marks the paragraphs that have not matched
3591
3597
  * @param withreferencetext boolean? - Provide the reference text in the result JSON. If set to false, you have to query the library to resolve the references yourself.
@@ -3611,6 +3617,7 @@ declare class ReferencesEndpoint {
3611
3617
  tags?: string;
3612
3618
  documentclassids?: string[];
3613
3619
  similaritythreshold?: number;
3620
+ imagesimilaritythreshold?: number;
3614
3621
  synonymousthreshold?: number;
3615
3622
  marknomatch?: boolean;
3616
3623
  withreferencetext?: boolean;
@@ -3642,6 +3649,7 @@ declare class ReferencesEndpoint {
3642
3649
  * Each value can be either the documentclass UUID `id` or its numeric `shortId`; numeric values are resolved server-side to the matching documentclass UUID. UUIDs and shortIds may be mixed in the same request.
3643
3650
  * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
3644
3651
  * In general, the higher the threshold, the more precise the results.
3652
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
3645
3653
  * @param synonymousthreshold number? - Threshold for good matches.
3646
3654
  * @param marknomatch boolean? - Marks the paragraphs that have not matched
3647
3655
  * @param withreferencetext boolean? - Provide the reference text in the result JSON. If set to false, you have to query the library to resolve the references yourself.
@@ -3667,6 +3675,7 @@ declare class ReferencesEndpoint {
3667
3675
  tags?: string;
3668
3676
  documentclassids?: string[];
3669
3677
  similaritythreshold?: number;
3678
+ imagesimilaritythreshold?: number;
3670
3679
  synonymousthreshold?: number;
3671
3680
  marknomatch?: boolean;
3672
3681
  withreferencetext?: boolean;
@@ -3698,6 +3707,7 @@ declare class ReferencesEndpoint {
3698
3707
  * Each value can be either the documentclass UUID `id` or its numeric `shortId`; numeric values are resolved server-side to the matching documentclass UUID. UUIDs and shortIds may be mixed in the same request.
3699
3708
  * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
3700
3709
  * In general, the higher the threshold, the more precise the results.
3710
+ * @param imagesimilaritythreshold number? - Threshold for the similarity score of image references. semantha will not deliver image references with a score lower than the threshold. If not provided, the value of the 'similaritythreshold' parameter is used.
3701
3711
  * @param synonymousthreshold number? - Threshold for good matches.
3702
3712
  * @param marknomatch boolean? - Marks the paragraphs that have not matched
3703
3713
  * @param withreferencetext boolean? - Provide the reference text in the result JSON. If set to false, you have to query the library to resolve the references yourself.
@@ -3723,6 +3733,7 @@ declare class ReferencesEndpoint {
3723
3733
  tags?: string;
3724
3734
  documentclassids?: string[];
3725
3735
  similaritythreshold?: number;
3736
+ imagesimilaritythreshold?: number;
3726
3737
  synonymousthreshold?: number;
3727
3738
  marknomatch?: boolean;
3728
3739
  withreferencetext?: boolean;