- labels:

- "api: aml-ai"

to:

- nickcook

This directory contains samples for Anti Money Laundering AI (AML AI). Use this API to produce risk scores and accompanying explainability output to support your alerting and investigation process. For more information, see the

[Anti Money Laundering AI documentation](https://cloud.google.com/financial-services/anti-money-laundering/).

To run the samples, you need to first follow the steps in

[Set up a project and permissions](https://cloud.google.com/financial-services/anti-money-laundering/docs/set-up-project-permissions).

For more information on authentication, refer to the

[Authentication Getting Started Guide](https://cloud.google.com/docs/authentication/getting-started).

1. Clone python-docs-samples repository and change directories to the sample directory

you want to use.

$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

1. Install [pip](https://pip.pypa.io/) and

[virtualenv](https://virtualenv.pypa.io/) if you do not already have them. You

may want to refer to the

[Python Development Environment Setup Guide](https://cloud.google.com/python/setup)

for Google Cloud Platform for instructions.

1. Create a virtualenv. Samples are compatible with Python 3.6+.

$ virtualenv env

$ source env/bin/activate

1. Install the dependencies needed to run the samples.

$ pip install -r requirements.txt

Make sure to enable the AML AI API on the test project. Set the following

environment variable:

* `GOOGLE_CLOUD_PROJECT`

import argparse

import os

import google.auth

from google.auth.transport import requests

def list_locations(

project_id: str,

) -> google.auth.transport.Response:

"""Lists the AML AI locations using the REST API."""

# TODO(developer): Uncomment these lines and replace with your values.

# project_id = 'my-project' # The Google Cloud project ID.

# Gets credentials from the environment. google.auth.default() returns credentials and the

# associated project ID, but in this sample, the project ID is passed in manually.

credentials, _ = google.auth.default(

scopes=[

"https://www.googleapis.com/auth/cloud-platform",

]

)

authed_session = requests.AuthorizedSession(credentials)

# URL to the AML AI API endpoint and version

base_url = "https://financialservices.googleapis.com/v1"

url = f"{base_url}/projects/{project_id}/locations/"

# Sets required "application/json" header on the request

headers = {"Content-Type": "application/json; charset=utf-8"}

response = authed_session.get(url, headers=headers)

response.raise_for_status()

print(response.text)

return response

if __name__ == "__main__":

parser = argparse.ArgumentParser()

parser.add_argument(

"--project_id",

default=(os.environ.get("GOOGLE_CLOUD_PROJECT")),

help="Google Cloud project name",

)

args = parser.parse_args()

list_locations(

args.project_id,

)

import json

import os

import pytest

import list_locations

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]

def test_locations(capsys: pytest.fixture) -> None:

# List the locations of the API

r = list_locations.list_locations(project_id)

locations = json.loads(r.text)

found = False

name = f"projects/{project_id}/locations/us-central1"

for location in locations["locations"]:

location_name = location["name"]

if location_name == name:

found = True

break

assert found

pytest==8.2.0