Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.haiqu.ai/llms.txt

Use this file to discover all available pages before exploring further.

AWS credentials management

static Haiqu.save_aws_credentials(aws_access_key_id, aws_secret_access_key, aws_default_region=‘us-east-1’)

Save AWS credentials in the environment variables:
  • “AWS_ACCESS_KEY_ID”
  • “AWS_SECRET_ACCESS_KEY”
  • “AWS_DEFAULT_REGION”
NOTE: overwrites existing environment variables with the same names.
  • Parameters:
    • aws_access_key_id (str) — AWS access key ID.
    • aws_secret_access_key (str) — AWS secret access key.
    • aws_default_region (str) — AWS default region. Defaults to “us-west-2”.

static Haiqu.update_aws_credentials(options)

Inline update options dictionary with AWS credentails values:
  • “aws_access_key_id”
  • “aws_secret_access_key”
  • “aws_default_region”
Priorities:
  1. Implicit values in “options” dictionary.
  2. Environment variables.
  3. AWS credentials and config files.
  • Parameters: options (dict) — Backend options dictionary.

IBM Quantum credentials management

static Haiqu.save_ibm_credentials(ibm_quantum_token, ibm_quantum_instance)

Save IBM Quantum API token and instance using QiskitRuntimeService with the name “haiqu_ibm_account”. NOTE: overwrites existing account with the name “haiqu_ibm_account”.
  • Parameters:
    • ibm_quantum_token (str) — IBM Quantum API token.
    • ibm_quantum_instance (str) — IBM Quantum instance name.

static Haiqu.update_ibm_credentials(options)

Inline update options dictionary with IBM Quantum API token value “ibm_quantum_token”. Priorities:
  1. Implicit value in “options” dictionary.
  2. IBM Quantum config file.
  • Parameters: options (dict) — Options dictionary.