profoundai 0.35.0 → 0.36.0

package/src/resources/prompt-volumes.ts

@@ -0,0 +1,203 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class PromptVolumes extends APIResource {
+  /**
+   * Get Volume
+   */
+  createVolume(body: PromptVolumeCreateVolumeParams, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.post('/v1/prompt-volumes/volume', { body, ...options });
+  }
+
+  /**
+   * Get Citation Prompts
+   */
+  listCitationPrompts(
+    query: PromptVolumeListCitationPromptsParams,
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    return this._client.get('/v1/prompt-volumes/citation-prompts', { query, ...options });
+  }
+}
+
+export type PromptVolumeCreateVolumeResponse = unknown;
+
+export type PromptVolumeListCitationPromptsResponse = unknown;
+
+export interface PromptVolumeCreateVolumeParams {
+  /**
+   * End date for the query. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full
+   * ISO timestamp.
+   */
+  end_date: string;
+
+  metrics: Array<'volume' | 'change'>;
+
+  /**
+   * Start date for the query. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full
+   * ISO timestamp.
+   */
+  start_date: string;
+
+  /**
+   * Date interval for the report. (only used with date dimension)
+   */
+  date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
+
+  /**
+   * Dimensions to group the report by.
+   */
+  dimensions?: Array<'keyword' | 'date' | 'platform' | 'country_code' | 'matching_type' | 'frequency'>;
+
+  /**
+   * Filters to apply to the query
+   */
+  filters?: Array<
+    | PromptVolumeCreateVolumeParams.CountryCodeFilter
+    | PromptVolumeCreateVolumeParams.FrequencyFilter
+    | PromptVolumeCreateVolumeParams.KeywordFilter
+    | PromptVolumeCreateVolumeParams.MatchingTypeFilter
+    | PromptVolumeCreateVolumeParams.PlatformFilter
+  >;
+
+  /**
+   * Custom ordering of the report results.
+   *
+   * The order is a record of key-value pairs where:
+   *
+   * - key is the field to order by, which can be a metric or dimension
+   * - value is the direction of the order, either 'asc' for ascending or 'desc' for
+   *   descending.
+   *
+   * When not specified, the default order is the first metric in the query
+   * descending.
+   */
+  order_by?: { [key: string]: 'asc' | 'desc' };
+
+  /**
+   * Pagination settings for the report results.
+   */
+  pagination?: Shared.Pagination;
+}
+
+export namespace PromptVolumeCreateVolumeParams {
+  /**
+   * Filter by country code
+   */
+  export interface CountryCodeFilter {
+    field: 'country_code';
+
+    operator:
+      | 'is'
+      | 'not_is'
+      | 'in'
+      | 'not_in'
+      | 'contains'
+      | 'not_contains'
+      | 'matches'
+      | 'contains_case_insensitive'
+      | 'not_contains_case_insensitive';
+
+    value: string | Array<string>;
+  }
+
+  /**
+   * Filter by frequency
+   */
+  export interface FrequencyFilter {
+    field: 'frequency';
+
+    operator:
+      | 'is'
+      | 'not_is'
+      | 'in'
+      | 'not_in'
+      | 'contains'
+      | 'not_contains'
+      | 'matches'
+      | 'contains_case_insensitive'
+      | 'not_contains_case_insensitive';
+
+    value: string | Array<string>;
+  }
+
+  /**
+   * Filter by keyword
+   */
+  export interface KeywordFilter {
+    field: 'keyword';
+
+    operator:
+      | 'is'
+      | 'not_is'
+      | 'in'
+      | 'not_in'
+      | 'contains'
+      | 'not_contains'
+      | 'matches'
+      | 'contains_case_insensitive'
+      | 'not_contains_case_insensitive';
+
+    value: string | Array<string>;
+  }
+
+  /**
+   * Filter by matching type
+   */
+  export interface MatchingTypeFilter {
+    field: 'matching_type';
+
+    operator:
+      | 'is'
+      | 'not_is'
+      | 'in'
+      | 'not_in'
+      | 'contains'
+      | 'not_contains'
+      | 'matches'
+      | 'contains_case_insensitive'
+      | 'not_contains_case_insensitive';
+
+    value: string | Array<string>;
+  }
+
+  /**
+   * Filter by platform
+   */
+  export interface PlatformFilter {
+    field: 'platform';
+
+    operator:
+      | 'is'
+      | 'not_is'
+      | 'in'
+      | 'not_in'
+      | 'contains'
+      | 'not_contains'
+      | 'matches'
+      | 'contains_case_insensitive'
+      | 'not_contains_case_insensitive';
+
+    value: string | Array<string>;
+  }
+}
+
+export interface PromptVolumeListCitationPromptsParams {
+  /**
+   * Domain to look up (e.g. ramp.com)
+   */
+  input_domain: string;
+}
+
+export declare namespace PromptVolumes {
+  export {
+    type PromptVolumeCreateVolumeResponse as PromptVolumeCreateVolumeResponse,
+    type PromptVolumeListCitationPromptsResponse as PromptVolumeListCitationPromptsResponse,
+    type PromptVolumeCreateVolumeParams as PromptVolumeCreateVolumeParams,
+    type PromptVolumeListCitationPromptsParams as PromptVolumeListCitationPromptsParams,
+  };
+}

