1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
# pylint: disable=line-too-long,useless-suppression
# coding=utf-8
# -------------------------------------------------------------------------
# Runtime tests: knowledge base querying (authoring removed)
# -------------------------------------------------------------------------
import pytest
from azure.ai.language.questionanswering import QuestionAnsweringClient
from azure.ai.language.questionanswering.models import (
AnswersOptions,
KnowledgeBaseAnswerContext,
ShortAnswerOptions,
MetadataFilter,
MetadataRecord,
QueryFilters,
)
from azure.core.credentials import AzureKeyCredential
from testcase import QuestionAnsweringTestCase
class TestQnAKnowledgeBase(QuestionAnsweringTestCase):
def test_query_knowledgebase(self, recorded_test, qna_creds): # standard model usage
client = QuestionAnsweringClient(qna_creds["qna_endpoint"], AzureKeyCredential(qna_creds["qna_key"]))
query_params = AnswersOptions(
question="Ports and connectors",
top=3,
answer_context=KnowledgeBaseAnswerContext(previous_question="Meet Surface Pro 4", previous_qna_id=4),
)
with client:
output = client.get_answers(query_params, project_name=qna_creds["qna_project"], deployment_name="production")
assert output.answers
for answer in output.answers:
assert answer.answer
assert answer.confidence is not None
assert answer.qna_id is not None
assert answer.source
def test_query_knowledgebase_with_answerspan(self, recorded_test, qna_creds):
client = QuestionAnsweringClient(qna_creds["qna_endpoint"], AzureKeyCredential(qna_creds["qna_key"]))
query_params = AnswersOptions(
question="Ports and connectors",
top=3,
answer_context=KnowledgeBaseAnswerContext(previous_question="Meet Surface Pro 4", previous_qna_id=4),
short_answer_options=ShortAnswerOptions(enable=True, confidence_threshold=0.1, top=2),
)
with client:
output = client.get_answers(query_params, project_name=qna_creds["qna_project"], deployment_name="test")
assert output.answers
# If short answer returned, essential fields exist
for answer in output.answers:
if answer.short_answer:
assert answer.short_answer.text
assert answer.short_answer.confidence is not None
def test_query_knowledgebase_filter(self, recorded_test, qna_creds):
filters = QueryFilters(
metadata_filter=MetadataFilter(
metadata=[
MetadataRecord(key="explicitlytaggedheading", value="check the battery level"),
MetadataRecord(key="explicitlytaggedheading", value="make your battery last"),
],
logical_operation="OR",
),
)
with QuestionAnsweringClient(qna_creds["qna_endpoint"], AzureKeyCredential(qna_creds["qna_key"])) as client:
query_params = AnswersOptions(
question="Battery life",
filters=filters,
top=3,
)
response = client.get_answers(
query_params,
project_name=qna_creds["qna_project"],
deployment_name="test",
)
assert response.answers
def test_query_knowledgebase_only_id(self, recorded_test, qna_creds):
client = QuestionAnsweringClient(qna_creds["qna_endpoint"], AzureKeyCredential(qna_creds["qna_key"]))
with client:
query_params = AnswersOptions(qna_id=19)
output = client.get_answers(query_params, project_name=qna_creds["qna_project"], deployment_name="test")
assert output.answers is not None
assert len(output.answers) == 1
def test_query_knowledgebase_overload_errors(self): # negative tests independent of live service
with QuestionAnsweringClient("http://fake.com", AzureKeyCredential("123")) as client:
# These calls intentionally violate the method signature to ensure TypeError is raised.
with pytest.raises(TypeError):
client.get_answers("positional_one", "positional_two") # type: ignore
with pytest.raises(TypeError):
client.get_answers("positional_options_bag", options="options bag by name") # type: ignore
with pytest.raises(TypeError):
client.get_answers(options={"qnaId": 15}, project_name="hello", deployment_name="test") # type: ignore
with pytest.raises(TypeError):
client.get_answers({"qnaId": 15}, question="Why?", project_name="hello", deployment_name="test") # type: ignore
def test_query_knowledgebase_question_or_qna_id(self):
with QuestionAnsweringClient("http://fake.com", AzureKeyCredential("123")) as client:
options = AnswersOptions()
with pytest.raises(TypeError):
client.get_answers(options, project_name="hello", deployment_name="test")
with pytest.raises(TypeError):
client.get_answers(project_name="hello", deployment_name="test")
|
