def test_update_training_example():
examples_endpoint = '/v1/environments/{0}/collections/{1}/training_data' + \
'/{2}/examples/{3}'
query_id = 'queryid'
example_id = 'exampleid'
endpoint = examples_endpoint.format(environment_id, collection_id,
query_id, example_id)
url = '{0}{1}'.format(base_url, endpoint)
relevance = 0
cross_reference = "string"
mock_response = {
"document_id": "string",
"cross_reference": "string",
"relevance": 0
}
responses.add(responses.PUT,
url,
body=json.dumps(mock_response),
status=200,
content_type='application/json')
service = ibm_watson.DiscoveryV1(version,
username='******',
password='******')
response = service.update_training_example(
environment_id=environment_id,
collection_id=collection_id,
query_id=query_id,
example_id=example_id,
relevance=relevance,
cross_reference=cross_reference).get_result()
assert response == mock_response
# Verify that response can be converted to a TrainingExample
TrainingExample._from_dict(response)
def test_query_2():
discovery_url = urljoin(base_discovery_url,
'environments/envid/collections/collid/query')
responses.add(responses.POST,
discovery_url,
body="{\"body\": \"hello\"}",
status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
discovery.query('envid',
'collid',
filter='extracted_metadata.sha1::9181d244*',
count=1,
passages=True,
passages_fields=['x', 'y'],
logging_opt_out='True',
passages_count=2,
bias='1',
collection_ids='1,2')
called_url = urlparse(responses.calls[0].request.url)
test_url = urlparse(discovery_url)
assert called_url.netloc == test_url.netloc
assert called_url.path == test_url.path
assert len(responses.calls) == 1
def test_get_training_data():
training_endpoint = '/v1/environments/{0}/collections/{1}/training_data/{2}'
query_id = 'queryid'
endpoint = training_endpoint.format(environment_id, collection_id,
query_id)
url = '{0}{1}'.format(base_url, endpoint)
mock_response = {
"query_id":
"string",
"natural_language_query":
"string",
"filter":
"string",
"examples": [{
"document_id": "string",
"cross_reference": "string",
"relevance": 0
}]
}
responses.add(responses.GET,
url,
body=json.dumps(mock_response),
status=200,
content_type='application/json')
service = ibm_watson.DiscoveryV1(version,
username='******',
password='******')
response = service.get_training_data(environment_id=environment_id,
collection_id=collection_id,
query_id=query_id).get_result()
assert response == mock_response
# Verify that response can be converted to a TrainingQuery
TrainingQuery._from_dict(response)
def test_collection():
discovery_url = urljoin(base_discovery_url,
'environments/envid/collections/collid')
discovery_fields = urljoin(base_discovery_url,
'environments/envid/collections/collid/fields')
config_url = urljoin(base_discovery_url,
'environments/envid/configurations')
responses.add(responses.GET, config_url,
body="{\"body\": \"hello\"}",
status=200,
content_type='application/json')
responses.add(responses.GET, discovery_fields,
body="{\"body\": \"hello\"}", status=200,
content_type='application/json')
responses.add(responses.GET, discovery_url,
body="{\"body\": \"hello\"}", status=200,
content_type='application/json')
responses.add(responses.DELETE, discovery_url,
body="{\"body\": \"hello\"}", status=200,
content_type='application/json')
responses.add(responses.POST,
urljoin(base_discovery_url,
'environments/envid/collections'),
body="{\"body\": \"create\"}",
status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
discovery.create_collection(environment_id='envid',
name="name",
description="",
language="",
configuration_id='confid')
discovery.create_collection(environment_id='envid',
name="name",
language="es",
description="")
discovery.get_collection('envid', 'collid')
called_url = urlparse(responses.calls[2].request.url)
test_url = urlparse(discovery_url)
assert called_url.netloc == test_url.netloc
assert called_url.path == test_url.path
discovery.delete_collection(environment_id='envid',
collection_id='collid')
discovery.list_collection_fields(environment_id='envid',
collection_id='collid')
assert len(responses.calls) == 5
def test_expansions():
url = 'https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/colid/expansions'
responses.add(responses.GET,
url,
body='{"expansions": "results"}',
status=200,
content_type='application_json')
responses.add(responses.DELETE,
url,
body='{"description": "success" }',
status=200,
content_type='application_json')
responses.add(responses.POST,
url,
body='{"expansions": "success" }',
status=200,
content_type='application_json')
discovery = ibm_watson.DiscoveryV1('2017-11-07',
username="******",
password="******")
discovery.list_expansions('envid', 'colid')
assert responses.calls[0].response.json() == {"expansions": "results"}
discovery.create_expansions('envid', 'colid', [{
"input_terms": "dumb",
"expanded_terms": "dumb2"
}])
assert responses.calls[1].response.json() == {"expansions": "success"}
discovery.delete_expansions('envid', 'colid')
assert responses.calls[2].response.json() == {"description": "success"}
assert len(responses.calls) == 3
def test_stopword_operations():
url = 'https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/colid/word_lists/stopwords?version=2017-11-07'
responses.add(
responses.POST,
url,
body='{"status": "pending", "type": "stopwords"}',
status=200,
content_type='application_json')
responses.add(
responses.DELETE,
url,
status=200)
responses.add(
responses.GET,
url,
body='{"status": "ready", "type": "stopwords"}',
status=200,
content_type='application_json')
discovery = ibm_watson.DiscoveryV1('2017-11-07', username="******", password="******")
stopwords_file_path = os.path.join(os.getcwd(), 'resources', 'stopwords.txt')
with open(stopwords_file_path) as file:
discovery.create_stopword_list('envid', 'colid', file)
assert responses.calls[0].response.json() == {"status": "pending", "type": "stopwords"}
discovery.get_stopword_list_status('envid', 'colid')
assert responses.calls[1].response.json() == {"status": "ready", "type": "stopwords"}
discovery.delete_stopword_list('envid', 'colid')
assert responses.calls[2].response.status_code == 200
assert len(responses.calls) == 3
def test_credentials():
discovery_credentials_url = urljoin(base_discovery_url, 'environments/envid/credentials')
results = {'credential_id': 'e68305ce-29f3-48ea-b829-06653ca0fdef',
'source_type': 'salesforce',
'credential_details': {
'url': 'https://login.salesforce.com',
'credential_type': 'username_password',
'username':'******'}
}
iam_url = "https://iam.bluemix.net/identity/token"
iam_token_response = """{
"access_token": "oAeisG8yqPY7sFR_x66Z15",
"token_type": "Bearer",
"expires_in": 3600,
"expiration": 1524167011,
"refresh_token": "jy4gl91BQ"
}"""
responses.add(responses.POST, url=iam_url, body=iam_token_response, status=200)
responses.add(responses.GET, "{0}/{1}?version=2016-11-07".format(discovery_credentials_url, 'credential_id'),
body=json.dumps(results),
status=200,
content_type='application/json')
responses.add(responses.GET, "{0}?version=2016-11-07".format(discovery_credentials_url),
body=json.dumps([results]),
status=200,
content_type='application/json')
responses.add(responses.POST, "{0}?version=2016-11-07".format(discovery_credentials_url),
body=json.dumps(results),
status=200,
content_type='application/json')
results['source_type'] = 'ibm'
responses.add(responses.PUT, "{0}/{1}?version=2016-11-07".format(discovery_credentials_url, 'credential_id'),
body=json.dumps(results),
status=200,
content_type='application/json')
responses.add(responses.DELETE, "{0}/{1}?version=2016-11-07".format(discovery_credentials_url, 'credential_id'),
body=json.dumps({'deleted': 'bogus -- ok'}),
status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07', iam_apikey='iam_apikey')
discovery.create_credentials('envid', 'salesforce', {
'url': 'https://login.salesforce.com',
'credential_type': 'username_password',
'username':'******'
})
discovery.get_credentials('envid', 'credential_id')
discovery.update_credentials(environment_id='envid',
credential_id='credential_id',
source_type='salesforce',
credential_details=results['credential_details'])
discovery.list_credentials('envid')
discovery.delete_credentials(environment_id='envid', credential_id='credential_id')
assert len(responses.calls) == 10
def test_configs():
discovery_url = urljoin(base_discovery_url,
'environments/envid/configurations')
discovery_config_id = urljoin(base_discovery_url,
'environments/envid/configurations/confid')
results = {"configurations":
[{"name": "Default Configuration",
"configuration_id": "confid"}]}
responses.add(responses.GET, discovery_url,
body=json.dumps(results),
status=200,
content_type='application/json')
responses.add(responses.GET, discovery_config_id,
body=json.dumps(results['configurations'][0]),
status=200,
content_type='application/json')
responses.add(responses.POST, discovery_url,
body=json.dumps(results['configurations'][0]),
status=200,
content_type='application/json')
responses.add(responses.PUT, discovery_config_id,
body=json.dumps(results['configurations'][0]),
status=200,
content_type='application/json')
responses.add(responses.DELETE, discovery_config_id,
body=json.dumps({'deleted': 'bogus -- ok'}),
status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
discovery.list_configurations(environment_id='envid')
discovery.get_configuration(environment_id='envid',
configuration_id='confid')
assert len(responses.calls) == 2
discovery.create_configuration(environment_id='envid',
name='my name')
discovery.create_configuration(environment_id='envid',
name='my name',
source={'type': 'salesforce', 'credential_id': 'xxx'})
discovery.update_configuration(environment_id='envid',
configuration_id='confid',
name='my new name')
discovery.update_configuration(environment_id='envid',
configuration_id='confid',
name='my new name',
source={'type': 'salesforce', 'credential_id': 'xxx'})
discovery.delete_configuration(environment_id='envid',
configuration_id='confid')
assert len(responses.calls) == 7
def test_gateway_configuration():
discovery_gateway_url = urljoin(base_discovery_url,
'environments/envid/gateways')
gateway_details = {
"status": "idle",
"token_id": "9GnaCreixek_prod_ng",
"token": "4FByv9Mmd79x6c",
"name": "test-gateway-configuration-python",
"gateway_id": "gateway_id"
}
iam_url = "https://iam.cloud.ibm.com/identity/token"
iam_token_response = """{
"access_token": "oAeisG8yqPY7sFR_x66Z15",
"token_type": "Bearer",
"expires_in": 3600,
"expiration": 1524167011,
"refresh_token": "jy4gl91BQ"
}"""
responses.add(responses.POST,
url=iam_url,
body=iam_token_response,
status=200)
responses.add(responses.GET,
"{0}/{1}?version=2016-11-07".format(discovery_gateway_url,
'gateway_id'),
body=json.dumps(gateway_details),
status=200,
content_type='application/json')
responses.add(responses.POST,
"{0}?version=2016-11-07".format(discovery_gateway_url),
body=json.dumps(gateway_details),
status=200,
content_type='application/json')
responses.add(responses.GET,
"{0}?version=2016-11-07".format(discovery_gateway_url),
body=json.dumps({'gateways': [gateway_details]}),
status=200,
content_type='application/json')
responses.add(responses.DELETE,
"{0}/{1}?version=2016-11-07".format(discovery_gateway_url,
'gateway_id'),
body=json.dumps({
'gateway_id': 'gateway_id',
'status': 'deleted'
}),
status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07', iam_apikey='iam_apikey')
discovery.create_gateway('envid', 'gateway_id')
discovery.list_gateways('envid')
discovery.get_gateway('envid', 'gateway_id')
discovery.delete_gateway(environment_id='envid', gateway_id='gateway_id')
assert len(responses.calls) == 8
def test_delete_environment():
discovery_url = urljoin(base_discovery_url, 'environments/envid')
responses.add(responses.DELETE, discovery_url,
body="{\"resulting_key\": true}", status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
discovery.delete_environment('envid')
assert len(responses.calls) == 1
def test_delete_all_training_data():
training_endpoint = '/v1/environments/{0}/collections/{1}/training_data'
endpoint = training_endpoint.format(environment_id, collection_id)
url = '{0}{1}'.format(base_url, endpoint)
responses.add(responses.DELETE, url, status=204)
service = ibm_watson.DiscoveryV1(version, username='******', password='******')
response = service.delete_all_training_data(environment_id=environment_id,
collection_id=collection_id).get_result()
assert response is None
def test_update_environment():
discovery_url = urljoin(base_discovery_url, 'environments/envid')
responses.add(responses.PUT, discovery_url,
body="{\"resulting_key\": true}", status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
discovery.update_environment('envid', name="hello", description="new")
assert len(responses.calls) == 1
def test_get_environment():
discovery_url = urljoin(base_discovery_url, 'environments/envid')
responses.add(responses.GET, discovery_url,
body="{\"resulting_key\": true}", status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
discovery.get_environment(environment_id='envid')
url_str = "{0}?version=2016-11-07".format(discovery_url)
assert responses.calls[0].request.url == url_str
assert len(responses.calls) == 1
def test_delete_user_data():
url = 'https://gateway.watsonplatform.net/discovery/api/v1/user_data'
responses.add(
responses.DELETE,
url,
body='{"description": "success" }',
status=204,
content_type='application_json')
discovery = ibm_watson.DiscoveryV1('2017-11-07', username="******", password="******")
response = discovery.delete_user_data('id').get_result()
assert response is None
assert len(responses.calls) == 1
def setUp(self):
self.discovery = ibm_watson.DiscoveryV1(version='2018-08-01')
self.discovery.set_default_headers({
'X-Watson-Learning-Opt-Out': '1',
'X-Watson-Test': '1'
})
self.environment_id = 'e15f6424-f887-4f50-b4ea-68267c36fc9c' # This environment is created for integration testing
collections = self.discovery.list_collections(
self.environment_id).get_result()['collections']
self.collection_id = collections[0]['collection_id']
for collection in collections:
if collection['name'] == 'DO-NOT-DELETE-JAPANESE-COLLECTION':
self.collection_id_JP = collection['collection_id']
def test_add_training_data():
training_endpoint = '/v1/environments/{0}/collections/{1}/training_data'
endpoint = training_endpoint.format(environment_id, collection_id)
url = '{0}{1}'.format(base_url, endpoint)
natural_language_query = "why is the sky blue"
filter = "text:meteorology"
examples = [
{
"document_id": "54f95ac0-3e4f-4756-bea6-7a67b2713c81",
"relevance": 1
},
{
"document_id": "01bcca32-7300-4c9f-8d32-33ed7ea643da",
"cross_reference": "my_id_field:1463",
"relevance": 5
}
]
mock_response = {
"query_id": "string",
"natural_language_query": "string",
"filter": "string",
"examples": [
{
"document_id": "string",
"cross_reference": "string",
"relevance": 0
}
]
}
responses.add(responses.POST,
url,
body=json.dumps(mock_response),
status=200,
content_type='application/json')
service = ibm_watson.DiscoveryV1(version,
username='******',
password='******')
response = service.add_training_data(
environment_id=environment_id,
collection_id=collection_id,
natural_language_query=natural_language_query,
filter=filter,
examples=examples).get_result()
assert response == mock_response
# Verify that response can be converted to a TrainingQuery
TrainingQuery._from_dict(response)
def test_federated_query_notices():
discovery_url = urljoin(base_discovery_url,
'environments/envid/notices')
responses.add(responses.GET, discovery_url,
body="{\"body\": \"hello\"}", status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07', username='******', password='******')
discovery.federated_query_notices('envid', collection_ids=['collid1', 'collid2'], filter='notices.sha1::9181d244*')
called_url = urlparse(responses.calls[0].request.url)
test_url = urlparse(discovery_url)
assert called_url.netloc == test_url.netloc
assert called_url.path == test_url.path
assert len(responses.calls) == 1
def test_environments():
discovery_url = urljoin(base_discovery_url, 'environments')
discovery_response_body = """{
"environments": [
{
"environment_id": "string",
"name": "envname",
"description": "",
"created": "2016-11-20T01:03:17.645Z",
"updated": "2016-11-20T01:03:17.645Z",
"status": "status",
"index_capacity": {
"disk_usage": {
"used_bytes": 0,
"total_bytes": 0,
"used": "string",
"total": "string",
"percent_used": 0
},
"memory_usage": {
"used_bytes": 0,
"total_bytes": 0,
"used": "string",
"total": "string",
"percent_used": 0
}
}
}
]
}"""
responses.add(responses.GET,
discovery_url,
body=discovery_response_body,
status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
discovery.list_environments()
url_str = "{0}?version=2016-11-07".format(discovery_url)
assert responses.calls[0].request.url == url_str
assert responses.calls[0].response.text == discovery_response_body
assert len(responses.calls) == 1
def test_collections():
discovery_url = urljoin(base_discovery_url,
'environments/envid/collections')
responses.add(responses.GET, discovery_url,
body="{\"body\": \"hello\"}", status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
discovery.list_collections('envid')
called_url = urlparse(responses.calls[0].request.url)
test_url = urlparse(discovery_url)
assert called_url.netloc == test_url.netloc
assert called_url.path == test_url.path
assert len(responses.calls) == 1
def test_tokenization_dictionary():
url = 'https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/colid/word_lists/tokenization_dictionary?version=2017-11-07'
responses.add(responses.POST,
url,
body='{"status": "pending"}',
status=200,
content_type='application_json')
responses.add(responses.DELETE,
url,
body='{"status": "pending"}',
status=200)
responses.add(
responses.GET,
url,
body='{"status": "pending", "type":"tokenization_dictionary"}',
status=200,
content_type='application_json')
discovery = ibm_watson.DiscoveryV1('2017-11-07',
username="******",
password="******")
tokenization_rules = [{
'text': 'token',
'tokens': ['token 1', 'token 2'],
'readings': ['reading 1', 'reading 2'],
'part_of_speech': 'noun',
}]
discovery.create_tokenization_dictionary('envid', 'colid',
tokenization_rules)
assert responses.calls[0].response.json() == {"status": "pending"}
discovery.get_tokenization_dictionary_status('envid', 'colid')
assert responses.calls[1].response.json() == {
"status": "pending",
"type": "tokenization_dictionary"
}
discovery.delete_tokenization_dictionary('envid', 'colid')
assert responses.calls[2].response.status_code == 200
assert len(responses.calls) == 3
def test_delete_training_example():
examples_endpoint = '/v1/environments/{0}/collections/{1}/training_data' + \
'/{2}/examples/{3}'
query_id = 'queryid'
example_id = 'exampleid'
endpoint = examples_endpoint.format(environment_id, collection_id,
query_id, example_id)
url = '{0}{1}'.format(base_url, endpoint)
responses.add(responses.DELETE, url, status=204)
service = ibm_watson.DiscoveryV1(version,
username='******',
password='******')
response = service.delete_training_example(
environment_id=environment_id,
collection_id=collection_id,
query_id=query_id,
example_id=example_id).get_result()
assert response is None
def setup_class(cls):
cls.discovery = ibm_watson.DiscoveryV1(version='2018-08-01')
cls.discovery.set_default_headers({
'X-Watson-Learning-Opt-Out': '1',
'X-Watson-Test': '1'
})
collections = cls.discovery.list_collections(
cls.environment_id).get_result()['collections']
for collection in collections:
if collection['name'] == cls.collection_name:
cls.collection_id = collection['collection_id']
if cls.collection_id is None:
print("Creating a new temporary collection")
cls.collection_id = cls.discovery.create_collection(
cls.environment_id,
cls.collection_name,
description="Integration test for python sdk").get_result(
)['collection_id']
########################################################################################################################
# Start Watson Tone Analyser service using your credentials
########################################################################################################################
tone_analyser = ibm_watson.ToneAnalyzerV3(
version='2017-09-21',
url='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', #replace with gateway URL
iam_apikey='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' #replace with apikey
)
########################################################################################################################
# Start Watson Discovery service using your credentials
########################################################################################################################
discovery_client = ibm_watson.DiscoveryV1(
version='2018-08-01',
url='https://gateway-syd.watsonplatform.net/discovery/api', #replace with gateway URL
iam_apikey='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'#replace with apikey
)
########################################################################################################################
# Start Slack service using Bot Token
########################################################################################################################
SLACK_BOT_TOKEN='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' #replace with Bot token
slack_client = SlackClient(SLACK_BOT_TOKEN)
########################################################################################################################
# Start the program
########################################################################################################################
caring_bot = CaringBot(slack_client,
conversation_client,
def test_document():
discovery_url = urljoin(base_discovery_url, 'environments/envid/preview')
config_url = urljoin(base_discovery_url,
'environments/envid/configurations')
responses.add(responses.POST,
discovery_url,
body="{\"configurations\": []}",
status=200,
content_type='application/json')
responses.add(responses.GET,
config_url,
body=json.dumps({
"configurations": [{
"name": "Default Configuration",
"configuration_id": "confid"
}]
}),
status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07',
username='******',
password='******')
html_path = os.path.join(os.getcwd(), 'resources', 'simple.html')
with open(html_path) as fileinfo:
conf_id = discovery.test_configuration_in_environment(
environment_id='envid', configuration_id='bogus', file=fileinfo)
assert conf_id is not None
conf_id = discovery.test_configuration_in_environment(
environment_id='envid', file=fileinfo)
assert conf_id is not None
assert len(responses.calls) == 2
add_doc_url = urljoin(base_discovery_url,
'environments/envid/collections/collid/documents')
doc_id_path = 'environments/envid/collections/collid/documents/docid'
update_doc_url = urljoin(base_discovery_url, doc_id_path)
del_doc_url = urljoin(base_discovery_url, doc_id_path)
responses.add(responses.POST,
add_doc_url,
body="{\"body\": []}",
status=200,
content_type='application/json')
doc_status = {
"document_id": "45556e23-f2b1-449d-8f27-489b514000ff",
"configuration_id": "2e079259-7dd2-40a9-998f-3e716f5a7b88",
"created": "2016-06-16T10:56:54.957Z",
"updated": "2017-05-16T13:56:54.957Z",
"status": "available",
"status_description":
"Document is successfully ingested and indexed with no warnings",
"notices": []
}
responses.add(responses.GET,
del_doc_url,
body=json.dumps(doc_status),
status=200,
content_type='application/json')
responses.add(responses.POST,
update_doc_url,
body="{\"body\": []}",
status=200,
content_type='application/json')
responses.add(responses.DELETE,
del_doc_url,
body="{\"body\": []}",
status=200,
content_type='application/json')
html_path = os.path.join(os.getcwd(), 'resources', 'simple.html')
with open(html_path) as fileinfo:
conf_id = discovery.add_document(environment_id='envid',
collection_id='collid',
file=fileinfo)
assert conf_id is not None
assert len(responses.calls) == 3
discovery.get_document_status(environment_id='envid',
collection_id='collid',
document_id='docid')
assert len(responses.calls) == 4
discovery.update_document(environment_id='envid',
collection_id='collid',
document_id='docid')
assert len(responses.calls) == 5
discovery.update_document(environment_id='envid',
collection_id='collid',
document_id='docid')
assert len(responses.calls) == 6
discovery.delete_document(environment_id='envid',
collection_id='collid',
document_id='docid')
assert len(responses.calls) == 7
conf_id = discovery.add_document(environment_id='envid',
collection_id='collid',
file=io.StringIO(u'my string of file'),
filename='file.txt')
assert len(responses.calls) == 8
conf_id = discovery.add_document(
environment_id='envid',
collection_id='collid',
file=io.StringIO(u'<h1>my string of file</h1>'),
filename='file.html',
file_content_type='application/html')
assert len(responses.calls) == 9
conf_id = discovery.add_document(
environment_id='envid',
collection_id='collid',
file=io.StringIO(u'<h1>my string of file</h1>'),
filename='file.html',
file_content_type='application/html',
metadata=io.StringIO(u'{"stuff": "woot!"}'))
assert len(responses.calls) == 10
# This script will loop through every collection in the given instance and save each document. If you only want a specific collection to be backed up, remove the outer loop, for collection in allCollections, and specify the collectionId
if disc_credentials != '':
for creds in disc_credentials:
disc_version = creds['disc_version']
disc_apikey = creds['disc_apikey']
disc_url = creds['disc_url']
if (disc_version == '' or disc_apikey == '' or disc_url == ''):
print("No or invalid Discovery credentials detected. Skipping.")
else:
print("Beginning Discovery backup...")
start_time = time.time()
authenticator = IAMAuthenticator(disc_apikey)
discovery_service = ibm_watson.DiscoveryV1(
version=disc_version, authenticator=authenticator)
discovery_service.set_service_url(disc_url)
environments = discovery_service.list_environments().get_result()
environmentId = environments["environments"][1]["environment_id"]
allCollections = discovery_service.list_collections(
environmentId).get_result()['collections']
for collection in allCollections:
collectionId = collection['collection_id']
print("Backing up collection " + collectionId + "...")
allDocIds = all_document_ids(discovery_service, environmentId,
collectionId)
discovery_path = base_directory + "/discovery_" + collectionId
def test_events_and_feedback():
discovery_event_url = urljoin(base_discovery_url, 'events')
discovery_metrics_event_rate_url = urljoin(base_discovery_url,
'metrics/event_rate')
discovery_metrics_query_url = urljoin(base_discovery_url,
'metrics/number_of_queries')
discovery_metrics_query_event_url = urljoin(
base_discovery_url, 'metrics/number_of_queries_with_event')
discovery_metrics_query_no_results_url = urljoin(
base_discovery_url, 'metrics/number_of_queries_with_no_search_results')
discovery_metrics_query_token_event_url = urljoin(
base_discovery_url, 'metrics/top_query_tokens_with_event_rate')
discovery_query_log_url = urljoin(base_discovery_url, 'logs')
event_data = {
"environment_id": "xxx",
"session_token": "yyy",
"client_timestamp": "2018-08-14T14:39:59.268Z",
"display_rank": 0,
"collection_id": "abc",
"document_id": "xyz",
"query_id": "cde"
}
create_event_response = {"type": "click", "data": event_data}
metric_response = {
"aggregations": [{
"interval":
"1d",
"event_type":
"click",
"results": [{
"key_as_string": "2018-08-14T14:39:59.309Z",
"key": 1533513600000,
"matching_results": 2,
"event_rate": 0.0
}]
}]
}
metric_token_response = {
"aggregations": [{
"event_type":
"click",
"results": [{
"key": "content",
"matching_results": 5,
"event_rate": 0.6
}, {
"key": "first",
"matching_results": 5,
"event_rate": 0.6
}, {
"key": "of",
"matching_results": 5,
"event_rate": 0.6
}]
}]
}
log_query_response = {
"matching_results":
20,
"results": [{
"customer_id": "",
"environment_id": "xxx",
"natural_language_query": "The content of the first chapter",
"query_id": "1ICUdh3Pab",
"document_results": {
"count":
1,
"results": [{
"collection_id":
"b67a82f3-6507-4c25-9757-3485ff4f2a32",
"score":
0.025773458,
"position":
10,
"document_id":
"af0be20e-e130-4712-9a2e-37d9c8b9c52f"
}]
},
"event_type": "query",
"session_token": "1_nbEfQtKVcg9qx3t41ICUdh3Pab",
"created_timestamp": "2018-08-14T18:20:30.460Z"
}]
}
iam_url = "https://iam.cloud.ibm.com/identity/token"
iam_token_response = """{
"access_token": "oAeisG8yqPY7sFR_x66Z15",
"token_type": "Bearer",
"expires_in": 3600,
"expiration": 1524167011,
"refresh_token": "jy4gl91BQ"
}"""
responses.add(responses.POST,
url=iam_url,
body=iam_token_response,
status=200)
responses.add(responses.POST,
"{0}?version=2016-11-07".format(discovery_event_url),
body=json.dumps(create_event_response),
status=200,
content_type='application/json')
responses.add(
responses.GET,
"{0}?version=2016-11-07".format(discovery_metrics_event_rate_url),
body=json.dumps(metric_response),
status=200,
content_type='application/json')
responses.add(responses.GET,
"{0}?version=2016-11-07".format(discovery_metrics_query_url),
body=json.dumps(metric_response),
status=200,
content_type='application/json')
responses.add(
responses.GET,
"{0}?version=2016-11-07".format(discovery_metrics_query_event_url),
body=json.dumps(metric_response),
status=200,
content_type='application/json')
responses.add(responses.GET,
"{0}?version=2016-11-07".format(
discovery_metrics_query_no_results_url),
body=json.dumps(metric_response),
status=200,
content_type='application/json')
responses.add(responses.GET,
"{0}?version=2016-11-07".format(
discovery_metrics_query_token_event_url),
body=json.dumps(metric_token_response),
status=200,
content_type='application/json')
responses.add(responses.GET,
"{0}?version=2016-11-07".format(discovery_query_log_url),
body=json.dumps(log_query_response),
status=200,
content_type='application/json')
discovery = ibm_watson.DiscoveryV1('2016-11-07', iam_apikey='iam_apikey')
discovery.create_event('click', event_data)
assert responses.calls[1].response.json()["data"] == event_data
discovery.get_metrics_event_rate('2018-08-13T14:39:59.309Z',
'2018-08-14T14:39:59.309Z', 'document')
assert responses.calls[3].response.json() == metric_response
discovery.get_metrics_query('2018-08-13T14:39:59.309Z',
'2018-08-14T14:39:59.309Z', 'document')
assert responses.calls[5].response.json() == metric_response
discovery.get_metrics_query_event('2018-08-13T14:39:59.309Z',
'2018-08-14T14:39:59.309Z', 'document')
assert responses.calls[7].response.json() == metric_response
discovery.get_metrics_query_no_results('2018-08-13T14:39:59.309Z',
'2018-08-14T14:39:59.309Z',
'document')
assert responses.calls[9].response.json() == metric_response
discovery.get_metrics_query_token_event(2)
assert responses.calls[11].response.json() == metric_token_response
discovery.query_log()
assert responses.calls[13].response.json() == log_query_response
assert len(responses.calls) == 14