Config#

pydantic settings Settings[source]#

Default configuration for the Prescient SDK.

Configuration is handled using [pydantic-settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/)

Order of precedence for configuration values:

  1. Environment variables are always highest precedence and will override any other configuration values

  2. config.env file: if a config.env file is present in the root of the project, it will be used

Fields:
field prescient_auth_provider: Literal['microsoft', 'google'] = 'microsoft'#

OAuth2 authentication provider. Determines which provider-specific fields are required.

field prescient_auth_token_path: str | None = None#

Deprecated. Retained for backwards compatibility; no longer used.

field prescient_auth_url: str [Required]#

OAuth2 token endpoint URL used to exchange credentials for access tokens.

field prescient_aws_region: str | None = None#

AWS region used when assuming prescient_aws_role. Required only when that role is set.

field prescient_aws_role: str | None = None#

Optional AWS IAM role ARN. When set, the client assumes this role via STS to obtain bucket credentials. When unset, the client fetches temporary credentials from the Prescient API’s /fileproxy/credentials endpoint.

field prescient_client_id: str [Required]#

OAuth2 client ID issued by the selected authentication provider.

field prescient_endpoint_url: str [Required]#

Base URL of the Prescient API endpoint.

field prescient_google_client_secret: str | None = None#

Google OAuth2 client secret. Required when prescient_auth_provider is google.

field prescient_google_redirect_port: int | None = 8765#

Loopback port for the Google OAuth2 redirect URI. Set to the registered port when using a Web-application OAuth client; leave as the default for Desktop-app OAuth clients, which permit any local port.

field prescient_tenant_id: str | None = None#

Microsoft Entra tenant ID. Required when prescient_auth_provider is microsoft.

field prescient_upload_bucket: str | None = None#

Optional AWS S3 bucket name targeted by the upload helpers.

field prescient_upload_role: str | None = None#

Optional AWS IAM role ARN used by the upload helpers to write to the upload bucket.