Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.54.0"
".": "0.55.0"
}
8 changes: 4 additions & 4 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 103
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/profound/profound-d4de4432ed5c94723a807b2ac182da745b8fee526789255579af38561763c7e0.yml
openapi_spec_hash: c217ca0ab6d9e5ace83fea51c21febdd
config_hash: f47f5fe0661d0c081ac6f2364b4cf41a
configured_endpoints: 102
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/profound/profound-7f89d003ee5886a49dcba4317709b3631185a517c455e0dbf12130dadc1a73c3.yml
openapi_spec_hash: b6057ce27ebb04cdd19c0f006774ce65
config_hash: ff20af11692df5be71f1ef46d41ef365
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Changelog

## 0.55.0 (2026-07-30)

Full Changelog: [v0.54.0...v0.55.0](https://github.com/cooper-square-technologies/profound-python-sdk/compare/v0.54.0...v0.55.0)

### Features

* **api:** api update ([2c7ba50](https://github.com/cooper-square-technologies/profound-python-sdk/commit/2c7ba503a35b7048c33de728d0fce1c5c211b423))
* **api:** api update ([6b26be9](https://github.com/cooper-square-technologies/profound-python-sdk/commit/6b26be92d4436ac73524028399810067c59ad83c))
* **api:** api update ([bdcfe8e](https://github.com/cooper-square-technologies/profound-python-sdk/commit/bdcfe8e2187683fae95a5ff46e4db4990127f0cd))
* **api:** api update ([3776adc](https://github.com/cooper-square-technologies/profound-python-sdk/commit/3776adca4919f63f811ad563550a80e1dfda8eaf))
* **api:** shopping v2 endpoints ([c1b09be](https://github.com/cooper-square-technologies/profound-python-sdk/commit/c1b09be0bbcda1b4fbd243ff8aa834bc86492027))

## 0.54.0 (2026-07-24)

Full Changelog: [v0.53.0...v0.54.0](https://github.com/cooper-square-technologies/profound-python-sdk/compare/v0.53.0...v0.54.0)
Expand Down
36 changes: 17 additions & 19 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ from profound.types.organizations import (
CategoryAssetsResponse,
CategoryCreatePromptsResponse,
CategoryGetCategoryPersonasResponse,
CategoryGetCitationCategoriesResponse,
CategoryPromptsResponse,
CategoryRetrieveRegionsResponse,
CategoryTagsResponse,
Expand All @@ -79,6 +80,7 @@ Methods:
- <code title="get /v1/org/categories/{category_id}/assets">client.organizations.categories.<a href="./src/profound/resources/organizations/categories.py">assets</a>(category_id) -> <a href="./src/profound/types/organizations/category_assets_response.py">CategoryAssetsResponse</a></code>
- <code title="post /v1/org/categories/{category_id}/prompts">client.organizations.categories.<a href="./src/profound/resources/organizations/categories.py">create_prompts</a>(category_id, \*\*<a href="src/profound/types/organizations/category_create_prompts_params.py">params</a>) -> <a href="./src/profound/types/organizations/category_create_prompts_response.py">CategoryCreatePromptsResponse</a></code>
- <code title="get /v1/org/categories/{category_id}/personas">client.organizations.categories.<a href="./src/profound/resources/organizations/categories.py">get_category_personas</a>(category_id) -> <a href="./src/profound/types/organizations/category_get_category_personas_response.py">CategoryGetCategoryPersonasResponse</a></code>
- <code title="get /v1/org/categories/{category_id}/citation-categories">client.organizations.categories.<a href="./src/profound/resources/organizations/categories.py">get_citation_categories</a>(category_id) -> <a href="./src/profound/types/organizations/category_get_citation_categories_response.py">CategoryGetCitationCategoriesResponse</a></code>
- <code title="get /v1/org/categories/{category_id}/prompts">client.organizations.categories.<a href="./src/profound/resources/organizations/categories.py">prompts</a>(category_id, \*\*<a href="src/profound/types/organizations/category_prompts_params.py">params</a>) -> <a href="./src/profound/types/organizations/category_prompts_response.py">CategoryPromptsResponse</a></code>
- <code title="get /v1/org/categories/{category_id}/regions">client.organizations.categories.<a href="./src/profound/resources/organizations/categories.py">retrieve_regions</a>(category_id) -> <a href="./src/profound/types/organizations/category_retrieve_regions_response.py">CategoryRetrieveRegionsResponse</a></code>
- <code title="get /v1/org/categories/{category_id}/tags">client.organizations.categories.<a href="./src/profound/resources/organizations/categories.py">tags</a>(category_id) -> <a href="./src/profound/types/organizations/category_tags_response.py">CategoryTagsResponse</a></code>
Expand Down Expand Up @@ -180,31 +182,27 @@ from profound.types.reports import (
BrandNameFilter,
MerchantNameFilter,
ProductNameFilter,
ShoppingAllItemsWithMerchantsResponse,
ShoppingExecutionsResponse,
ShoppingItemVisibilityResponse,
ShoppingMerchantByItemsResponse,
ShoppingMerchantDistributionResponse,
ShoppingMerchantShareResponse,
ShoppingMerchantVisibilityByBrandResponse,
ShoppingProductMerchantURLsResponse,
ShoppingBrandsResponse,
ShoppingMerchantsResponse,
ShoppingProductsResponse,
ShoppingStreamBrandsResponse,
ShoppingStreamMerchantsResponse,
ShoppingStreamProductsResponse,
ShoppingStreamTriggerRateResponse,
ShoppingTriggerRateResponse,
ShoppingVisibilityResponse,
)
```

Methods:

- <code title="post /v1/reports/shopping/all-items-with-merchants">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">all_items_with_merchants</a>(\*\*<a href="src/profound/types/reports/shopping_all_items_with_merchants_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_all_items_with_merchants_response.py">ShoppingAllItemsWithMerchantsResponse</a></code>
- <code title="post /v1/reports/shopping/executions">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">executions</a>(\*\*<a href="src/profound/types/reports/shopping_executions_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_executions_response.py">ShoppingExecutionsResponse</a></code>
- <code title="post /v1/reports/shopping/item-visibility">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">item_visibility</a>(\*\*<a href="src/profound/types/reports/shopping_item_visibility_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_item_visibility_response.py">ShoppingItemVisibilityResponse</a></code>
- <code title="post /v1/reports/shopping/merchant-by-items">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">merchant_by_items</a>(\*\*<a href="src/profound/types/reports/shopping_merchant_by_items_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_merchant_by_items_response.py">ShoppingMerchantByItemsResponse</a></code>
- <code title="post /v1/reports/shopping/merchant-distribution">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">merchant_distribution</a>(\*\*<a href="src/profound/types/reports/shopping_merchant_distribution_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_merchant_distribution_response.py">ShoppingMerchantDistributionResponse</a></code>
- <code title="post /v1/reports/shopping/merchant-share">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">merchant_share</a>(\*\*<a href="src/profound/types/reports/shopping_merchant_share_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_merchant_share_response.py">ShoppingMerchantShareResponse</a></code>
- <code title="post /v1/reports/shopping/merchant-visibility-by-brand">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">merchant_visibility_by_brand</a>(\*\*<a href="src/profound/types/reports/shopping_merchant_visibility_by_brand_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_merchant_visibility_by_brand_response.py">ShoppingMerchantVisibilityByBrandResponse</a></code>
- <code title="post /v1/reports/shopping/product-merchant-urls">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">product_merchant_urls</a>(\*\*<a href="src/profound/types/reports/shopping_product_merchant_urls_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_product_merchant_urls_response.py">ShoppingProductMerchantURLsResponse</a></code>
- <code title="post /v1/reports/shopping/trigger-rate">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">trigger_rate</a>(\*\*<a href="src/profound/types/reports/shopping_trigger_rate_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_trigger_rate_response.py">ShoppingTriggerRateResponse</a></code>
- <code title="post /v1/reports/shopping/visibility">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">visibility</a>(\*\*<a href="src/profound/types/reports/shopping_visibility_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_visibility_response.py">ShoppingVisibilityResponse</a></code>
- <code title="post /v2/reports/shopping/brands">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">brands</a>(\*\*<a href="src/profound/types/reports/shopping_brands_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_brands_response.py">ShoppingBrandsResponse</a></code>
- <code title="post /v2/reports/shopping/merchants">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">merchants</a>(\*\*<a href="src/profound/types/reports/shopping_merchants_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_merchants_response.py">ShoppingMerchantsResponse</a></code>
- <code title="post /v2/reports/shopping/products">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">products</a>(\*\*<a href="src/profound/types/reports/shopping_products_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_products_response.py">ShoppingProductsResponse</a></code>
- <code title="post /v2/reports/shopping/brands/stream">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">stream_brands</a>(\*\*<a href="src/profound/types/reports/shopping_stream_brands_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_stream_brands_response.py">ShoppingStreamBrandsResponse</a></code>
- <code title="post /v2/reports/shopping/merchants/stream">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">stream_merchants</a>(\*\*<a href="src/profound/types/reports/shopping_stream_merchants_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_stream_merchants_response.py">ShoppingStreamMerchantsResponse</a></code>
- <code title="post /v2/reports/shopping/products/stream">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">stream_products</a>(\*\*<a href="src/profound/types/reports/shopping_stream_products_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_stream_products_response.py">ShoppingStreamProductsResponse</a></code>
- <code title="post /v2/reports/shopping/trigger-rate/stream">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">stream_trigger_rate</a>(\*\*<a href="src/profound/types/reports/shopping_stream_trigger_rate_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_stream_trigger_rate_response.py">ShoppingStreamTriggerRateResponse</a></code>
- <code title="post /v2/reports/shopping/trigger-rate">client.reports.shopping.<a href="./src/profound/resources/reports/shopping.py">trigger_rate</a>(\*\*<a href="src/profound/types/reports/shopping_trigger_rate_params.py">params</a>) -> <a href="./src/profound/types/reports/shopping_trigger_rate_response.py">ShoppingTriggerRateResponse</a></code>

## Accuracy

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "profound"
version = "0.54.0"
version = "0.55.0"
description = "The official Python library for the profound API"
dynamic = ["readme"]
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion src/profound/_version.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

__title__ = "profound"
__version__ = "0.54.0" # x-release-please-version
__version__ = "0.55.0" # x-release-please-version
81 changes: 81 additions & 0 deletions src/profound/resources/organizations/categories.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
from ...types.organizations.category_retrieve_regions_response import CategoryRetrieveRegionsResponse
from ...types.organizations.category_update_prompt_status_response import CategoryUpdatePromptStatusResponse
from ...types.organizations.category_get_category_personas_response import CategoryGetCategoryPersonasResponse
from ...types.organizations.category_get_citation_categories_response import CategoryGetCitationCategoriesResponse

__all__ = ["CategoriesResource", "AsyncCategoriesResource"]

Expand Down Expand Up @@ -214,6 +215,40 @@ def get_category_personas(
cast_to=CategoryGetCategoryPersonasResponse,
)

def get_citation_categories(
self,
category_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> CategoryGetCitationCategoriesResponse:
"""
Get the citation categories for a category: the built-in buckets plus any custom
categories.

Args:
extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds
"""
if not category_id:
raise ValueError(f"Expected a non-empty value for `category_id` but received {category_id!r}")
return self._get(
path_template("/v1/org/categories/{category_id}/citation-categories", category_id=category_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=CategoryGetCitationCategoriesResponse,
)

def prompts(
self,
category_id: str,
Expand Down Expand Up @@ -690,6 +725,40 @@ async def get_category_personas(
cast_to=CategoryGetCategoryPersonasResponse,
)

async def get_citation_categories(
self,
category_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> CategoryGetCitationCategoriesResponse:
"""
Get the citation categories for a category: the built-in buckets plus any custom
categories.

Args:
extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds
"""
if not category_id:
raise ValueError(f"Expected a non-empty value for `category_id` but received {category_id!r}")
return await self._get(
path_template("/v1/org/categories/{category_id}/citation-categories", category_id=category_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=CategoryGetCitationCategoriesResponse,
)

async def prompts(
self,
category_id: str,
Expand Down Expand Up @@ -1005,6 +1074,9 @@ def __init__(self, categories: CategoriesResource) -> None:
self.get_category_personas = to_raw_response_wrapper(
categories.get_category_personas,
)
self.get_citation_categories = to_raw_response_wrapper(
categories.get_citation_categories,
)
self.prompts = to_raw_response_wrapper(
categories.prompts,
)
Expand Down Expand Up @@ -1041,6 +1113,9 @@ def __init__(self, categories: AsyncCategoriesResource) -> None:
self.get_category_personas = async_to_raw_response_wrapper(
categories.get_category_personas,
)
self.get_citation_categories = async_to_raw_response_wrapper(
categories.get_citation_categories,
)
self.prompts = async_to_raw_response_wrapper(
categories.prompts,
)
Expand Down Expand Up @@ -1077,6 +1152,9 @@ def __init__(self, categories: CategoriesResource) -> None:
self.get_category_personas = to_streamed_response_wrapper(
categories.get_category_personas,
)
self.get_citation_categories = to_streamed_response_wrapper(
categories.get_citation_categories,
)
self.prompts = to_streamed_response_wrapper(
categories.prompts,
)
Expand Down Expand Up @@ -1113,6 +1191,9 @@ def __init__(self, categories: AsyncCategoriesResource) -> None:
self.get_category_personas = async_to_streamed_response_wrapper(
categories.get_category_personas,
)
self.get_citation_categories = async_to_streamed_response_wrapper(
categories.get_citation_categories,
)
self.prompts = async_to_streamed_response_wrapper(
categories.prompts,
)
Expand Down
Loading
Loading