All URIs are relative to https://localhost/assets-api
| Method | HTTP request | Description |
|---|---|---|
| advanced_search_request | POST /v1/search/advancedSearch | Advanced Search Request. Please see the structure of the request. The following operations are supported: [In, Contains, Is, GreaterThan, LessThan, IsNot, NotIn, NotContains]. |
| aiware_type_ahead_terms | GET /v1/search/aiwareTypeAheadTerms | Get the list of the aiware terms with document count that match the prefix text. |
| anonymous_asset_access_check | GET /v1/search/anonymous/accessCheck | Check anonymous access to assets by id for a site. |
| asset_access_check | GET /v1/search/accessCheck | Check access to assets by id for a logged in user. |
| asset_access_check_for_user | GET /v1/search/accessCheckForUser | Check access to assets by id for a supplied userName. |
| asset_access_check_for_user_get_v1_search_access_check_for_user_by_id | GET /v1/search/accessCheckForUser/{id} | Check access to assets by id for a supplied userName. |
| asset_access_pricing_check | GET /v1/search/accessPricingCheck | Check access to assets for pricing by id for a logged in user. |
| asset_aiware_search | GET /v1/search/aiware | Asset search. |
| asset_solr_cloud_anon_search | GET /v1/search/anonymous | Anonymous asset search. |
| asset_solr_cloud_anon_search_term | GET /v1/search/anonymous/searchTerms | Get the list of the search terms with document count that match the prefix text. |
| asset_solr_cloud_search | GET /v1/search | Asset search. |
| asset_vector_search | GET /v1/search/vector | Asset search. |
| find_entities | GET /v1/search/aiware/entities | Retrieve entities from aiware for the logged in user. |
| related_asset_search | GET /v1/search/anonymous/relatedAssets/{assetId}/{configId} | Anonymous asset search. |
| related_asset_search_get_v1_search_related_assets_by_asset_id_by_config_id | GET /v1/search/relatedAssets/{assetId}/{configId} | Anonymous asset search. |
| search_for_user | GET /v1/search/assetSearchForUser | |
| search_terms | GET /v1/search/searchTerms | Get the list of the search terms with document count that match the prefix text. |
| thesaurus_terms | GET /v1/search/thesaurusTerms | Get the list of the thesaurus terms with document count that match the prefix text. |
| thesaurus_terms_get_v1_search_type_ahead_terms | GET /v1/search/typeAheadTerms | Get the list of the thesaurus terms with document count that match the prefix text. |
Page advanced_search_request(body=body)
Advanced Search Request. Please see the structure of the request. The following operations are supported: [In, Contains, Is, GreaterThan, LessThan, IsNot, NotIn, NotContains].
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
body = veritone_dmh.AdvancedSearchRequest() # AdvancedSearchRequest | (optional)
try:
# Advanced Search Request. Please see the structure of the request. The following operations are supported: [In, Contains, Is, GreaterThan, LessThan, IsNot, NotIn, NotContains].
api_response = api_instance.advanced_search_request(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->advanced_search_request: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | AdvancedSearchRequest | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListAiwareTypeAheadTerm aiware_type_ahead_terms(site_name, q, cognition_type=cognition_type, max_terms=max_terms, prefix=prefix)
Get the list of the aiware terms with document count that match the prefix text.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | Site where assets are located
q = 'q_example' # str | The prefix text to retrieve matched search terms for
cognition_type = 'all' # str | Cognition type to retrieve terms for (optional) (default to all)
max_terms = 10 # int | Maximum number of terms to retrieve (optional) (default to 10)
prefix = false # bool | True means search terms that start with text. False means terms that contains this text within it. (optional) (default to false)
try:
# Get the list of the aiware terms with document count that match the prefix text.
api_response = api_instance.aiware_type_ahead_terms(site_name, q, cognition_type=cognition_type, max_terms=max_terms, prefix=prefix)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->aiware_type_ahead_terms: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| site_name | str | Site where assets are located | |
| q | str | The prefix text to retrieve matched search terms for | |
| cognition_type | str | Cognition type to retrieve terms for | [optional] [default to all] |
| max_terms | int | Maximum number of terms to retrieve | [optional] [default to 10] |
| prefix | bool | True means search terms that start with text. False means terms that contains this text within it. | [optional] [default to false] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListLong anonymous_asset_access_check(site_name, assets)
Check anonymous access to assets by id for a site.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | Site where assets are located
assets = 'assets_example' # str | Comma Separated list of assets to retrieve
try:
# Check anonymous access to assets by id for a site.
api_response = api_instance.anonymous_asset_access_check(site_name, assets)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->anonymous_asset_access_check: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| site_name | str | Site where assets are located | |
| assets | str | Comma Separated list of assets to retrieve |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListLong asset_access_check(assets)
Check access to assets by id for a logged in user.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
assets = 'assets_example' # str | Comma Separated list of assets to retrieve
try:
# Check access to assets by id for a logged in user.
api_response = api_instance.asset_access_check(assets)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_access_check: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| assets | str | Comma Separated list of assets to retrieve |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListLong asset_access_check_for_user(assets, site_name=site_name, user_name=user_name)
Check access to assets by id for a supplied userName.
Required Permissions: Root Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
assets = 'assets_example' # str | Comma Separated list of assets to retrieve
site_name = 'site_name_example' # str | (optional)
user_name = 'user_name_example' # str | (optional)
try:
# Check access to assets by id for a supplied userName.
api_response = api_instance.asset_access_check_for_user(assets, site_name=site_name, user_name=user_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_access_check_for_user: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| assets | str | Comma Separated list of assets to retrieve | |
| site_name | str | [optional] | |
| user_name | str | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListLong asset_access_check_for_user_get_v1_search_access_check_for_user_by_id(assets, id, site_name=site_name)
Check access to assets by id for a supplied userName.
Required Permissions: Root Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
assets = 'assets_example' # str | Comma Separated list of assets to retrieve
id = 789 # int |
site_name = 'site_name_example' # str | (optional)
try:
# Check access to assets by id for a supplied userName.
api_response = api_instance.asset_access_check_for_user_get_v1_search_access_check_for_user_by_id(assets, id, site_name=site_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_access_check_for_user_get_v1_search_access_check_for_user_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| assets | str | Comma Separated list of assets to retrieve | |
| id | int | ||
| site_name | str | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListLong asset_access_pricing_check(assets, site_name=site_name)
Check access to assets for pricing by id for a logged in user.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
assets = 'assets_example' # str | Comma Separated list of assets to retrieve
site_name = 'site_name_example' # str | Site where assets are located (optional)
try:
# Check access to assets for pricing by id for a logged in user.
api_response = api_instance.asset_access_pricing_check(assets, site_name=site_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_access_pricing_check: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| assets | str | Comma Separated list of assets to retrieve | |
| site_name | str | Site where assets are located | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Page asset_aiware_search(q=q, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, gq=gq, afn=afn)
Asset search.
Required Permissions: There are no required permissions for this endpoint. Developer Information:
- All filter ids are dependent on what site the search is being performed on.
- If left blank, the default value for sortId is 0.
- filterIds and filterValues are OPTIONAL fields. However, if you list one or more filterIds — AND the filterId requires a value — they must be accompanied by the appropriatevalues in the filterValues field.
- Filter Example 1: (Warning: filterId numbers will vary based on your site.) If you enter '1517' as a filterId, the filterValue field should include the filterId and a date or date range ('1517:11/28/2016 - 11/29/2016'). In this case, if no timestamp is included, the results will include all clips from that date, regardless of time.To include a timestamp, use the following format: '1998-03-04 23:59:59'.
- Filter Example 2: (Warning: filterId numbers will vary based on your site.) To use multiple filterIds use a comma-separated list for both filterIds and filterValues. If you enter '123,456,789' into the filterId field,you should enter '123:1080i,456:archive,789:"Rights Managed"' into the filterValue field.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
q = 'q_example' # str | Query string. If left blank, it will return all clips. (optional)
sort_id = 789 # int | Sort id. If left blank, it will sort based on the configured default. (optional)
i = 0 # int | Page index number. Initial page is 0. (optional) (default to 0)
n = 20 # int | Number of results per page. The maximum number is 200. (optional) (default to 20)
filter_ids = 'filter_ids_example' # str | Comma separated list of filter ids to be applied to the query, regardless of whether those filters require values. (optional)
filter_values = 'filter_values_example' # str | Comma separated pairs of filter ids and filter values. To be used when a filter id requires a value. Format is filterId:value, filterId:value. (optional)
gq = 'gq_example' # str | Gallery query string. (optional)
afn = 'afn_example' # str | Asset Fields Name config string. (optional)
try:
# Asset search.
api_response = api_instance.asset_aiware_search(q=q, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, gq=gq, afn=afn)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_aiware_search: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| q | str | Query string. If left blank, it will return all clips. | [optional] |
| sort_id | int | Sort id. If left blank, it will sort based on the configured default. | [optional] |
| i | int | Page index number. Initial page is 0. | [optional] [default to 0] |
| n | int | Number of results per page. The maximum number is 200. | [optional] [default to 20] |
| filter_ids | str | Comma separated list of filter ids to be applied to the query, regardless of whether those filters require values. | [optional] |
| filter_values | str | Comma separated pairs of filter ids and filter values. To be used when a filter id requires a value. Format is filterId:value, filterId:value. | [optional] |
| gq | str | Gallery query string. | [optional] |
| afn | str | Asset Fields Name config string. | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PageAssetSummary asset_solr_cloud_anon_search(site_name, q=q, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, gq=gq, afn=afn)
Anonymous asset search.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | Site where assets are located
q = 'q_example' # str | Keyword in an asset's name (ex:lighthouses) (optional)
sort_id = 789 # int | Sort id (optional)
i = 0 # int | Page index (optional) (default to 0)
n = 20 # int | Number of results per page (optional) (default to 20)
filter_ids = 'filter_ids_example' # str | Optional comma separated list of filter Ids (optional)
filter_values = 'filter_values_example' # str | Optional comma separated list of filter values. The filter value must follow the format: filterId:value text. For example: 12345:02/03/2016 (optional)
gq = 'gq_example' # str | Optional. Gallery query. If included, search will run a galleryQuery search. Otherwise a normal search will proceed. (optional)
afn = 'afn_example' # str | Optional. Asset Fields Name config string. (optional)
try:
# Anonymous asset search.
api_response = api_instance.asset_solr_cloud_anon_search(site_name, q=q, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, gq=gq, afn=afn)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_solr_cloud_anon_search: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| site_name | str | Site where assets are located | |
| q | str | Keyword in an asset's name (ex:lighthouses) | [optional] |
| sort_id | int | Sort id | [optional] |
| i | int | Page index | [optional] [default to 0] |
| n | int | Number of results per page | [optional] [default to 20] |
| filter_ids | str | Optional comma separated list of filter Ids | [optional] |
| filter_values | str | Optional comma separated list of filter values. The filter value must follow the format: filterId:value text. For example: 12345:02/03/2016 | [optional] |
| gq | str | Optional. Gallery query. If included, search will run a galleryQuery search. Otherwise a normal search will proceed. | [optional] |
| afn | str | Optional. Asset Fields Name config string. | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CountedSearchTerms asset_solr_cloud_anon_search_term(site_name, q, max_terms=max_terms, prefix=prefix)
Get the list of the search terms with document count that match the prefix text.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | Site where assets are located
q = 'q_example' # str | The prefix text to retrieve matched search terms for
max_terms = 10 # int | Maximum number of terms to retrieve (optional) (default to 10)
prefix = false # bool | True means search terms that start with the text. False means terms that contains this text within it. (optional) (default to false)
try:
# Get the list of the search terms with document count that match the prefix text.
api_response = api_instance.asset_solr_cloud_anon_search_term(site_name, q, max_terms=max_terms, prefix=prefix)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_solr_cloud_anon_search_term: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| site_name | str | Site where assets are located | |
| q | str | The prefix text to retrieve matched search terms for | |
| max_terms | int | Maximum number of terms to retrieve | [optional] [default to 10] |
| prefix | bool | True means search terms that start with the text. False means terms that contains this text within it. | [optional] [default to false] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Page asset_solr_cloud_search(q=q, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, gq=gq, afn=afn)
Asset search.
Required Permissions: There are no required permissions for this endpoint. Developer Information:
- All filter ids are dependent on what site the search is being performed on.
- If left blank, the default value for sortId is 0.
- filterIds and filterValues are OPTIONAL fields. However, if you list one or more filterIds — AND the filterId requires a value — they must be accompanied by the appropriatevalues in the filterValues field.
- Filter Example 1: (Warning: filterId numbers will vary based on your site.) If you enter '1517' as a filterId, the filterValue field should include the filterId and a date or date range ('1517:11/28/2016 - 11/29/2016'). In this case, if no timestamp is included, the results will include all clips from that date, regardless of time.To include a timestamp, use the following format: '1998-03-04 23:59:59'.
- Filter Example 2: (Warning: filterId numbers will vary based on your site.) To use multiple filterIds use a comma-separated list for both filterIds and filterValues. If you enter '123,456,789' into the filterId field,you should enter '123:1080i,456:archive,789:"Rights Managed"' into the filterValue field.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
q = 'q_example' # str | Query string. If left blank, it will return all clips. (optional)
sort_id = 789 # int | Sort id. If left blank, it will sort based on the configured default. (optional)
i = 0 # int | Page index number. Initial page is 0. (optional) (default to 0)
n = 20 # int | Number of results per page. The maximum number is 200. (optional) (default to 20)
filter_ids = 'filter_ids_example' # str | Comma separated list of filter ids to be applied to the query, regardless of whether those filters require values. (optional)
filter_values = 'filter_values_example' # str | Comma separated pairs of filter ids and filter values. To be used when a filter id requires a value. Format is filterId:value, filterId:value. (optional)
gq = 'gq_example' # str | Gallery query string. (optional)
afn = 'afn_example' # str | Asset Fields Name config string. (optional)
try:
# Asset search.
api_response = api_instance.asset_solr_cloud_search(q=q, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, gq=gq, afn=afn)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_solr_cloud_search: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| q | str | Query string. If left blank, it will return all clips. | [optional] |
| sort_id | int | Sort id. If left blank, it will sort based on the configured default. | [optional] |
| i | int | Page index number. Initial page is 0. | [optional] [default to 0] |
| n | int | Number of results per page. The maximum number is 200. | [optional] [default to 20] |
| filter_ids | str | Comma separated list of filter ids to be applied to the query, regardless of whether those filters require values. | [optional] |
| filter_values | str | Comma separated pairs of filter ids and filter values. To be used when a filter id requires a value. Format is filterId:value, filterId:value. | [optional] |
| gq | str | Gallery query string. | [optional] |
| afn | str | Asset Fields Name config string. | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Page asset_vector_search(q=q, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, afn=afn, site_name=site_name)
Asset search.
Required Permissions: There are no required permissions for this endpoint. Developer Information:
- All filter ids are dependent on what site the search is being performed on.
- If left blank, the default value for sortId is 0.
- filterIds and filterValues are OPTIONAL fields. However, if you list one or more filterIds — AND the filterId requires a value — they must be accompanied by the appropriatevalues in the filterValues field.
- Filter Example 1: (Warning: filterId numbers will vary based on your site.) If you enter '1517' as a filterId, the filterValue field should include the filterId and a date or date range ('1517:11/28/2016 - 11/29/2016'). In this case, if no timestamp is included, the results will include all clips from that date, regardless of time.To include a timestamp, use the following format: '1998-03-04 23:59:59'.
- Filter Example 2: (Warning: filterId numbers will vary based on your site.) To use multiple filterIds use a comma-separated list for both filterIds and filterValues. If you enter '123,456,789' into the filterId field,you should enter '123:1080i,456:archive,789:"Rights Managed"' into the filterValue field.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
q = 'q_example' # str | Query string. If left blank, it will return all clips. (optional)
sort_id = 789 # int | Sort id. If left blank, it will sort based on the configured default. (optional)
i = 0 # int | Page index number. Initial page is 0. (optional) (default to 0)
n = 20 # int | Number of results per page. The maximum number is 200. (optional) (default to 20)
filter_ids = 'filter_ids_example' # str | Comma separated list of filter ids to be applied to the query, regardless of whether those filters require values. (optional)
filter_values = 'filter_values_example' # str | Comma separated pairs of filter ids and filter values. To be used when a filter id requires a value. Format is filterId:value, filterId:value. (optional)
afn = 'afn_example' # str | Asset Fields Name config string. (optional)
site_name = 'site_name_example' # str | Site to search (optional)
try:
# Asset search.
api_response = api_instance.asset_vector_search(q=q, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, afn=afn, site_name=site_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->asset_vector_search: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| q | str | Query string. If left blank, it will return all clips. | [optional] |
| sort_id | int | Sort id. If left blank, it will sort based on the configured default. | [optional] |
| i | int | Page index number. Initial page is 0. | [optional] [default to 0] |
| n | int | Number of results per page. The maximum number is 200. | [optional] [default to 20] |
| filter_ids | str | Comma separated list of filter ids to be applied to the query, regardless of whether those filters require values. | [optional] |
| filter_values | str | Comma separated pairs of filter ids and filter values. To be used when a filter id requires a value. Format is filterId:value, filterId:value. | [optional] |
| afn | str | Asset Fields Name config string. | [optional] |
| site_name | str | Site to search | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListAiwareTypeAheadTerm find_entities(site_name, entity_ids)
Retrieve entities from aiware for the logged in user.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | Site where assets are located
entity_ids = 'entity_ids_example' # str | Comma separated list of entity ids to retrieve
try:
# Retrieve entities from aiware for the logged in user.
api_response = api_instance.find_entities(site_name, entity_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->find_entities: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| site_name | str | Site where assets are located | |
| entity_ids | str | Comma separated list of entity ids to retrieve |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PageAssetSummary related_asset_search(asset_id, config_id, site_name=site_name, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, afn=afn)
Anonymous asset search.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
asset_id = 'asset_id_example' # str | Asset Id to find related assets for
config_id = 'config_id_example' # str | Related Query config Id
site_name = 'site_name_example' # str | Site where assets are located (optional)
sort_id = 789 # int | Sort id (optional)
i = 0 # int | Page index (optional) (default to 0)
n = 20 # int | Number of results per page (optional) (default to 20)
filter_ids = 'filter_ids_example' # str | Optional comma separated list of filter Ids (optional)
filter_values = 'filter_values_example' # str | Optional comma separated list of filter values. The filter value must follow the format: filterId:value text. For example: 12345:02/03/2016 (optional)
afn = 'afn_example' # str | Optional. Asset Fields Name config string. (optional)
try:
# Anonymous asset search.
api_response = api_instance.related_asset_search(asset_id, config_id, site_name=site_name, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, afn=afn)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->related_asset_search: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| asset_id | str | Asset Id to find related assets for | |
| config_id | str | Related Query config Id | |
| site_name | str | Site where assets are located | [optional] |
| sort_id | int | Sort id | [optional] |
| i | int | Page index | [optional] [default to 0] |
| n | int | Number of results per page | [optional] [default to 20] |
| filter_ids | str | Optional comma separated list of filter Ids | [optional] |
| filter_values | str | Optional comma separated list of filter values. The filter value must follow the format: filterId:value text. For example: 12345:02/03/2016 | [optional] |
| afn | str | Optional. Asset Fields Name config string. | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PageAssetSummary related_asset_search_get_v1_search_related_assets_by_asset_id_by_config_id(asset_id, config_id, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, afn=afn)
Anonymous asset search.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
asset_id = 'asset_id_example' # str | Asset Id to find related assets for
config_id = 'config_id_example' # str | Related Query config Id
sort_id = 789 # int | Sort id (optional)
i = 0 # int | Page index (optional) (default to 0)
n = 20 # int | Number of results per page (optional) (default to 20)
filter_ids = 'filter_ids_example' # str | Optional comma separated list of filter Ids (optional)
filter_values = 'filter_values_example' # str | Optional comma separated list of filter values. The filter value must follow the format: filterId:value text. For example: 12345:02/03/2016 (optional)
afn = 'afn_example' # str | Optional. Asset Fields Name config string. (optional)
try:
# Anonymous asset search.
api_response = api_instance.related_asset_search_get_v1_search_related_assets_by_asset_id_by_config_id(asset_id, config_id, sort_id=sort_id, i=i, n=n, filter_ids=filter_ids, filter_values=filter_values, afn=afn)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->related_asset_search_get_v1_search_related_assets_by_asset_id_by_config_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| asset_id | str | Asset Id to find related assets for | |
| config_id | str | Related Query config Id | |
| sort_id | int | Sort id | [optional] |
| i | int | Page index | [optional] [default to 0] |
| n | int | Number of results per page | [optional] [default to 20] |
| filter_ids | str | Optional comma separated list of filter Ids | [optional] |
| filter_values | str | Optional comma separated list of filter values. The filter value must follow the format: filterId:value text. For example: 12345:02/03/2016 | [optional] |
| afn | str | Optional. Asset Fields Name config string. | [optional] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PageAssetSummary search_for_user(user_name, site_name, assets=assets, sort_id=sort_id, i=i, n=n)
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
user_name = 'user_name_example' # str | Username to search as.
site_name = 'site_name_example' # str | Sitename for search user.
assets = 'assets_example' # str | Comma Separated list of assets to retrieve. (optional)
sort_id = 789 # int | Sort id. If left blank, it will sort based on the configured default. (optional)
i = 0 # int | Page index number. Initial page is 0. (optional) (default to 0)
n = 20 # int | Number of results per page. The maximum number is 200. (optional) (default to 20)
try:
api_response = api_instance.search_for_user(user_name, site_name, assets=assets, sort_id=sort_id, i=i, n=n)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->search_for_user: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| user_name | str | Username to search as. | |
| site_name | str | Sitename for search user. | |
| assets | str | Comma Separated list of assets to retrieve. | [optional] |
| sort_id | int | Sort id. If left blank, it will sort based on the configured default. | [optional] |
| i | int | Page index number. Initial page is 0. | [optional] [default to 0] |
| n | int | Number of results per page. The maximum number is 200. | [optional] [default to 20] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CountedSearchTerms search_terms(q, max_terms=max_terms, prefix=prefix)
Get the list of the search terms with document count that match the prefix text.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
q = 'q_example' # str | The prefix text to retrieve matched search terms for
max_terms = 10 # int | Maximum number of terms to retrieve (optional) (default to 10)
prefix = false # bool | True means search terms that start with the text. False means terms that contains this text within it. (optional) (default to false)
try:
# Get the list of the search terms with document count that match the prefix text.
api_response = api_instance.search_terms(q, max_terms=max_terms, prefix=prefix)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->search_terms: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| q | str | The prefix text to retrieve matched search terms for | |
| max_terms | int | Maximum number of terms to retrieve | [optional] [default to 10] |
| prefix | bool | True means search terms that start with the text. False means terms that contains this text within it. | [optional] [default to false] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListString thesaurus_terms(site_name, q, max_terms=max_terms)
Get the list of the thesaurus terms with document count that match the prefix text.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | Site where assets are located
q = 'q_example' # str | The prefix text to retrieve matched search terms for
max_terms = 10 # int | Maximum numbr of terms to retrieve (optional) (default to 10)
try:
# Get the list of the thesaurus terms with document count that match the prefix text.
api_response = api_instance.thesaurus_terms(site_name, q, max_terms=max_terms)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->thesaurus_terms: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| site_name | str | Site where assets are located | |
| q | str | The prefix text to retrieve matched search terms for | |
| max_terms | int | Maximum numbr of terms to retrieve | [optional] [default to 10] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiListString thesaurus_terms_get_v1_search_type_ahead_terms(site_name, q, max_terms=max_terms, prefix=prefix)
Get the list of the thesaurus terms with document count that match the prefix text.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.SearchApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | Site where assets are located
q = 'q_example' # str | The prefix text to retrieve matched search terms for
max_terms = 10 # int | Maximum number of terms to retrieve (optional) (default to 10)
prefix = false # bool | True means search terms that start with text. False means terms that contains this text within it. (optional) (default to false)
try:
# Get the list of the thesaurus terms with document count that match the prefix text.
api_response = api_instance.thesaurus_terms_get_v1_search_type_ahead_terms(site_name, q, max_terms=max_terms, prefix=prefix)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->thesaurus_terms_get_v1_search_type_ahead_terms: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| site_name | str | Site where assets are located | |
| q | str | The prefix text to retrieve matched search terms for | |
| max_terms | int | Maximum number of terms to retrieve | [optional] [default to 10] |
| prefix | bool | True means search terms that start with text. False means terms that contains this text within it. | [optional] [default to false] |
- Content-Type: application/json
- Accept: application/json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]