syntheticusers 1.0.0

Python SDK for Synthetic Users - AI-powered user and market research platform

syntheticusers

Description: Synthetic Users provides AI-powered, human-like participants for user and market research, streamlining data collection and insight generation. With multi-agent architecture, it simulates realistic, scalable interactions, enabling efficient research through synthetic interviews and surveys.

Features:

• In-depth Interviews: Interactive, AI-driven interviews with customizable follow-up options.
• Global Surveys: Fast, quantitative data collection at scale.
• Customizable Synthetic Users: Integrate proprietary data for tailored research.
• Multi-agent Framework: Mimics real human interactions for accurate insights.

Use Cases:

• Product Testing: Identify needs and refine concepts.
• Market Analysis: Expand reach and enhance user satisfaction.

For more information, visit Synthetic Users.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import syntheticusers

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import syntheticusers

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import syntheticusers
from syntheticusers.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = syntheticusers.Configuration(
    host = "http://localhost:8000/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = syntheticusers.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with syntheticusers.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = syntheticusers.AnnotationsApi(api_client)
    app_utils_annotation_create1 = syntheticusers.AppUtilsAnnotationCreate1() # AppUtilsAnnotationCreate1 | 

    try:
        # Create Annotation
        api_response = api_instance.create_annotation(app_utils_annotation_create1)
        print("The response of AnnotationsApi->create_annotation:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnnotationsApi->create_annotation: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8000/api/v1

Class	Method	HTTP request	Description
AnnotationsApi	create_annotation	POST /annotations	Create Annotation
AnnotationsApi	delete_annotation	DELETE /annotations/{annotation_id}	Delete Annotation
AnnotationsApi	get_annotation	GET /annotations/{annotation_id}	Get Annotation
AnnotationsApi	list_annotations	GET /annotations	List Annotations
AnnotationsApi	update_annotation	PATCH /annotations/{annotation_id}	Update Annotation
AssistantSessionsApi	chat	POST /assistants/{assistant_session_id}/chat	Chat
AssistantSessionsApi	create_assistant	POST /assistants	Create Assistant
AssistantSessionsApi	get_assistant_session	GET /assistants/{assistant_session_id}	Get Assistant Session
AssistantSessionsApi	list_assistant_sessions	GET /assistants	List Assistant Sessions
AudiencesApi	create_audience	POST /audiences	Create Audience
AudiencesApi	delete_audience	DELETE /audiences/{audience_id}	Delete Audience
AudiencesApi	edit_audience	PATCH /audiences/{audience_id}	Edit Audience
AudiencesApi	extend_audience	POST /audiences/{audience_id}/extend	Extend Audience
AudiencesApi	generate_audience	POST /audiences/{audience_id}/generate	Generate Audience
AudiencesApi	get_audience	GET /audiences/{audience_id}	Get Audience
AudiencesApi	list_audiences	GET /audiences	List Audiences
ConversationFeedbackApi	create	POST /feedback	Create
ConversationFeedbackApi	delete_feedback	DELETE /feedback/{feedback_id}	Delete Feedback
ConversationFeedbackApi	get_feedback	GET /feedback/{conversation_id}	Get Feedback
ConversationFeedbackApi	list_feedback	GET /feedback	List Feedback
ConversationFeedbackApi	update_feedback	PUT /feedback/{feedback_id}	Update Feedback
ConversationsApi	get_conversation	GET /conversations/{conversation_id}	Get Conversation
ConversationsApi	list_conversations	GET /conversations	List Conversations
CopilotSessionsApi	create_session	POST /copilots/{project_id}/sessions	Create Session
CopilotSessionsApi	delete_session	DELETE /copilots/{project_id}/sessions/{session_id}	Delete Session
CopilotSessionsApi	get_session	GET /copilots/{project_id}/sessions/{session_id}	Get Session
CopilotSessionsApi	list_sessions	GET /copilots/{project_id}/sessions	List Sessions
CopilotSessionsApi	update_session	PATCH /copilots/{project_id}/sessions/{session_id}	Update Session
FilesApi	create_file	POST /files	Create File
FilesApi	delete_file	DELETE /files/{file_id}	Delete File
FilesApi	get_file	GET /files/{file_id}	Get File
FilesApi	get_file_download_url	POST /files/{file_id}/download	Get File Download Url
FilesApi	list_files	GET /files	List Files
FilesApi	start_processing	POST /files/{file_id}/process	Start Processing
FilesApi	upload_file_proxy	POST /files/{file_id}/upload	Upload File Proxy
HealthApi	health_check	GET /health	Health Check
InterviewsApi	get_interview	GET /interviews/{interview_id}	Get Interview
InterviewsApi	interview_follow_up	POST /interviews/{interview_id}/follow_up	Interview Follow Up
InterviewsApi	list_interviews	GET /interviews	List Interviews
InterviewsApi	regenerate_interview	POST /interviews/{interview_id}/regenerate	Regenerate Interview
KnowledgeGraphsApi	get_knowledge_graph	GET /knowledgeGraphs/{knowledge_graph_id}	Get Knowledge Graph
KnowledgeGraphsApi	list_knowledge_graphs	GET /knowledgeGraphs	List Knowledge Graphs
PlansApi	create_plan	POST /plans	Create Plan
PlansApi	delete_plan	DELETE /plans/{plan_id}	Delete Plan
PlansApi	get_plan	GET /plans/{plan_id}	Get Plan
PlansApi	list_plans	GET /plans	List Plans
PlansApi	update_plan	PATCH /plans/{plan_id}	Update Plan
ProblemsApi	create_problem	POST /problems	Create Problem
ProblemsApi	delete_problem	DELETE /problems/{problem_id}	Delete Problem
ProblemsApi	edit_problem	PATCH /problems/{problem_id}	Edit Problem
ProblemsApi	get_problem	GET /problems/{problem_id}	Get Problem
ProblemsApi	list_problems	GET /problems	List Problems
ProjectsApi	get_project	GET /projects/{project_id}	Get Project
ProjectsApi	list_projects	GET /projects	List Projects
ProjectsApi	stream_events	GET /projects/{project_id}/stream	Stream Events
ReportsApi	create_report	POST /reports	Create Report
ReportsApi	delete_report	DELETE /reports/{report_id}	Delete Report
ReportsApi	generate_full_report	POST /reports/{report_id}/generate	Generate Full Report
ReportsApi	generate_toc_endpoint	POST /reports/{report_id}/generate-toc	Generate Toc Endpoint
ReportsApi	get_report	GET /reports/{report_id}	Get Report
ReportsApi	get_report_pdf	GET /reports/{report_id}/pdf	Get Report Pdf
ReportsApi	list_reports	GET /reports	List Reports
ReportsApi	update_report	PATCH /reports/{report_id}	Update Report
ResearchGoalsApi	create_research_goals	POST /researchGoals	Create Research Goals
ResearchGoalsApi	delete_research_goal	DELETE /researchGoals/{research_goal_id}	Delete Research Goal
ResearchGoalsApi	edit_research_goals	PATCH /researchGoals/{research_goal_id}	Edit Research Goals
ResearchGoalsApi	get_research_goal	GET /researchGoals/{research_goal_id}	Get Research Goal
ResearchGoalsApi	list_research_goals	GET /researchGoals	List Research Goals
ScriptGenerationApi	generate_interview_script	POST /scriptGeneration/generate	Generate Interview Script Suggestion
SolutionsApi	create_solution	POST /solutions	Create Solution
SolutionsApi	delete_solution	DELETE /solutions/{solution_id}	Delete Solution
SolutionsApi	edit_solution	PATCH /solutions/{solution_id}	Edit Solution
SolutionsApi	get_solution	GET /solutions/{solution_id}	Get Solution
SolutionsApi	list_solutions	GET /solutions	List Solutions
StudiesApi	create_study	POST /studies	Create Study
StudiesApi	delete_study	DELETE /studies/{study_id}	Delete Study
StudiesApi	edit_study	PATCH /studies/{study_id}	Edit Study
StudiesApi	generate_knowledge_graph	POST /studies/{study_id}/knowledge_graph	Generate Knowledge Graph
StudiesApi	generate_summary	POST /studies/{study_id}/summary	Generate Summary
StudiesApi	get_study	GET /studies/{study_id}	Get Study
StudiesApi	get_study_pdf	GET /studies/{study_id}/pdf	Download Study as PDF
StudiesApi	interview	POST /studies/{study_id}/interview	Interview
StudiesApi	list_studies	GET /studies	List Studies
StudiesApi	regenerate_all_interviews	POST /studies/{study_id}/regenerate	Regenerate All Interviews
StudiesApi	study_follow_up	POST /studies/{study_id}/follow_up	Study Follow Up
SubPlansApi	create_subplan	POST /subplans	Create Subplan
SubPlansApi	delete_subplan	DELETE /subplans/{subplan_id}	Delete Subplan
SubPlansApi	execute_subplan	POST /subplans/{subplan_id}/execute	Execute Subplan
SubPlansApi	extend_subplan	POST /subplans/{subplan_id}/extend	Extend Subplan
SubPlansApi	generate_subplan_report	POST /subplans/{subplan_id}/report	Generate Subplan Report
SubPlansApi	get_report_pdf	GET /subplans/{subplan_id}/report/{report_id}/pdf	Get Report Pdf
SubPlansApi	get_subplan	GET /subplans/{subplan_id}	Get Subplan
SubPlansApi	list_subplans	GET /subplans	List Subplans
SubPlansApi	subplan_follow_up	POST /subplans/{subplan_id}/follow_up	Subplan Follow Up
SubPlansApi	update_subplan	PATCH /subplans/{sub_plan_id}	Update Subplan
SuggestionsApi	create_suggestion	POST /suggestions	Create Suggestion
SuggestionsApi	delete_suggestion	DELETE /suggestions/{suggestion_id}	Delete Suggestion
SuggestionsApi	execute_suggestion	POST /suggestions/{suggestion_id}/execute	Execute Suggestion
SuggestionsApi	get_suggestion	GET /suggestions/{suggestion_id}	Get Suggestion
SuggestionsApi	list_suggestions	GET /suggestions	List Suggestions
SuggestionsApi	regenerate_suggestion	POST /suggestions/{suggestion_id}/regenerate	Regenerate Suggestion
SuggestionsApi	update_suggestion	PATCH /suggestions/{suggestion_id}	Update Suggestion
SummariesApi	export_summary	GET /summaries/{summary_id}/export	Export Summary
SummariesApi	get_summary	GET /summaries/{summary_id}	Get Summary
SummariesApi	list_summaries	GET /summaries	List Summaries
SummariesApi	summary_follow_up	POST /summaries/{summary_id}/follow_up	Summary Follow Up
SyntheticUsersApi	delete_synthetic_user	DELETE /syntheticUsers/{synthetic_user_id}	Delete Synthetic User
SyntheticUsersApi	edit_synthetic_user	PATCH /syntheticUsers/{synthetic_user_id}	Edit Synthetic User
SyntheticUsersApi	get_synthetic_user	GET /syntheticUsers/{synthetic_user_id}	Get Synthetic User
SyntheticUsersApi	list_synthetic_users	GET /syntheticUsers	List Synthetic Users
SyntheticUsersApi	regenerate_synthetic_user	POST /syntheticUsers/{synthetic_user_id}/regenerate	Regenerate Synthetic User
UsersApi	get_user	GET /users/{user_id}	Get User
UsersApi	list_users	GET /users	List Users
WorkspacesApi	get_workspace	GET /workspaces/{workspace_id}	Get Workspace
WorkspacesApi	list_workspaces	GET /workspaces	List Workspaces

Documentation For Models

• Annotation
• AppApiSchemasPlannerSubPlanType
• AppApiSchemasStudiesSubPlanType
• AppUtilsAnnotationCreate1
• AppUtilsAnnotationCreate2
• AssistantChat
• AssistantSession
• AssistantSessionCreate
• AssistantSessionMessage
• Audience
• AudienceCreate
• AudienceExtend
• AudienceGenerate
• AudienceUpdate
• ConceptBase
• ConceptInput
• Conversation
• ConversationCreate
• ConversationFeedback
• ConversationFeedbackComment
• ConversationFeedbackCreate
• ConversationFeedbackHelpful
• ConversationFeedbackType
• ConversationFeedbackUpdate
• ConversationReference
• Data
• File
• FileCreate
• FileDownloadURL
• FileWithPresignedURL
• GenerateTOCRequest
• HTTPValidationError
• Interview
• KnowledgeGraph
• PageAnnotation
• PageAssistantSession
• PageAudience
• PageConversation
• PageConversationFeedback
• PageFile
• PageInterview
• PageKnowledgeGraph
• PagePlan
• PageProblem
• PageProject
• PageResearchGoal
• PageSolution
• PageStandaloneReport
• PageStudy
• PageSubPlan
• PageSuggestion
• PageSummary
• PageSyntheticUser
• PageUser
• PageWorkspace
• Plan
• PlanCreate
• PlanUpdate
• Problem
• ProblemCreate
• ProblemUpdate
• Project
• ProjectUserRole
• Report
• ReportTOCEntryInput
• ReportTOCEntryOutput
• ResearchGoal
• ResearchGoalCreate
• ResearchGoalUpdate
• ScriptGenerationOutput
• ScriptGenerationRequest
• SessionCreate
• SessionResponse
• SessionUpdate
• Solution
• SolutionCreate
• SolutionUpdate
• StandaloneReport
• StandaloneReportCreate
• StandaloneReportUpdate
• StatusResponse
• Study
• StudyCreate
• StudyInterviews
• StudyProgress
• StudyUpdate
• SubPlan
• SubPlanCreate
• SubPlanExecutionOptions
• SubPlanReport
• SubPlanUpdate
• Suggestion
• SuggestionCreate
• SuggestionUpdate
• Summary
• SummaryCreate
• SummaryMessage
• SummaryMessageCreate
• SummarySection
• SyntheticUser
• SyntheticUserPartial
• User
• ValidationError
• ValidationErrorLocInner
• Workspace

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

Author