profoundai 0.35.1 → 0.37.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/CHANGELOG.md +48 -0
- package/client.d.mts +13 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +13 -2
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/logs/raw.d.mts +1 -17
- package/resources/logs/raw.d.mts.map +1 -1
- package/resources/logs/raw.d.ts +1 -17
- package/resources/logs/raw.d.ts.map +1 -1
- package/resources/organizations/categories.d.mts +40 -3
- package/resources/organizations/categories.d.mts.map +1 -1
- package/resources/organizations/categories.d.ts +40 -3
- package/resources/organizations/categories.d.ts.map +1 -1
- package/resources/organizations/categories.js +4 -3
- package/resources/organizations/categories.js.map +1 -1
- package/resources/organizations/categories.mjs +4 -3
- package/resources/organizations/categories.mjs.map +1 -1
- package/resources/prompt-volumes.d.mts +112 -0
- package/resources/prompt-volumes.d.mts.map +1 -0
- package/resources/prompt-volumes.d.ts +112 -0
- package/resources/prompt-volumes.d.ts.map +1 -0
- package/resources/prompt-volumes.js +21 -0
- package/resources/prompt-volumes.js.map +1 -0
- package/resources/prompt-volumes.mjs +17 -0
- package/resources/prompt-volumes.mjs.map +1 -0
- package/resources/prompts.d.mts +1 -46
- package/resources/prompts.d.mts.map +1 -1
- package/resources/prompts.d.ts +1 -46
- package/resources/prompts.d.ts.map +1 -1
- package/resources/reports.d.mts +247 -139
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +247 -139
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +68 -0
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +68 -0
- package/resources/reports.mjs.map +1 -1
- package/resources/shared.d.mts +76 -0
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +76 -0
- package/resources/shared.d.ts.map +1 -1
- package/src/client.ts +33 -0
- package/src/resources/index.ts +11 -0
- package/src/resources/logs/raw.ts +2 -136
- package/src/resources/organizations/categories.ts +46 -3
- package/src/resources/prompt-volumes.ts +203 -0
- package/src/resources/prompts.ts +6 -78
- package/src/resources/reports.ts +368 -280
- package/src/resources/shared.ts +221 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/prompts.d.mts
CHANGED
|
@@ -58,7 +58,7 @@ export interface PromptAnswersParams {
|
|
|
58
58
|
/**
|
|
59
59
|
* List of filters to apply to the answers report.
|
|
60
60
|
*/
|
|
61
|
-
filters?: Array<
|
|
61
|
+
filters?: Array<Shared.RegionIDFilter | Shared.ModelIDFilter | Shared.TagIDFilter | Shared.PromptTypeFilter | Shared.PromptFilter | Shared.PersonaIDFilter | Shared.TopicIDFilter | PromptAnswersParams.AssetIDFilter | Shared.AssetNameFilter>;
|
|
62
62
|
include?: PromptAnswersParams.Include;
|
|
63
63
|
/**
|
|
64
64
|
* Pagination parameters for the results. Default is 10,000 rows with no offset.
|
|
@@ -66,51 +66,6 @@ export interface PromptAnswersParams {
|
|
|
66
66
|
pagination?: Shared.Pagination;
|
|
67
67
|
}
|
|
68
68
|
export declare namespace PromptAnswersParams {
|
|
69
|
-
interface ProfoundAnswerEngineInsightsFiltersRegionIDFilter {
|
|
70
|
-
/**
|
|
71
|
-
* - `region` - Deprecated
|
|
72
|
-
*/
|
|
73
|
-
field: 'region_id' | 'region';
|
|
74
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
75
|
-
value: string | Array<string>;
|
|
76
|
-
}
|
|
77
|
-
interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
|
|
78
|
-
/**
|
|
79
|
-
* - `model` - Deprecated
|
|
80
|
-
*/
|
|
81
|
-
field: 'model_id' | 'model';
|
|
82
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
83
|
-
value: string | Array<string>;
|
|
84
|
-
}
|
|
85
|
-
interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
|
|
86
|
-
/**
|
|
87
|
-
* - `tag` - Deprecated
|
|
88
|
-
*/
|
|
89
|
-
field: 'tag_id' | 'tag';
|
|
90
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
91
|
-
value: string | Array<string>;
|
|
92
|
-
}
|
|
93
|
-
/**
|
|
94
|
-
* Filter by prompt type (visibility or sentiment)
|
|
95
|
-
*/
|
|
96
|
-
interface ProfoundAnswerEngineInsightsFiltersPromptTypeFilter {
|
|
97
|
-
field: 'prompt_type';
|
|
98
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
99
|
-
value: 'visibility' | 'sentiment' | Array<'visibility' | 'sentiment'>;
|
|
100
|
-
}
|
|
101
|
-
interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
|
|
102
|
-
field: 'persona_id';
|
|
103
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
104
|
-
value: string | Array<string>;
|
|
105
|
-
}
|
|
106
|
-
interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
|
|
107
|
-
/**
|
|
108
|
-
* - `topic` - Deprecated
|
|
109
|
-
*/
|
|
110
|
-
field: 'topic_id' | 'topic';
|
|
111
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
112
|
-
value: string | Array<string>;
|
|
113
|
-
}
|
|
114
69
|
interface AssetIDFilter {
|
|
115
70
|
field: 'asset_id';
|
|
116
71
|
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prompts.d.mts","sourceRoot":"","sources":["../src/resources/prompts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAExC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEhC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC,gBAAgB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;QAErD,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE5B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE9B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,cAAc;YAC7B,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;SAC/B;KACF;IAED,UAAiB,IAAI;QACnB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IAEpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,
|
|
1
|
+
{"version":3,"file":"prompts.d.mts","sourceRoot":"","sources":["../src/resources/prompts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAExC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEhC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC,gBAAgB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;QAErD,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE5B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE9B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,cAAc;YAC7B,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;SAC/B;KACF;IAED,UAAiB,IAAI;QACnB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IAEpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,CAAC,cAAc,GACrB,MAAM,CAAC,aAAa,GACpB,MAAM,CAAC,WAAW,GAClB,MAAM,CAAC,gBAAgB,GACvB,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,eAAe,GACtB,MAAM,CAAC,aAAa,GACpB,mBAAmB,CAAC,aAAa,GACjC,MAAM,CAAC,eAAe,CACzB,CAAC;IAEF,OAAO,CAAC,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,aAAa;QAC5B,KAAK,EAAE,UAAU,CAAC;QAElB,QAAQ,EAAE,IAAI,GAAG,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAAC;QAE5C,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;KAC/B;IAED,UAAiB,OAAO;QACtB,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
package/resources/prompts.d.ts
CHANGED
|
@@ -58,7 +58,7 @@ export interface PromptAnswersParams {
|
|
|
58
58
|
/**
|
|
59
59
|
* List of filters to apply to the answers report.
|
|
60
60
|
*/
|
|
61
|
-
filters?: Array<
|
|
61
|
+
filters?: Array<Shared.RegionIDFilter | Shared.ModelIDFilter | Shared.TagIDFilter | Shared.PromptTypeFilter | Shared.PromptFilter | Shared.PersonaIDFilter | Shared.TopicIDFilter | PromptAnswersParams.AssetIDFilter | Shared.AssetNameFilter>;
|
|
62
62
|
include?: PromptAnswersParams.Include;
|
|
63
63
|
/**
|
|
64
64
|
* Pagination parameters for the results. Default is 10,000 rows with no offset.
|
|
@@ -66,51 +66,6 @@ export interface PromptAnswersParams {
|
|
|
66
66
|
pagination?: Shared.Pagination;
|
|
67
67
|
}
|
|
68
68
|
export declare namespace PromptAnswersParams {
|
|
69
|
-
interface ProfoundAnswerEngineInsightsFiltersRegionIDFilter {
|
|
70
|
-
/**
|
|
71
|
-
* - `region` - Deprecated
|
|
72
|
-
*/
|
|
73
|
-
field: 'region_id' | 'region';
|
|
74
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
75
|
-
value: string | Array<string>;
|
|
76
|
-
}
|
|
77
|
-
interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
|
|
78
|
-
/**
|
|
79
|
-
* - `model` - Deprecated
|
|
80
|
-
*/
|
|
81
|
-
field: 'model_id' | 'model';
|
|
82
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
83
|
-
value: string | Array<string>;
|
|
84
|
-
}
|
|
85
|
-
interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
|
|
86
|
-
/**
|
|
87
|
-
* - `tag` - Deprecated
|
|
88
|
-
*/
|
|
89
|
-
field: 'tag_id' | 'tag';
|
|
90
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
91
|
-
value: string | Array<string>;
|
|
92
|
-
}
|
|
93
|
-
/**
|
|
94
|
-
* Filter by prompt type (visibility or sentiment)
|
|
95
|
-
*/
|
|
96
|
-
interface ProfoundAnswerEngineInsightsFiltersPromptTypeFilter {
|
|
97
|
-
field: 'prompt_type';
|
|
98
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
99
|
-
value: 'visibility' | 'sentiment' | Array<'visibility' | 'sentiment'>;
|
|
100
|
-
}
|
|
101
|
-
interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
|
|
102
|
-
field: 'persona_id';
|
|
103
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
104
|
-
value: string | Array<string>;
|
|
105
|
-
}
|
|
106
|
-
interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
|
|
107
|
-
/**
|
|
108
|
-
* - `topic` - Deprecated
|
|
109
|
-
*/
|
|
110
|
-
field: 'topic_id' | 'topic';
|
|
111
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
112
|
-
value: string | Array<string>;
|
|
113
|
-
}
|
|
114
69
|
interface AssetIDFilter {
|
|
115
70
|
field: 'asset_id';
|
|
116
71
|
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../src/resources/prompts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAExC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEhC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC,gBAAgB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;QAErD,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE5B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE9B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,cAAc;YAC7B,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;SAC/B;KACF;IAED,UAAiB,IAAI;QACnB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IAEpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,
|
|
1
|
+
{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../src/resources/prompts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAExC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEhC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC,gBAAgB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;QAErD,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE5B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE9B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,cAAc;YAC7B,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;SAC/B;KACF;IAED,UAAiB,IAAI;QACnB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IAEpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,CAAC,cAAc,GACrB,MAAM,CAAC,aAAa,GACpB,MAAM,CAAC,WAAW,GAClB,MAAM,CAAC,gBAAgB,GACvB,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,eAAe,GACtB,MAAM,CAAC,aAAa,GACpB,mBAAmB,CAAC,aAAa,GACjC,MAAM,CAAC,eAAe,CACzB,CAAC;IAEF,OAAO,CAAC,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,aAAa;QAC5B,KAAK,EAAE,UAAU,CAAC;QAElB,QAAQ,EAAE,IAAI,GAAG,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAAC;QAE5C,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;KAC/B;IAED,UAAiB,OAAO;QACtB,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
package/resources/reports.d.mts
CHANGED
|
@@ -41,6 +41,36 @@ export declare class Reports extends APIResource {
|
|
|
41
41
|
* ```
|
|
42
42
|
*/
|
|
43
43
|
getBotsReport(body: ReportGetBotsReportParams, options?: RequestOptions): APIPromise<ReportResponse>;
|
|
44
|
+
/**
|
|
45
|
+
* Get bot traffic report from the hourly aggregated materialized view (UTC-based).
|
|
46
|
+
*
|
|
47
|
+
* Supports date_interval="day" (default, UTC daily buckets) or "hour" (UTC hourly
|
|
48
|
+
* buckets).
|
|
49
|
+
*
|
|
50
|
+
* Metrics:
|
|
51
|
+
*
|
|
52
|
+
* - count: unique bot visits
|
|
53
|
+
* - citations: unique citation events (ai_assistant bot type)
|
|
54
|
+
* - indexing: unique indexing events (index bot type)
|
|
55
|
+
* - training: unique training events (ai_training bot type)
|
|
56
|
+
* - last_visit: most recent visit timestamp
|
|
57
|
+
*
|
|
58
|
+
* Dimensions:
|
|
59
|
+
*
|
|
60
|
+
* - date, path, bot_name, bot_provider, bot_type
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const reportResponse = await client.reports.getBotsReportV2(
|
|
65
|
+
* {
|
|
66
|
+
* domain: 'domain',
|
|
67
|
+
* metrics: ['count'],
|
|
68
|
+
* start_date: '2019-12-27T18:11:19.117Z',
|
|
69
|
+
* },
|
|
70
|
+
* );
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
getBotsReportV2(body: ReportGetBotsReportV2Params, options?: RequestOptions): APIPromise<ReportResponse>;
|
|
44
74
|
/**
|
|
45
75
|
* Get referral traffic report from the daily aggregated materialized view.
|
|
46
76
|
*
|
|
@@ -58,6 +88,38 @@ export declare class Reports extends APIResource {
|
|
|
58
88
|
* ```
|
|
59
89
|
*/
|
|
60
90
|
getReferralsReport(body: ReportGetReferralsReportParams, options?: RequestOptions): APIPromise<ReportResponse>;
|
|
91
|
+
/**
|
|
92
|
+
* Get referral traffic report from the hourly aggregated materialized view
|
|
93
|
+
* (UTC-based).
|
|
94
|
+
*
|
|
95
|
+
* Supports date_interval="day" (default, UTC daily buckets) or "hour" (UTC hourly
|
|
96
|
+
* buckets).
|
|
97
|
+
*
|
|
98
|
+
* @example
|
|
99
|
+
* ```ts
|
|
100
|
+
* const reportResponse =
|
|
101
|
+
* await client.reports.getReferralsReportV2({
|
|
102
|
+
* domain: 'domain',
|
|
103
|
+
* metrics: ['visits'],
|
|
104
|
+
* start_date: '2019-12-27T18:11:19.117Z',
|
|
105
|
+
* });
|
|
106
|
+
* ```
|
|
107
|
+
*/
|
|
108
|
+
getReferralsReportV2(body: ReportGetReferralsReportV2Params, options?: RequestOptions): APIPromise<ReportResponse>;
|
|
109
|
+
/**
|
|
110
|
+
* Query Fanouts
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* ```ts
|
|
114
|
+
* const reportResponse = await client.reports.queryFanouts({
|
|
115
|
+
* category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
116
|
+
* end_date: '2019-12-27T18:11:19.117Z',
|
|
117
|
+
* metrics: ['fanouts_per_execution'],
|
|
118
|
+
* start_date: '2019-12-27T18:11:19.117Z',
|
|
119
|
+
* });
|
|
120
|
+
* ```
|
|
121
|
+
*/
|
|
122
|
+
queryFanouts(body: ReportQueryFanoutsParams, options?: RequestOptions): APIPromise<ReportResponse>;
|
|
61
123
|
/**
|
|
62
124
|
* Get citations for a given category.
|
|
63
125
|
*
|
|
@@ -87,6 +149,14 @@ export declare class Reports extends APIResource {
|
|
|
87
149
|
*/
|
|
88
150
|
visibility(body: ReportVisibilityParams, options?: RequestOptions): APIPromise<ReportResponse>;
|
|
89
151
|
}
|
|
152
|
+
/**
|
|
153
|
+
* Filter by prompt UUID.
|
|
154
|
+
*/
|
|
155
|
+
export interface PromptIDFilter {
|
|
156
|
+
field: 'prompt_id';
|
|
157
|
+
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
158
|
+
value: string | Array<string>;
|
|
159
|
+
}
|
|
90
160
|
/**
|
|
91
161
|
* Base model for report information.
|
|
92
162
|
*/
|
|
@@ -156,7 +226,7 @@ export interface ReportCitationsParams {
|
|
|
156
226
|
/**
|
|
157
227
|
* List of filters to apply to the citations report.
|
|
158
228
|
*/
|
|
159
|
-
filters?: Array<ReportCitationsParams.HostnameFilter | Shared.PathFilter |
|
|
229
|
+
filters?: Array<ReportCitationsParams.HostnameFilter | Shared.PathFilter | Shared.RegionIDFilter | Shared.TopicIDFilter | TopicNameFilter | Shared.ModelIDFilter | Shared.TagIDFilter | ReportCitationsParams.TagNameFilter | ReportCitationsParams.URLFilter | ReportCitationsParams.RootDomainFilter | Shared.PromptTypeFilter | Shared.PersonaIDFilter | ReportCitationsParams.CitationCategoryFilter | Shared.PromptFilter | PromptIDFilter>;
|
|
160
230
|
/**
|
|
161
231
|
* Custom ordering of the report results.
|
|
162
232
|
*
|
|
@@ -183,36 +253,12 @@ export declare namespace ReportCitationsParams {
|
|
|
183
253
|
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
184
254
|
value: string | Array<string>;
|
|
185
255
|
}
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
field: '
|
|
191
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
192
|
-
value: string | Array<string>;
|
|
193
|
-
}
|
|
194
|
-
interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
|
|
195
|
-
/**
|
|
196
|
-
* - `topic` - Deprecated
|
|
197
|
-
*/
|
|
198
|
-
field: 'topic_id' | 'topic';
|
|
199
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
200
|
-
value: string | Array<string>;
|
|
201
|
-
}
|
|
202
|
-
interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
|
|
203
|
-
/**
|
|
204
|
-
* - `model` - Deprecated
|
|
205
|
-
*/
|
|
206
|
-
field: 'model_id' | 'model';
|
|
207
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
208
|
-
value: string | Array<string>;
|
|
209
|
-
}
|
|
210
|
-
interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
|
|
211
|
-
/**
|
|
212
|
-
* - `tag` - Deprecated
|
|
213
|
-
*/
|
|
214
|
-
field: 'tag_id' | 'tag';
|
|
215
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
256
|
+
/**
|
|
257
|
+
* Filter by tag name.
|
|
258
|
+
*/
|
|
259
|
+
interface TagNameFilter {
|
|
260
|
+
field: 'tag_name';
|
|
261
|
+
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
216
262
|
value: string | Array<string>;
|
|
217
263
|
}
|
|
218
264
|
/**
|
|
@@ -231,19 +277,6 @@ export declare namespace ReportCitationsParams {
|
|
|
231
277
|
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
232
278
|
value: string | Array<string>;
|
|
233
279
|
}
|
|
234
|
-
/**
|
|
235
|
-
* Filter by prompt type (visibility or sentiment)
|
|
236
|
-
*/
|
|
237
|
-
interface ProfoundAnswerEngineInsightsFiltersPromptTypeFilter {
|
|
238
|
-
field: 'prompt_type';
|
|
239
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
240
|
-
value: 'visibility' | 'sentiment' | Array<'visibility' | 'sentiment'>;
|
|
241
|
-
}
|
|
242
|
-
interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
|
|
243
|
-
field: 'persona_id';
|
|
244
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
245
|
-
value: string | Array<string>;
|
|
246
|
-
}
|
|
247
280
|
/**
|
|
248
281
|
* Filter by citation category
|
|
249
282
|
*/
|
|
@@ -252,11 +285,6 @@ export declare namespace ReportCitationsParams {
|
|
|
252
285
|
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
253
286
|
value: string | Array<string>;
|
|
254
287
|
}
|
|
255
|
-
interface ProfoundAnswerEngineInsightsFiltersPromptIDFilter {
|
|
256
|
-
field: 'prompt_id';
|
|
257
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
258
|
-
value: string | Array<string>;
|
|
259
|
-
}
|
|
260
288
|
}
|
|
261
289
|
export interface ReportGetBotsReportParams {
|
|
262
290
|
/**
|
|
@@ -285,7 +313,7 @@ export interface ReportGetBotsReportParams {
|
|
|
285
313
|
/**
|
|
286
314
|
* Filters for bots report.
|
|
287
315
|
*/
|
|
288
|
-
filters?: Array<Shared.PathFilter |
|
|
316
|
+
filters?: Array<Shared.PathFilter | Shared.BotNameFilter | Shared.BotProviderFilter>;
|
|
289
317
|
/**
|
|
290
318
|
* Custom ordering of the report results.
|
|
291
319
|
*
|
|
@@ -307,22 +335,63 @@ export interface ReportGetBotsReportParams {
|
|
|
307
335
|
*/
|
|
308
336
|
pagination?: Shared.Pagination;
|
|
309
337
|
}
|
|
310
|
-
export
|
|
338
|
+
export interface ReportGetBotsReportV2Params {
|
|
311
339
|
/**
|
|
312
|
-
*
|
|
340
|
+
* Domain to query logs for.
|
|
313
341
|
*/
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
317
|
-
value: 'Amazonbot' | 'ClaudeBot' | 'Claude-User' | 'Claude-SearchBot' | 'Applebot' | 'Applebot-Extended' | 'Bytespider' | 'DeepSeek' | 'DuckAssistBot' | 'DuckDuckBot' | 'Googlebot' | 'Googlebot-News' | 'Googlebot-Video' | 'Googlebot-Image' | 'Google-Extended' | 'Storebot-Google' | 'Google-CloudVertexBot' | 'meta-externalfetcher' | 'meta-externalagent' | 'bingbot' | 'MicrosoftPreview' | 'ChatGPT-User' | 'GPTBot' | 'OAI-SearchBot' | 'OAI-Operator' | 'PerplexityBot' | 'Perplexity-User' | 'Grok-PageBrowser' | 'YouBot' | Array<'Amazonbot' | 'ClaudeBot' | 'Claude-User' | 'Claude-SearchBot' | 'Applebot' | 'Applebot-Extended' | 'Bytespider' | 'DeepSeek' | 'DuckAssistBot' | 'DuckDuckBot' | 'Googlebot' | 'Googlebot-News' | 'Googlebot-Video' | 'Googlebot-Image' | 'Google-Extended' | 'Storebot-Google' | 'Google-CloudVertexBot' | 'meta-externalfetcher' | 'meta-externalagent' | 'bingbot' | 'MicrosoftPreview' | 'ChatGPT-User' | 'GPTBot' | 'OAI-SearchBot' | 'OAI-Operator' | 'PerplexityBot' | 'Perplexity-User' | 'Grok-PageBrowser' | 'YouBot'>;
|
|
318
|
-
}
|
|
342
|
+
domain: string;
|
|
343
|
+
metrics: Array<'count' | 'citations' | 'indexing' | 'training' | 'last_visit'>;
|
|
319
344
|
/**
|
|
320
|
-
*
|
|
345
|
+
* Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS,
|
|
346
|
+
* or full ISO timestamp.
|
|
347
|
+
*/
|
|
348
|
+
start_date: string;
|
|
349
|
+
/**
|
|
350
|
+
* Date interval for the report. (only used with date dimension)
|
|
351
|
+
*/
|
|
352
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
353
|
+
/**
|
|
354
|
+
* Dimensions to group the report by.
|
|
355
|
+
*/
|
|
356
|
+
dimensions?: Array<'date' | 'hour' | 'path' | 'bot_name' | 'bot_provider' | 'bot_type'>;
|
|
357
|
+
/**
|
|
358
|
+
* End date in UTC. Accepts same formats as start_date. Defaults to now UTC if
|
|
359
|
+
* omitted.
|
|
360
|
+
*/
|
|
361
|
+
end_date?: string;
|
|
362
|
+
/**
|
|
363
|
+
* Filters for bots report.
|
|
321
364
|
*/
|
|
322
|
-
|
|
323
|
-
|
|
365
|
+
filters?: Array<Shared.PathFilter | Shared.BotNameFilter | Shared.BotProviderFilter | ReportGetBotsReportV2Params.BotTypeFilter>;
|
|
366
|
+
/**
|
|
367
|
+
* Custom ordering of the report results.
|
|
368
|
+
*
|
|
369
|
+
* The order is a record of key-value pairs where:
|
|
370
|
+
*
|
|
371
|
+
* - key is the field to order by, which can be a metric or dimension
|
|
372
|
+
* - value is the direction of the order, either 'asc' for ascending or 'desc' for
|
|
373
|
+
* descending.
|
|
374
|
+
*
|
|
375
|
+
* When not specified, the default order is the first metric in the query
|
|
376
|
+
* descending.
|
|
377
|
+
*/
|
|
378
|
+
order_by?: {
|
|
379
|
+
[key: string]: 'asc' | 'desc';
|
|
380
|
+
};
|
|
381
|
+
organization_id?: string | null;
|
|
382
|
+
/**
|
|
383
|
+
* Pagination settings for the report results.
|
|
384
|
+
*/
|
|
385
|
+
pagination?: Shared.Pagination;
|
|
386
|
+
}
|
|
387
|
+
export declare namespace ReportGetBotsReportV2Params {
|
|
388
|
+
/**
|
|
389
|
+
* Filter by bot_type column (v2 hourly table only)
|
|
390
|
+
*/
|
|
391
|
+
interface BotTypeFilter {
|
|
392
|
+
field: 'bot_type';
|
|
324
393
|
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
325
|
-
value: '
|
|
394
|
+
value: 'ai_assistant' | 'ai_training' | 'index' | 'ai_agent' | Array<'ai_assistant' | 'ai_training' | 'index' | 'ai_agent'>;
|
|
326
395
|
}
|
|
327
396
|
}
|
|
328
397
|
export interface ReportGetReferralsReportParams {
|
|
@@ -384,6 +453,108 @@ export declare namespace ReportGetReferralsReportParams {
|
|
|
384
453
|
value: 'openai' | 'none' | 'anthropic' | 'deepseek' | 'perplexity' | 'you' | 'grok' | 'microsoft' | 'gemini' | 'internal' | 'other' | Array<'openai' | 'none' | 'anthropic' | 'deepseek' | 'perplexity' | 'you' | 'grok' | 'microsoft' | 'gemini' | 'internal' | 'other'>;
|
|
385
454
|
}
|
|
386
455
|
}
|
|
456
|
+
export interface ReportGetReferralsReportV2Params {
|
|
457
|
+
/**
|
|
458
|
+
* Domain to query logs for.
|
|
459
|
+
*/
|
|
460
|
+
domain: string;
|
|
461
|
+
metrics: Array<'visits' | 'last_visit'>;
|
|
462
|
+
/**
|
|
463
|
+
* Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS,
|
|
464
|
+
* or full ISO timestamp.
|
|
465
|
+
*/
|
|
466
|
+
start_date: string;
|
|
467
|
+
/**
|
|
468
|
+
* Date interval for the report. (only used with date dimension)
|
|
469
|
+
*/
|
|
470
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
471
|
+
/**
|
|
472
|
+
* Dimensions to group the report by.
|
|
473
|
+
*/
|
|
474
|
+
dimensions?: Array<'date' | 'hour' | 'path' | 'referral_source' | 'referral_type'>;
|
|
475
|
+
/**
|
|
476
|
+
* End date in UTC. Accepts same formats as start_date. Defaults to now UTC if
|
|
477
|
+
* omitted.
|
|
478
|
+
*/
|
|
479
|
+
end_date?: string;
|
|
480
|
+
/**
|
|
481
|
+
* Filters for referrals report.
|
|
482
|
+
*/
|
|
483
|
+
filters?: Array<Shared.PathFilter | ReportGetReferralsReportV2Params.ReferralSourceFilter | ReportGetReferralsReportV2Params.ReferralTypeFilter>;
|
|
484
|
+
/**
|
|
485
|
+
* Custom ordering of the report results.
|
|
486
|
+
*
|
|
487
|
+
* The order is a record of key-value pairs where:
|
|
488
|
+
*
|
|
489
|
+
* - key is the field to order by, which can be a metric or dimension
|
|
490
|
+
* - value is the direction of the order, either 'asc' for ascending or 'desc' for
|
|
491
|
+
* descending.
|
|
492
|
+
*
|
|
493
|
+
* When not specified, the default order is the first metric in the query
|
|
494
|
+
* descending.
|
|
495
|
+
*/
|
|
496
|
+
order_by?: {
|
|
497
|
+
[key: string]: 'asc' | 'desc';
|
|
498
|
+
};
|
|
499
|
+
organization_id?: string | null;
|
|
500
|
+
/**
|
|
501
|
+
* Pagination settings for the report results.
|
|
502
|
+
*/
|
|
503
|
+
pagination?: Shared.Pagination;
|
|
504
|
+
}
|
|
505
|
+
export declare namespace ReportGetReferralsReportV2Params {
|
|
506
|
+
/**
|
|
507
|
+
* Filter by referral source
|
|
508
|
+
*/
|
|
509
|
+
interface ReferralSourceFilter {
|
|
510
|
+
field: 'referral_source';
|
|
511
|
+
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
512
|
+
value: 'openai' | 'none' | 'anthropic' | 'deepseek' | 'perplexity' | 'you' | 'grok' | 'microsoft' | 'gemini' | 'internal' | 'other' | Array<'openai' | 'none' | 'anthropic' | 'deepseek' | 'perplexity' | 'you' | 'grok' | 'microsoft' | 'gemini' | 'internal' | 'other'>;
|
|
513
|
+
}
|
|
514
|
+
/**
|
|
515
|
+
* Filter by referral type
|
|
516
|
+
*/
|
|
517
|
+
interface ReferralTypeFilter {
|
|
518
|
+
field: 'referral_type';
|
|
519
|
+
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
520
|
+
value: 'internal' | 'referer' | 'utm' | 'none' | Array<'internal' | 'referer' | 'utm' | 'none'>;
|
|
521
|
+
}
|
|
522
|
+
}
|
|
523
|
+
export interface ReportQueryFanoutsParams {
|
|
524
|
+
category_id: string;
|
|
525
|
+
/**
|
|
526
|
+
* End date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.
|
|
527
|
+
*/
|
|
528
|
+
end_date: string;
|
|
529
|
+
metrics: Array<'fanouts_per_execution' | 'total_fanouts' | 'share'>;
|
|
530
|
+
/**
|
|
531
|
+
* Start date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.
|
|
532
|
+
*/
|
|
533
|
+
start_date: string;
|
|
534
|
+
/**
|
|
535
|
+
* Date interval for the report. (only used with date dimension)
|
|
536
|
+
*/
|
|
537
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
538
|
+
/**
|
|
539
|
+
* Dimensions to group the report by.
|
|
540
|
+
*/
|
|
541
|
+
dimensions?: Array<'prompt' | 'query' | 'model' | 'region' | 'date'>;
|
|
542
|
+
/**
|
|
543
|
+
* Filters to apply to the query fanout report.
|
|
544
|
+
*/
|
|
545
|
+
filters?: Array<Shared.RegionIDFilter | Shared.ModelIDFilter | Shared.TopicIDFilter | Shared.TagIDFilter | PromptIDFilter | Shared.PersonaIDFilter | Shared.PromptTypeFilter>;
|
|
546
|
+
/**
|
|
547
|
+
* Custom ordering. Keys must be a requested metric or the `date` dimension. Values
|
|
548
|
+
* are `asc` or `desc`. Defaults to first metric descending.
|
|
549
|
+
*/
|
|
550
|
+
order_by?: {
|
|
551
|
+
[key: string]: 'asc' | 'desc';
|
|
552
|
+
};
|
|
553
|
+
/**
|
|
554
|
+
* Pagination settings for the report results.
|
|
555
|
+
*/
|
|
556
|
+
pagination?: Shared.Pagination;
|
|
557
|
+
}
|
|
387
558
|
export interface ReportSentimentParams {
|
|
388
559
|
category_id: string;
|
|
389
560
|
/**
|
|
@@ -408,7 +579,7 @@ export interface ReportSentimentParams {
|
|
|
408
579
|
/**
|
|
409
580
|
* List of filters to apply to the sentiment report.
|
|
410
581
|
*/
|
|
411
|
-
filters?: Array<ReportSentimentParams.AssetIDFilter | Shared.AssetNameFilter | ReportSentimentParams.ThemeFilter |
|
|
582
|
+
filters?: Array<ReportSentimentParams.AssetIDFilter | Shared.AssetNameFilter | ReportSentimentParams.ThemeFilter | Shared.RegionIDFilter | Shared.TopicIDFilter | TopicNameFilter | Shared.ModelIDFilter | Shared.TagIDFilter | ReportSentimentParams.TagNameFilter | Shared.PromptFilter | Shared.PersonaIDFilter>;
|
|
412
583
|
/**
|
|
413
584
|
* Custom ordering of the report results.
|
|
414
585
|
*
|
|
@@ -443,41 +614,12 @@ export declare namespace ReportSentimentParams {
|
|
|
443
614
|
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
444
615
|
value: string | Array<string>;
|
|
445
616
|
}
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
field: '
|
|
451
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
452
|
-
value: string | Array<string>;
|
|
453
|
-
}
|
|
454
|
-
interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
|
|
455
|
-
/**
|
|
456
|
-
* - `topic` - Deprecated
|
|
457
|
-
*/
|
|
458
|
-
field: 'topic_id' | 'topic';
|
|
459
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
460
|
-
value: string | Array<string>;
|
|
461
|
-
}
|
|
462
|
-
interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
|
|
463
|
-
/**
|
|
464
|
-
* - `model` - Deprecated
|
|
465
|
-
*/
|
|
466
|
-
field: 'model_id' | 'model';
|
|
467
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
468
|
-
value: string | Array<string>;
|
|
469
|
-
}
|
|
470
|
-
interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
|
|
471
|
-
/**
|
|
472
|
-
* - `tag` - Deprecated
|
|
473
|
-
*/
|
|
474
|
-
field: 'tag_id' | 'tag';
|
|
475
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
476
|
-
value: string | Array<string>;
|
|
477
|
-
}
|
|
478
|
-
interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
|
|
479
|
-
field: 'persona_id';
|
|
480
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
617
|
+
/**
|
|
618
|
+
* Filter by tag name.
|
|
619
|
+
*/
|
|
620
|
+
interface TagNameFilter {
|
|
621
|
+
field: 'tag_name';
|
|
622
|
+
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
481
623
|
value: string | Array<string>;
|
|
482
624
|
}
|
|
483
625
|
}
|
|
@@ -505,7 +647,7 @@ export interface ReportVisibilityParams {
|
|
|
505
647
|
/**
|
|
506
648
|
* List of filters to apply to the visibility report.
|
|
507
649
|
*/
|
|
508
|
-
filters?: Array<
|
|
650
|
+
filters?: Array<Shared.RegionIDFilter | Shared.ModelIDFilter | Shared.TopicIDFilter | TopicNameFilter | Shared.AssetNameFilter | Shared.TagIDFilter | ReportVisibilityParams.TagNameFilter | PromptIDFilter | Shared.PromptFilter | Shared.PersonaIDFilter>;
|
|
509
651
|
/**
|
|
510
652
|
* Custom ordering of the report results.
|
|
511
653
|
*
|
|
@@ -527,50 +669,16 @@ export interface ReportVisibilityParams {
|
|
|
527
669
|
pagination?: Shared.Pagination;
|
|
528
670
|
}
|
|
529
671
|
export declare namespace ReportVisibilityParams {
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
field: '
|
|
535
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
536
|
-
value: string | Array<string>;
|
|
537
|
-
}
|
|
538
|
-
interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
|
|
539
|
-
/**
|
|
540
|
-
* - `model` - Deprecated
|
|
541
|
-
*/
|
|
542
|
-
field: 'model_id' | 'model';
|
|
543
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
544
|
-
value: string | Array<string>;
|
|
545
|
-
}
|
|
546
|
-
interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
|
|
547
|
-
/**
|
|
548
|
-
* - `topic` - Deprecated
|
|
549
|
-
*/
|
|
550
|
-
field: 'topic_id' | 'topic';
|
|
551
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
552
|
-
value: string | Array<string>;
|
|
553
|
-
}
|
|
554
|
-
interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
|
|
555
|
-
/**
|
|
556
|
-
* - `tag` - Deprecated
|
|
557
|
-
*/
|
|
558
|
-
field: 'tag_id' | 'tag';
|
|
559
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
560
|
-
value: string | Array<string>;
|
|
561
|
-
}
|
|
562
|
-
interface ProfoundAnswerEngineInsightsFiltersPromptIDFilter {
|
|
563
|
-
field: 'prompt_id';
|
|
564
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
565
|
-
value: string | Array<string>;
|
|
566
|
-
}
|
|
567
|
-
interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
|
|
568
|
-
field: 'persona_id';
|
|
569
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
672
|
+
/**
|
|
673
|
+
* Filter by tag name.
|
|
674
|
+
*/
|
|
675
|
+
interface TagNameFilter {
|
|
676
|
+
field: 'tag_name';
|
|
677
|
+
operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive';
|
|
570
678
|
value: string | Array<string>;
|
|
571
679
|
}
|
|
572
680
|
}
|
|
573
681
|
export declare namespace Reports {
|
|
574
|
-
export { type ReportInfo as ReportInfo, type ReportResponse as ReportResponse, type ReportResult as ReportResult, type TopicNameFilter as TopicNameFilter, type ReportCitationsResponse as ReportCitationsResponse, type ReportCitationsParams as ReportCitationsParams, type ReportGetBotsReportParams as ReportGetBotsReportParams, type ReportGetReferralsReportParams as ReportGetReferralsReportParams, type ReportSentimentParams as ReportSentimentParams, type ReportVisibilityParams as ReportVisibilityParams, };
|
|
682
|
+
export { type PromptIDFilter as PromptIDFilter, type ReportInfo as ReportInfo, type ReportResponse as ReportResponse, type ReportResult as ReportResult, type TopicNameFilter as TopicNameFilter, type ReportCitationsResponse as ReportCitationsResponse, type ReportCitationsParams as ReportCitationsParams, type ReportGetBotsReportParams as ReportGetBotsReportParams, type ReportGetBotsReportV2Params as ReportGetBotsReportV2Params, type ReportGetReferralsReportParams as ReportGetReferralsReportParams, type ReportGetReferralsReportV2Params as ReportGetReferralsReportV2Params, type ReportQueryFanoutsParams as ReportQueryFanoutsParams, type ReportSentimentParams as ReportSentimentParams, type ReportVisibilityParams as ReportVisibilityParams, };
|
|
575
683
|
}
|
|
576
684
|
//# sourceMappingURL=reports.d.mts.map
|