api.md

Shared Types

from profound.types import (
    AnalysisTypeFilter,
    AssetIDFilter,
    AssetNameFilter,
    BotNameFilter,
    BotProviderFilter,
    CursorPagination,
    ModelIDFilter,
    Pagination,
    PathFilter,
    PersonaIDFilter,
    PromptFilter,
    PromptTypeFilter,
    RegionIDFilter,
    RegionNameFilter,
    TagIDFilter,
    TopicIDFilter,
)

Organizations

Types:

from profound.types import (
    Category,
    NamedResource,
    Organization,
    PersonaProfile,
    PersonaProfileBehavior,
    PersonaProfileDemographics,
    PersonaProfileEmployment,
    OrganizationListResponse,
    OrganizationDomainsResponse,
    OrganizationGetPersonasResponse,
    OrganizationListAssetsResponse,
    OrganizationModelsResponse,
    OrganizationRegionsResponse,
)

Methods:

• client.organizations.list() -> OrganizationListResponse
• client.organizations.domains(**params) -> OrganizationDomainsResponse
• client.organizations.get_personas(**params) -> OrganizationGetPersonasResponse
• client.organizations.list_assets(**params) -> OrganizationListAssetsResponse
• client.organizations.models() -> OrganizationModelsResponse
• client.organizations.regions(**params) -> OrganizationRegionsResponse

Categories

Types:

from profound.types.organizations import (
    FieldDiff,
    IDOrName,
    NamedResourceDiffList,
    CategoryListResponse,
    CategoryAssetsResponse,
    CategoryCreatePromptsResponse,
    CategoryGetCategoryPersonasResponse,
    CategoryPromptsResponse,
    CategoryTagsResponse,
    CategoryTopicsResponse,
    CategoryUpdatePromptStatusResponse,
    CategoryUpdatePromptsResponse,
)

Methods:

• client.organizations.categories.list(**params) -> CategoryListResponse
• client.organizations.categories.assets(category_id) -> CategoryAssetsResponse
• client.organizations.categories.create_prompts(category_id, **params) -> CategoryCreatePromptsResponse
• client.organizations.categories.get_category_personas(category_id) -> CategoryGetCategoryPersonasResponse
• client.organizations.categories.prompts(category_id, **params) -> CategoryPromptsResponse
• client.organizations.categories.tags(category_id) -> CategoryTagsResponse
• client.organizations.categories.topics(category_id) -> CategoryTopicsResponse
• client.organizations.categories.update_prompt_status(category_id, **params) -> CategoryUpdatePromptStatusResponse
• client.organizations.categories.update_prompts(category_id, **params) -> CategoryUpdatePromptsResponse

Prompts

Types:

from profound.types import PromptAnswersResponse

Methods:

• client.prompts.answers(**params) -> PromptAnswersResponse

Reports

Types:

from profound.types import (
    PromptIDFilter,
    ReportInfo,
    ReportResponse,
    ReportResult,
    TagNameFilter,
    TopicNameFilter,
    ReportCitationsResponse,
    ReportStreamCitationsResponse,
    ReportStreamSentimentResponse,
    ReportStreamVisibilityResponse,
)

Methods:

• client.reports.citations(**params) -> ReportCitationsResponse
• client.reports.get_bots_report(**params) -> ReportResponse
• client.reports.get_bots_report_v2(**params) -> ReportResponse
• client.reports.get_referrals_report(**params) -> ReportResponse
• client.reports.get_referrals_report_v2(**params) -> ReportResponse
• client.reports.query_fanouts(**params) -> ReportResponse
• client.reports.sentiment(**params) -> ReportResponse
• client.reports.stream_citations(**params) -> ReportStreamCitationsResponse
• client.reports.stream_sentiment(**params) -> ReportStreamSentimentResponse
• client.reports.stream_visibility(**params) -> ReportStreamVisibilityResponse
• client.reports.visibility(**params) -> ReportResponse

Logs

Raw

Types:

from profound.types.logs import RawBotsResponse, RawLogsResponse

Methods:

• client.logs.raw.bots(**params) -> RawBotsResponse
• client.logs.raw.logs(**params) -> RawLogsResponse

Content

Optimization

Types:

from profound.types.content import OptimizationRetrieveResponse, OptimizationListResponse

Methods:

• client.content.optimization.retrieve(content_id, *, asset_id) -> OptimizationRetrieveResponse
• client.content.optimization.list(asset_id, **params) -> OptimizationListResponse

Agents

Types:

from profound.types import AgentRetrieveResponse, AgentListResponse

Methods:

• client.agents.retrieve(agent_id, **params) -> AgentRetrieveResponse
• client.agents.list(**params) -> AgentListResponse

Runs

Types:

from profound.types.agents import RunCreateResponse, RunRetrieveResponse

Methods:

• client.agents.runs.create(agent_id, **params) -> RunCreateResponse
• client.agents.runs.retrieve(run_id, *, agent_id) -> RunRetrieveResponse

KnowledgeBases

Types:

from profound.types import KnowledgeBaseListResponse, KnowledgeBaseSearchResponse

Methods:

• client.knowledge_bases.list(**params) -> KnowledgeBaseListResponse
• client.knowledge_bases.search(knowledge_base_id, **params) -> KnowledgeBaseSearchResponse

Documents

Types:

from profound.types.knowledge_bases import (
    DocumentCreateResponse,
    DocumentUpdateResponse,
    DocumentDeleteResponse,
)

Methods:

• client.knowledge_bases.documents.create(knowledge_base_id, **params) -> DocumentCreateResponse
• client.knowledge_bases.documents.update(knowledge_base_id, **params) -> DocumentUpdateResponse
• client.knowledge_bases.documents.delete(knowledge_base_id, **params) -> DocumentDeleteResponse

Folders

Types:

from profound.types.knowledge_bases import FolderCreateResponse, FolderDeleteResponse

Methods:

• client.knowledge_bases.folders.create(knowledge_base_id, **params) -> FolderCreateResponse
• client.knowledge_bases.folders.delete(knowledge_base_id, **params) -> FolderDeleteResponse