Client

class arango_ai_sdk.ArangoAIClient(base_url, username, password, db_name='_system', *, verify=True)

Entry point to the Arango AI Suite.

Not to be confused with the concept of a communication client, this is a client interface to the AI suite SDK, it does not perform any communication tasks by itself.

Parameters:
  • base_url (str) – Full platform endpoint, port included, exactly as the deployment publishes it – e.g. https://deployment.<cluster>.svc:8529.

  • username (str) – Username to authenticate with.

  • password (str) – Password to authenticate with. Held in memory for the client’s lifetime, which is what token renewal needs, and never exposed again.

  • db_name (str, optional) – Database to connect to. Defaults to _system.

  • verify (bool or str, optional) – TLS certificate verification. True (the default) checks the deployment’s certificate against the system’s trusted authorities, a path names a CA bundle to use instead, and False disables the check for deployments that publish a self-signed certificate.

Raises:
property base_url: str

Full platform endpoint this client talks to, port included.

property username: str

Username this client authenticates with.

property db_name: str

Database this client is connected to.

property project: ProjectManager

Namespace for creating a project on the platform.

property secret_profile: SecretProfileManager

Namespace for creating and fetching secret profiles on the platform.

property files: FileManager

uploading today, more later.

Type:

Namespace for the files a project will ingest

close()

Release the network resources this client holds.

Forwards to the communication layer, which closes the driver’s HTTP sessions and the sockets they keep alive. Safe to call more than once.

Return type:

None