package/src/resources/prompts.ts

@@ -93,13 +93,13 @@ export interface PromptAnswersParams {
    * List of filters to apply to the answers report.
    */
   filters?: Array<
-    | PromptAnswersParams.ProfoundAnswerEngineInsightsFiltersRegionIDFilter
-    | PromptAnswersParams.ProfoundAnswerEngineInsightsFiltersModelIDFilter
-    | PromptAnswersParams.ProfoundAnswerEngineInsightsFiltersTagIDFilter
-    | PromptAnswersParams.ProfoundAnswerEngineInsightsFiltersPromptTypeFilter
+    | Shared.RegionIDFilter
+    | Shared.ModelIDFilter
+    | Shared.TagIDFilter
+    | Shared.PromptTypeFilter
     | Shared.PromptFilter
-    | PromptAnswersParams.ProfoundAnswerEngineInsightsFiltersPersonaIDFilter
-    | PromptAnswersParams.ProfoundAnswerEngineInsightsFiltersTopicIDFilter
+    | Shared.PersonaIDFilter
+    | Shared.TopicIDFilter
     | PromptAnswersParams.AssetIDFilter
     | Shared.AssetNameFilter
   >;
@@ -113,78 +113,6 @@ export interface PromptAnswersParams {
 }
 
 export namespace PromptAnswersParams {
-  export interface ProfoundAnswerEngineInsightsFiltersRegionIDFilter {
-    /**
-     * - `region` - Deprecated
-     */
-    field: 'region_id' | 'region';
-
-    operator: 'is' | 'not_is' | 'in' | 'not_in';
-
-    value: string | Array<string>;
-  }
-
-  export interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
-    /**
-     * - `model` - Deprecated
-     */
-    field: 'model_id' | 'model';
-
-    operator: 'is' | 'not_is' | 'in' | 'not_in';
-
-    value: string | Array<string>;
-  }
-
-  export interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
-    /**
-     * - `tag` - Deprecated
-     */
-    field: 'tag_id' | 'tag';
-
-    operator: 'is' | 'not_is' | 'in' | 'not_in';
-
-    value: string | Array<string>;
-  }
-
-  /**
-   * Filter by prompt type (visibility or sentiment)
-   */
-  export interface ProfoundAnswerEngineInsightsFiltersPromptTypeFilter {
-    field: 'prompt_type';
-
-    operator:
-      | 'is'
-      | 'not_is'
-      | 'in'
-      | 'not_in'
-      | 'contains'
-      | 'not_contains'
-      | 'matches'
-      | 'contains_case_insensitive'
-      | 'not_contains_case_insensitive';
-
-    value: 'visibility' | 'sentiment' | Array<'visibility' | 'sentiment'>;
-  }
-
-  export interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
-    field: 'persona_id';
-
-    operator: 'is' | 'not_is' | 'in' | 'not_in';
-
-    value: string | Array<string>;
-  }
-
-  export interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
-    /**
-     * - `topic` - Deprecated
-     */
-    field: 'topic_id' | 'topic';
-
-    operator: 'is' | 'not_is' | 'in' | 'not_in';
-
-    value: string | Array<string>;
-  }
-
   export interface AssetIDFilter {
     field: 'asset_id';