API and Resource Unit Consumption
API and Resource Unit Consumption

API and Resource Unit Consumption

Haven OnDemand tracks usage in two ways:

  • Resource Units track usage of resources, such as text indexes, which reside in the Haven OnDemand system.
  • API Units track usage of APIs.

Resource Units

The total monthly resource unit cost is the total resource unit cost of all of your resources rounded up to the next integer.

The cost of an individual resource is calculated on an hourly basis. The cost of a resource for each hour is equal to the peak resource unit cost of that resource within that hour. A resource's monthly cost is the average of the hourly cost of that resource over that month.

Connector Resource Types

Onsite Connectors cost 0 resource units. Instead an API unit cost is incurred when the connector runs.

The resource unit cost of a Cloud Connector with a schedule is determined by the number of runs that would be made in a month. The cost per run is based on the maximum duration.

Maximum Duration Runs per Resource Unit
Less than or equal to 20 minutes 300
Greater than 20 minutes and less than or equal to 1 hour 100
Greater than 1 hour and less than or equal to 6 hours 20
Greater than 6 hours and less than or equal to 1 day 5

All connector schedules are capped at 10 resource units.

If no schedule is specified then the resource unit cost is 0. This would be the case if you wanted to start your Connector manually though this will incur an API unit cost.

Text Index Resource Types

Text indexes use resource units based on the flavor type, and the amount of data.

Each text index flavor has a resource unit cost, which is the cost for each index component, determined by the maximum index size and specialization. When a text index exceeds the quota size for the index component, Haven OnDemand creates a new component for the text index, up to your total available units. You can also create additional text indexes up to your total available units.

For more information about the different flavors, see Index Flavors.

You can view the total units for your account on the Account Management Quotas page.

Flavor type Maximum index size for each component Resource unit cost for each component
Explorer 100 MB 1
Standard 10 GB 10
Jumbo 40 GB 20
Custom Fields 10 GB 12
Query Manipulation 500 MB 12
Categorization 1 GB 15

Query Profile Resource Types

Query Profile resources do not have a resource unit cost, but they are subject to quota limitations. For more information, see Query Manipulation Limits and Rate Limiting, Quotas, Data Expiry, and Maximums.

API Units

For most APIs, usage is tracked for each call. For resource-intensive APIs, such as Speech Recognition and OCR Document, the API usage depends on the amount of data to process, as well as the number of calls that you make.

You can view your API usage on the Account Management Quotas page.

API API Units
List Resources, Index Status, Connector Status No API unit cost
Speech Recognition, Detect Scene Changes 0.5 API units for every second of media1
License Plate Recognition, Face Detection 0.5 API units for every second of video1
OR
0.5 API units for every image in a document1
Analyze Media See Analyze Media API
OCR Document 1 API unit for each page
Expand Container 1 API unit for every 100 MB
Search API calls against user text indexes No API unit cost incurred
Create Connector 1 API unit if there is no schedule
70 API units when the maximum duration is less than or equal to 20 minutes
200 API units when the maximum duration is greater than 20 minutes and less than or equal to 1 hour
1200 API units when the maximum duration is greater than 1 hour and less than or equal to 6 hours
4800 API units when the maximum duration is greater than 6 hours and less than or equal to 1 day
Update Connector 1 API unit if the schedule is not changed or is removed
70 API units when the maximum duration of the new schedule is less than or equal to 20 minutes
200 API units when the maximum duration of the new schedule is greater than 20 minutes and less than or equal to 1 hour
1200 API units when the maximum duration of the new schedule is greater than 1 hour and less than or equal to 6 hours
4800 API units when the maximum duration of the new schedule is greater than 6 hours and less than or equal to 1 day
Start Connector 70 API units when the maximum duration is less than or equal to 20 minutes
200 API units when the maximum duration is greater than 20 minutes and less than or equal to 1 hour
1200 API units when the maximum duration is greater than 1 hour and less than or equal to 6 hours
4800 API units when the maximum duration is greater than 6 hours and less than or equal to 1 day
All other APIs 1 API unit per call
APIs that accept multiple inputs with discrete results consume 1 API unit for each input

1. API unit costs are rounded down to the nearest integer. For example, if the total cost of your API call would be 1.5 or 1.75 API units, Haven OnDemand charges 1. However, the minimum cost for any API call is 1 API unit.

Analyze Media API

The Analyze Media API allows you to perform multiple Media Analytics API functions on the same input file. This API uses the media processing resources more efficiently than calling the APIs individually, and so the API cost is calculated according to the following rules:

  • For the first analytic: 0.5 API units for every second of media OR 0.5 API units for every image in a document.
  • For subsequent analytics: 0.25 API units for every second of media OR 0.25 API units for every image in a document.

For example, if you want to run Detect Scene Changes and Speech Recognition on a media file, the cost is 0.75 per second (that is, 0.5 + 0.25).

Note: API unit costs are rounded down to the nearest integer. For example, if the total cost of your API call would be 1.5 or 1.75 API units, Haven OnDemand charges 1. However, the minimum cost for any API call is 1 API unit.