FAQ¶
What version of the Python Client should I use?¶
The Python Client just cares about features, and will try everything it knows to implement those features correctly, independent of the API version.
If you are starting a new project or your existing project does not yet use the Python Client, we encourage you to use the latest stable version of the Python Client.
Otherwise, check the Change Log to see:
what new features and bug fixes are available in newer versions
which breaking changes (if any) will require changes in your code to get those new features and bug fixes
Note: You do not need to reason about the Tamr API version nor the the Tamr app/server version.
How do I call custom endpoints, e.g. endpoints outside the Tamr API?¶
To call a custom endpoint within the Tamr API, use the client.request() method, and provide an endpoint described by a path relative to base_path.
For example, if base_path is /api/versioned/v1/ (the default), and you want to get /api/versioned/v1/projects/1, you only need to provide projects/1 (the relative ID provided by the project) as the endpoint, and the Client will resolve that into /api/versioned/v1/projects/1.
There are various APIs outside the /api/versioned/v1/ prefix that are often useful or necessary to call - e.g. /api/service/health, or other un-versioned / unsupported APIs. To call a custom endpoint outside the Tamr API, use the client.request() method, and provide an endpoint described by an absolute path (a path starting with /). For example, to get /api/service/health (no matter what base_path is), call client.request() with /api/service/health as the endpoint. The Client will ignore base_path and send the request directly against the absolute path provided.
For additional detail, see [Raw HTTP requests and Unversioned API Access](<user-guide/advanced-usage:Raw HTTP requests and Unversioned API Access>)