Skip to content
This repository was archived by the owner on Dec 17, 2023. It is now read-only.

Commit 56a6e11

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add document metadata filter in article suggestion (#437)
- [x] Regenerate this pull request now. PiperOrigin-RevId: 409190373 Source-Link: googleapis/googleapis@29bb98c Source-Link: https://github.com/googleapis/googleapis-gen/commit/e90c22e9275b91aabc6c820a767af2fd6954f624 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTkwYzIyZTkyNzViOTFhYWJjNmM4MjBhNzY3YWYyZmQ2OTU0ZjYyNCJ9 feat: add smart reply model in human agent assistant
1 parent 5b1d8bb commit 56a6e11

8 files changed

Lines changed: 76 additions & 11 deletions

File tree

‎google/cloud/dialogflow/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,7 @@
218218
from google.cloud.dialogflow_v2.types.participant import AnalyzeContentResponse
219219
from google.cloud.dialogflow_v2.types.participant import AnnotatedMessagePart
220220
from google.cloud.dialogflow_v2.types.participant import ArticleAnswer
221+
from google.cloud.dialogflow_v2.types.participant import AssistQueryParameters
221222
from google.cloud.dialogflow_v2.types.participant import AutomatedAgentReply
222223
from google.cloud.dialogflow_v2.types.participant import CreateParticipantRequest
223224
from google.cloud.dialogflow_v2.types.participant import DtmfParameters
@@ -432,6 +433,7 @@
432433
"AnalyzeContentResponse",
433434
"AnnotatedMessagePart",
434435
"ArticleAnswer",
436+
"AssistQueryParameters",
435437
"AutomatedAgentReply",
436438
"CreateParticipantRequest",
437439
"DtmfParameters",

‎google/cloud/dialogflow_v2/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@
166166
from .types.participant import AnalyzeContentResponse
167167
from .types.participant import AnnotatedMessagePart
168168
from .types.participant import ArticleAnswer
169+
from .types.participant import AssistQueryParameters
169170
from .types.participant import AutomatedAgentReply
170171
from .types.participant import CreateParticipantRequest
171172
from .types.participant import DtmfParameters
@@ -243,6 +244,7 @@
243244
"AnswerRecord",
244245
"AnswerRecordsClient",
245246
"ArticleAnswer",
247+
"AssistQueryParameters",
246248
"AudioEncoding",
247249
"AutomatedAgentConfig",
248250
"AutomatedAgentReply",

‎google/cloud/dialogflow_v2/services/participants/async_client.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ async def list_participants(
361361
Returns:
362362
google.cloud.dialogflow_v2.services.participants.pagers.ListParticipantsAsyncPager:
363363
The response message for
364-
[Participants.ListParticipants][google.cloud.dialogflow.v2.Participants.ListParticipants].
364+
[Participants.ListParticipants][google.cloud.dialogflow.v2.Participants.ListParticipants].
365365
366366
Iterating over this object will yield results and
367367
resolve additional pages automatically.
@@ -542,7 +542,7 @@ async def analyze_content(
542542
Returns:
543543
google.cloud.dialogflow_v2.types.AnalyzeContentResponse:
544544
The response message for
545-
[Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent].
545+
[Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent].
546546
547547
"""
548548
# Create or coerce a protobuf request object.
@@ -630,7 +630,7 @@ async def suggest_articles(
630630
Returns:
631631
google.cloud.dialogflow_v2.types.SuggestArticlesResponse:
632632
The response message for
633-
[Participants.SuggestArticles][google.cloud.dialogflow.v2.Participants.SuggestArticles].
633+
[Participants.SuggestArticles][google.cloud.dialogflow.v2.Participants.SuggestArticles].
634634
635635
"""
636636
# Create or coerce a protobuf request object.
@@ -703,7 +703,7 @@ async def suggest_faq_answers(
703703
Returns:
704704
google.cloud.dialogflow_v2.types.SuggestFaqAnswersResponse:
705705
The request message for
706-
[Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2.Participants.SuggestFaqAnswers].
706+
[Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2.Participants.SuggestFaqAnswers].
707707
708708
"""
709709
# Create or coerce a protobuf request object.

‎google/cloud/dialogflow_v2/services/participants/client.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ def list_participants(
606606
Returns:
607607
google.cloud.dialogflow_v2.services.participants.pagers.ListParticipantsPager:
608608
The response message for
609-
[Participants.ListParticipants][google.cloud.dialogflow.v2.Participants.ListParticipants].
609+
[Participants.ListParticipants][google.cloud.dialogflow.v2.Participants.ListParticipants].
610610
611611
Iterating over this object will yield results and
612612
resolve additional pages automatically.
@@ -787,7 +787,7 @@ def analyze_content(
787787
Returns:
788788
google.cloud.dialogflow_v2.types.AnalyzeContentResponse:
789789
The response message for
790-
[Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent].
790+
[Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent].
791791
792792
"""
793793
# Create or coerce a protobuf request object.
@@ -866,7 +866,7 @@ def suggest_articles(
866866
Returns:
867867
google.cloud.dialogflow_v2.types.SuggestArticlesResponse:
868868
The response message for
869-
[Participants.SuggestArticles][google.cloud.dialogflow.v2.Participants.SuggestArticles].
869+
[Participants.SuggestArticles][google.cloud.dialogflow.v2.Participants.SuggestArticles].
870870
871871
"""
872872
# Create or coerce a protobuf request object.
@@ -939,7 +939,7 @@ def suggest_faq_answers(
939939
Returns:
940940
google.cloud.dialogflow_v2.types.SuggestFaqAnswersResponse:
941941
The request message for
942-
[Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2.Participants.SuggestFaqAnswers].
942+
[Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2.Participants.SuggestFaqAnswers].
943943
944944
"""
945945
# Create or coerce a protobuf request object.

‎google/cloud/dialogflow_v2/types/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@
159159
AnalyzeContentResponse,
160160
AnnotatedMessagePart,
161161
ArticleAnswer,
162+
AssistQueryParameters,
162163
AutomatedAgentReply,
163164
CreateParticipantRequest,
164165
DtmfParameters,
@@ -342,6 +343,7 @@
342343
"AnalyzeContentResponse",
343344
"AnnotatedMessagePart",
344345
"ArticleAnswer",
346+
"AssistQueryParameters",
345347
"AutomatedAgentReply",
346348
"CreateParticipantRequest",
347349
"DtmfParameters",

‎google/cloud/dialogflow_v2/types/conversation_profile.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -732,6 +732,7 @@ class Type(proto.Enum):
732732
TYPE_UNSPECIFIED = 0
733733
ARTICLE_SUGGESTION = 1
734734
FAQ = 2
735+
SMART_REPLY = 3
735736

736737
type_ = proto.Field(proto.ENUM, number=1, enum=Type,)
737738

‎google/cloud/dialogflow_v2/types/participant.py‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
"SuggestionResult",
4848
"AnnotatedMessagePart",
4949
"MessageAnnotation",
50+
"AssistQueryParameters",
5051
},
5152
)
5253

@@ -69,6 +70,27 @@ class Participant(proto.Message):
6970
metadata and SDP. This is used to assign
7071
transcriptions from that media stream to this
7172
participant. This field can be updated.
73+
documents_metadata_filters (Sequence[google.cloud.dialogflow_v2.types.Participant.DocumentsMetadataFiltersEntry]):
74+
Optional. Key-value filters on the metadata of documents
75+
returned by article suggestion. If specified, article
76+
suggestion only returns suggested documents that match all
77+
filters in their
78+
[Document.metadata][google.cloud.dialogflow.v2.Document.metadata].
79+
Multiple values for a metadata key should be concatenated by
80+
comma. For example, filters to match all documents that have
81+
'US' or 'CA' in their market metadata values and 'agent' in
82+
their user metadata values will be
83+
84+
::
85+
86+
documents_metadata_filters {
87+
key: "market"
88+
value: "US,CA"
89+
}
90+
documents_metadata_filters {
91+
key: "user"
92+
value: "agent"
93+
}
7294
"""
7395

7496
class Role(proto.Enum):
@@ -83,6 +105,7 @@ class Role(proto.Enum):
83105
name = proto.Field(proto.STRING, number=1,)
84106
role = proto.Field(proto.ENUM, number=2, enum=Role,)
85107
sip_recording_media_label = proto.Field(proto.STRING, number=6,)
108+
documents_metadata_filters = proto.MapField(proto.STRING, proto.STRING, number=8,)
86109

87110

88111
class Message(proto.Message):
@@ -247,6 +270,8 @@ class AnalyzeContentRequest(proto.Message):
247270
query_params (google.cloud.dialogflow_v2.types.QueryParameters):
248271
Parameters for a Dialogflow virtual-agent
249272
query.
273+
assist_query_params (google.cloud.dialogflow_v2.types.AssistQueryParameters):
274+
Parameters for a human assist query.
250275
request_id (str):
251276
A unique identifier for this request. Restricted to 36 ASCII
252277
characters. A random UUID is recommended. This request is
@@ -266,6 +291,9 @@ class AnalyzeContentRequest(proto.Message):
266291
query_params = proto.Field(
267292
proto.MESSAGE, number=9, message=session.QueryParameters,
268293
)
294+
assist_query_params = proto.Field(
295+
proto.MESSAGE, number=14, message="AssistQueryParameters",
296+
)
269297
request_id = proto.Field(proto.STRING, number=11,)
270298

271299

@@ -365,11 +393,16 @@ class SuggestArticlesRequest(proto.Message):
365393
[latest_message][google.cloud.dialogflow.v2.SuggestArticlesRequest.latest_message]
366394
to use as context when compiling the suggestion. By default
367395
20 and at most 50.
396+
assist_query_params (google.cloud.dialogflow_v2.types.AssistQueryParameters):
397+
Parameters for a human assist query.
368398
"""
369399

370400
parent = proto.Field(proto.STRING, number=1,)
371401
latest_message = proto.Field(proto.STRING, number=2,)
372402
context_size = proto.Field(proto.INT32, number=3,)
403+
assist_query_params = proto.Field(
404+
proto.MESSAGE, number=4, message="AssistQueryParameters",
405+
)
373406

374407

375408
class SuggestArticlesResponse(proto.Message):
@@ -422,11 +455,16 @@ class SuggestFaqAnswersRequest(proto.Message):
422455
Max number of messages prior to and including
423456
[latest_message] to use as context when compiling the
424457
suggestion. By default 20 and at most 50.
458+
assist_query_params (google.cloud.dialogflow_v2.types.AssistQueryParameters):
459+
Parameters for a human assist query.
425460
"""
426461

427462
parent = proto.Field(proto.STRING, number=1,)
428463
latest_message = proto.Field(proto.STRING, number=2,)
429464
context_size = proto.Field(proto.INT32, number=3,)
465+
assist_query_params = proto.Field(
466+
proto.MESSAGE, number=4, message="AssistQueryParameters",
467+
)
430468

431469

432470
class SuggestFaqAnswersResponse(proto.Message):
@@ -678,4 +716,24 @@ class MessageAnnotation(proto.Message):
678716
contain_entities = proto.Field(proto.BOOL, number=2,)
679717

680718

719+
class AssistQueryParameters(proto.Message):
720+
r"""Represents the parameters of human assist query.
721+
722+
Attributes:
723+
documents_metadata_filters (Sequence[google.cloud.dialogflow_v2.types.AssistQueryParameters.DocumentsMetadataFiltersEntry]):
724+
Key-value filters on the metadata of documents returned by
725+
article suggestion. If specified, article suggestion only
726+
returns suggested documents that match all filters in their
727+
[Document.metadata][google.cloud.dialogflow.v2.Document.metadata].
728+
Multiple values for a metadata key should be concatenated by
729+
comma. For example, filters to match all documents that have
730+
'US' or 'CA' in their market metadata values and 'agent' in
731+
their user metadata values will be
732+
documents_metadata_filters { key: "market" value: "US,CA" }
733+
documents_metadata_filters { key: "user" value: "agent" }
734+
"""
735+
736+
documents_metadata_filters = proto.MapField(proto.STRING, proto.STRING, number=1,)
737+
738+
681739
__all__ = tuple(sorted(__protobuf__.manifest))

‎scripts/fixup_dialogflow_v2_keywords.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def partition(
3939
class dialogflowCallTransformer(cst.CSTTransformer):
4040
CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata')
4141
METHOD_TO_PARAMS: Dict[str, Tuple[str]] = {
42-
'analyze_content': ('participant', 'text_input', 'event_input', 'reply_audio_config', 'query_params', 'request_id', ),
42+
'analyze_content': ('participant', 'text_input', 'event_input', 'reply_audio_config', 'query_params', 'assist_query_params', 'request_id', ),
4343
'batch_create_entities': ('parent', 'entities', 'language_code', ),
4444
'batch_delete_entities': ('parent', 'entity_values', 'language_code', ),
4545
'batch_delete_entity_types': ('parent', 'entity_type_names', ),
@@ -106,8 +106,8 @@ class dialogflowCallTransformer(cst.CSTTransformer):
106106
'search_agents': ('parent', 'page_size', 'page_token', ),
107107
'set_agent': ('agent', 'update_mask', ),
108108
'streaming_detect_intent': ('session', 'query_input', 'query_params', 'single_utterance', 'output_audio_config', 'output_audio_config_mask', 'input_audio', ),
109-
'suggest_articles': ('parent', 'latest_message', 'context_size', ),
110-
'suggest_faq_answers': ('parent', 'latest_message', 'context_size', ),
109+
'suggest_articles': ('parent', 'latest_message', 'context_size', 'assist_query_params', ),
110+
'suggest_faq_answers': ('parent', 'latest_message', 'context_size', 'assist_query_params', ),
111111
'train_agent': ('parent', ),
112112
'update_answer_record': ('answer_record', 'update_mask', ),
113113
'update_context': ('context', 'update_mask', ),

0 commit comments

Comments
 (0)