@mentio-dev/sdk 0.11.1 → 0.11.2
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.ts +26 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -454,6 +454,10 @@ type Keyword = {
|
|
|
454
454
|
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
455
455
|
*/
|
|
456
456
|
caseSensitive: boolean;
|
|
457
|
+
/**
|
|
458
|
+
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
459
|
+
*/
|
|
460
|
+
exactPhrase: boolean;
|
|
457
461
|
};
|
|
458
462
|
/**
|
|
459
463
|
* Computed over this workspace's matches.
|
|
@@ -641,6 +645,10 @@ type KeywordSuggestion = {
|
|
|
641
645
|
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
642
646
|
*/
|
|
643
647
|
caseSensitive?: boolean;
|
|
648
|
+
/**
|
|
649
|
+
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
650
|
+
*/
|
|
651
|
+
exactPhrase?: boolean;
|
|
644
652
|
};
|
|
645
653
|
/**
|
|
646
654
|
* Replaces the monthly mention cap; null removes it. A cap above this month's count resumes a capped keyword at once, one at or under it pauses it.
|
|
@@ -997,7 +1005,7 @@ type Mention = {
|
|
|
997
1005
|
*/
|
|
998
1006
|
priority: number;
|
|
999
1007
|
/**
|
|
1000
|
-
* The keyword this post matched,
|
|
1008
|
+
* The keyword this post matched, the group it is in, and how it matched.
|
|
1001
1009
|
*/
|
|
1002
1010
|
keyword: {
|
|
1003
1011
|
/**
|
|
@@ -1009,6 +1017,10 @@ type Mention = {
|
|
|
1009
1017
|
*/
|
|
1010
1018
|
term: string;
|
|
1011
1019
|
group: GroupRef;
|
|
1020
|
+
/**
|
|
1021
|
+
* phrase: the post holds the term as written. close_words: it holds the term's words close together, in another order or form (kept and billed only because the classifier scored it relevant).
|
|
1022
|
+
*/
|
|
1023
|
+
matchedAs: 'phrase' | 'close_words';
|
|
1012
1024
|
};
|
|
1013
1025
|
post: {
|
|
1014
1026
|
/**
|
|
@@ -4008,6 +4020,10 @@ type ListKeywordsResponses = {
|
|
|
4008
4020
|
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
4009
4021
|
*/
|
|
4010
4022
|
caseSensitive: boolean;
|
|
4023
|
+
/**
|
|
4024
|
+
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
4025
|
+
*/
|
|
4026
|
+
exactPhrase: boolean;
|
|
4011
4027
|
};
|
|
4012
4028
|
/**
|
|
4013
4029
|
* Computed over this workspace's matches.
|
|
@@ -4125,7 +4141,7 @@ type ListKeywordsResponse = ListKeywordsResponses[keyof ListKeywordsResponses];
|
|
|
4125
4141
|
type CreateKeywordData = {
|
|
4126
4142
|
body: {
|
|
4127
4143
|
/**
|
|
4128
|
-
* The word or phrase to track,
|
|
4144
|
+
* The word or phrase to track, case-insensitive. A multi-word term matches as the phrase or as its words close together (see matching.exactPhrase); wrap it in double quotes for the exact phrase only.
|
|
4129
4145
|
*/
|
|
4130
4146
|
term: string;
|
|
4131
4147
|
/**
|
|
@@ -4164,6 +4180,10 @@ type CreateKeywordData = {
|
|
|
4164
4180
|
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
4165
4181
|
*/
|
|
4166
4182
|
caseSensitive?: boolean;
|
|
4183
|
+
/**
|
|
4184
|
+
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
4185
|
+
*/
|
|
4186
|
+
exactPhrase?: boolean;
|
|
4167
4187
|
};
|
|
4168
4188
|
/**
|
|
4169
4189
|
* A monthly mention cap; omit or null for none.
|
|
@@ -4333,6 +4353,10 @@ type UpdateKeywordData = {
|
|
|
4333
4353
|
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
4334
4354
|
*/
|
|
4335
4355
|
caseSensitive?: boolean;
|
|
4356
|
+
/**
|
|
4357
|
+
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
4358
|
+
*/
|
|
4359
|
+
exactPhrase?: boolean;
|
|
4336
4360
|
};
|
|
4337
4361
|
/**
|
|
4338
4362
|
* Replaces the monthly mention cap; null removes it. A cap above this month's count resumes a capped keyword at once, one at or under it pauses it.
|