google-apis-dialogflow_v2 0.25.0 → 0.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2033,6 +2033,19 @@ module Google
2033
2033
  # @param [String] parent
2034
2034
  # Required. The project to list of knowledge bases for. Format: `projects//
2035
2035
  # locations/`.
2036
+ # @param [String] filter
2037
+ # The filter expression used to filter knowledge bases returned by the list
2038
+ # method. The expression has the following syntax: [AND ] ... The following
2039
+ # fields and operators are supported: * display_name with has(:) operator *
2040
+ # language_code with equals(=) operator Examples: * 'language_code=en-us'
2041
+ # matches knowledge bases with en-us language code. * 'display_name:articles'
2042
+ # matches knowledge bases whose display name contains "articles". * '
2043
+ # display_name:"Best Articles"' matches knowledge bases whose display name
2044
+ # contains "Best Articles". * 'language_code=en-gb AND display_name=articles'
2045
+ # matches all knowledge bases whose display name contains "articles" and whose
2046
+ # language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op
2047
+ # and will result in no filtering. For more information about filtering, see [
2048
+ # API Filtering](https://aip.dev/160).
2036
2049
  # @param [Fixnum] page_size
2037
2050
  # The maximum number of items to return in a single page. By default 10 and at
2038
2051
  # most 100.
@@ -2055,11 +2068,12 @@ module Google
2055
2068
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2056
2069
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2057
2070
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2058
- def list_project_agent_knowledge_bases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2071
+ def list_project_agent_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2059
2072
  command = make_simple_command(:get, 'v2/{+parent}/knowledgeBases', options)
2060
2073
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse::Representation
2061
2074
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse
2062
2075
  command.params['parent'] = parent unless parent.nil?
2076
+ command.query['filter'] = filter unless filter.nil?
2063
2077
  command.query['pageSize'] = page_size unless page_size.nil?
2064
2078
  command.query['pageToken'] = page_token unless page_token.nil?
2065
2079
  command.query['fields'] = fields unless fields.nil?
@@ -2213,6 +2227,16 @@ module Google
2213
2227
  # @param [String] parent
2214
2228
  # Required. The knowledge base to list all documents for. Format: `projects//
2215
2229
  # locations//knowledgeBases/`.
2230
+ # @param [String] filter
2231
+ # The filter expression used to filter documents returned by the list method.
2232
+ # The expression has the following syntax: [AND ] ... The following fields and
2233
+ # operators are supported: * knowledge_types with has(:) operator * display_name
2234
+ # with has(:) operator * state with equals(=) operator Examples: * "
2235
+ # knowledge_types:FAQ" matches documents with FAQ knowledge type. * "
2236
+ # display_name:customer" matches documents whose display name contains "customer"
2237
+ # . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ
2238
+ # AND state=ACTIVE" matches all active FAQ documents. For more information about
2239
+ # filtering, see [API Filtering](https://aip.dev/160).
2216
2240
  # @param [Fixnum] page_size
2217
2241
  # The maximum number of items to return in a single page. By default 10 and at
2218
2242
  # most 100.
@@ -2235,11 +2259,12 @@ module Google
2235
2259
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2236
2260
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2237
2261
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2238
- def list_project_agent_knowledge_basis_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2262
+ def list_project_agent_knowledge_basis_documents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2239
2263
  command = make_simple_command(:get, 'v2/{+parent}/documents', options)
2240
2264
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse::Representation
2241
2265
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse
2242
2266
  command.params['parent'] = parent unless parent.nil?
2267
+ command.query['filter'] = filter unless filter.nil?
2243
2268
  command.query['pageSize'] = page_size unless page_size.nil?
2244
2269
  command.query['pageToken'] = page_token unless page_token.nil?
2245
2270
  command.query['fields'] = fields unless fields.nil?
@@ -3693,6 +3718,40 @@ module Google
3693
3718
  execute_or_queue_command(command, &block)
3694
3719
  end
3695
3720
 
3721
+ # Gets smart replies for a participant based on specific historical messages.
3722
+ # @param [String] parent
3723
+ # Required. The name of the participant to fetch suggestion for. Format: `
3724
+ # projects//locations//conversations//participants/`.
3725
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest] google_cloud_dialogflow_v2_suggest_smart_replies_request_object
3726
+ # @param [String] fields
3727
+ # Selector specifying which fields to include in a partial response.
3728
+ # @param [String] quota_user
3729
+ # Available to use for quota purposes for server-side applications. Can be any
3730
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3731
+ # @param [Google::Apis::RequestOptions] options
3732
+ # Request-specific options
3733
+ #
3734
+ # @yield [result, err] Result & error if block supplied
3735
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse] parsed result object
3736
+ # @yieldparam err [StandardError] error object if request failed
3737
+ #
3738
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse]
3739
+ #
3740
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3741
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3742
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3743
+ def suggest_project_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3744
+ command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestSmartReplies', options)
3745
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest::Representation
3746
+ command.request_object = google_cloud_dialogflow_v2_suggest_smart_replies_request_object
3747
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse::Representation
3748
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse
3749
+ command.params['parent'] = parent unless parent.nil?
3750
+ command.query['fields'] = fields unless fields.nil?
3751
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3752
+ execute_or_queue_command(command, &block)
3753
+ end
3754
+
3696
3755
  # Creates a knowledge base.
3697
3756
  # @param [String] parent
3698
3757
  # Required. The project to create a knowledge base for. Format: `projects//
@@ -3797,6 +3856,19 @@ module Google
3797
3856
  # @param [String] parent
3798
3857
  # Required. The project to list of knowledge bases for. Format: `projects//
3799
3858
  # locations/`.
3859
+ # @param [String] filter
3860
+ # The filter expression used to filter knowledge bases returned by the list
3861
+ # method. The expression has the following syntax: [AND ] ... The following
3862
+ # fields and operators are supported: * display_name with has(:) operator *
3863
+ # language_code with equals(=) operator Examples: * 'language_code=en-us'
3864
+ # matches knowledge bases with en-us language code. * 'display_name:articles'
3865
+ # matches knowledge bases whose display name contains "articles". * '
3866
+ # display_name:"Best Articles"' matches knowledge bases whose display name
3867
+ # contains "Best Articles". * 'language_code=en-gb AND display_name=articles'
3868
+ # matches all knowledge bases whose display name contains "articles" and whose
3869
+ # language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op
3870
+ # and will result in no filtering. For more information about filtering, see [
3871
+ # API Filtering](https://aip.dev/160).
3800
3872
  # @param [Fixnum] page_size
3801
3873
  # The maximum number of items to return in a single page. By default 10 and at
3802
3874
  # most 100.
@@ -3819,11 +3891,12 @@ module Google
3819
3891
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3820
3892
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3821
3893
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3822
- def list_project_knowledge_bases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3894
+ def list_project_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3823
3895
  command = make_simple_command(:get, 'v2/{+parent}/knowledgeBases', options)
3824
3896
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse::Representation
3825
3897
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse
3826
3898
  command.params['parent'] = parent unless parent.nil?
3899
+ command.query['filter'] = filter unless filter.nil?
3827
3900
  command.query['pageSize'] = page_size unless page_size.nil?
3828
3901
  command.query['pageToken'] = page_token unless page_token.nil?
3829
3902
  command.query['fields'] = fields unless fields.nil?
@@ -3942,6 +4015,44 @@ module Google
3942
4015
  execute_or_queue_command(command, &block)
3943
4016
  end
3944
4017
 
4018
+ # Exports a smart messaging candidate document into the specified destination.
4019
+ # This method is a [long-running operation](https://cloud.google.com/dialogflow/
4020
+ # cx/docs/how/long-running-operation). The returned `Operation` type has the
4021
+ # following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `
4022
+ # response`: Document
4023
+ # @param [String] name
4024
+ # Required. The name of the document to export. Format: `projects//locations//
4025
+ # knowledgeBases//documents/`.
4026
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest] google_cloud_dialogflow_v2_export_document_request_object
4027
+ # @param [String] fields
4028
+ # Selector specifying which fields to include in a partial response.
4029
+ # @param [String] quota_user
4030
+ # Available to use for quota purposes for server-side applications. Can be any
4031
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4032
+ # @param [Google::Apis::RequestOptions] options
4033
+ # Request-specific options
4034
+ #
4035
+ # @yield [result, err] Result & error if block supplied
4036
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
4037
+ # @yieldparam err [StandardError] error object if request failed
4038
+ #
4039
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
4040
+ #
4041
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4042
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4043
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4044
+ def export_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_export_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4045
+ command = make_simple_command(:post, 'v2/{+name}:export', options)
4046
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest::Representation
4047
+ command.request_object = google_cloud_dialogflow_v2_export_document_request_object
4048
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
4049
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
4050
+ command.params['name'] = name unless name.nil?
4051
+ command.query['fields'] = fields unless fields.nil?
4052
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4053
+ execute_or_queue_command(command, &block)
4054
+ end
4055
+
3945
4056
  # Retrieves the specified document.
3946
4057
  # @param [String] name
3947
4058
  # Required. The name of the document to retrieve. Format `projects//locations//
@@ -3973,10 +4084,59 @@ module Google
3973
4084
  execute_or_queue_command(command, &block)
3974
4085
  end
3975
4086
 
4087
+ # Creates documents by importing data from external sources. Dialogflow supports
4088
+ # up to 350 documents in each request. If you try to import more, Dialogflow
4089
+ # will return an error. This method is a [long-running operation](https://cloud.
4090
+ # google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
4091
+ # Operation` type has the following method-specific fields: - `metadata`:
4092
+ # KnowledgeOperationMetadata - `response`: ImportDocumentsResponse
4093
+ # @param [String] parent
4094
+ # Required. The knowledge base to import documents into. Format: `projects//
4095
+ # locations//knowledgeBases/`.
4096
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentsRequest] google_cloud_dialogflow_v2_import_documents_request_object
4097
+ # @param [String] fields
4098
+ # Selector specifying which fields to include in a partial response.
4099
+ # @param [String] quota_user
4100
+ # Available to use for quota purposes for server-side applications. Can be any
4101
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4102
+ # @param [Google::Apis::RequestOptions] options
4103
+ # Request-specific options
4104
+ #
4105
+ # @yield [result, err] Result & error if block supplied
4106
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
4107
+ # @yieldparam err [StandardError] error object if request failed
4108
+ #
4109
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
4110
+ #
4111
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4112
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4113
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4114
+ def import_project_knowledge_basis_document(parent, google_cloud_dialogflow_v2_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4115
+ command = make_simple_command(:post, 'v2/{+parent}/documents:import', options)
4116
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentsRequest::Representation
4117
+ command.request_object = google_cloud_dialogflow_v2_import_documents_request_object
4118
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
4119
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
4120
+ command.params['parent'] = parent unless parent.nil?
4121
+ command.query['fields'] = fields unless fields.nil?
4122
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4123
+ execute_or_queue_command(command, &block)
4124
+ end
4125
+
3976
4126
  # Returns the list of all documents of the knowledge base.
3977
4127
  # @param [String] parent
3978
4128
  # Required. The knowledge base to list all documents for. Format: `projects//
3979
4129
  # locations//knowledgeBases/`.
4130
+ # @param [String] filter
4131
+ # The filter expression used to filter documents returned by the list method.
4132
+ # The expression has the following syntax: [AND ] ... The following fields and
4133
+ # operators are supported: * knowledge_types with has(:) operator * display_name
4134
+ # with has(:) operator * state with equals(=) operator Examples: * "
4135
+ # knowledge_types:FAQ" matches documents with FAQ knowledge type. * "
4136
+ # display_name:customer" matches documents whose display name contains "customer"
4137
+ # . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ
4138
+ # AND state=ACTIVE" matches all active FAQ documents. For more information about
4139
+ # filtering, see [API Filtering](https://aip.dev/160).
3980
4140
  # @param [Fixnum] page_size
3981
4141
  # The maximum number of items to return in a single page. By default 10 and at
3982
4142
  # most 100.
@@ -3999,11 +4159,12 @@ module Google
3999
4159
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4000
4160
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4001
4161
  # @raise [Google::Apis::AuthorizationError] Authorization is required
4002
- def list_project_knowledge_basis_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4162
+ def list_project_knowledge_basis_documents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4003
4163
  command = make_simple_command(:get, 'v2/{+parent}/documents', options)
4004
4164
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse::Representation
4005
4165
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse
4006
4166
  command.params['parent'] = parent unless parent.nil?
4167
+ command.query['filter'] = filter unless filter.nil?
4007
4168
  command.query['pageSize'] = page_size unless page_size.nil?
4008
4169
  command.query['pageToken'] = page_token unless page_token.nil?
4009
4170
  command.query['fields'] = fields unless fields.nil?
@@ -7409,6 +7570,40 @@ module Google
7409
7570
  execute_or_queue_command(command, &block)
7410
7571
  end
7411
7572
 
7573
+ # Gets smart replies for a participant based on specific historical messages.
7574
+ # @param [String] parent
7575
+ # Required. The name of the participant to fetch suggestion for. Format: `
7576
+ # projects//locations//conversations//participants/`.
7577
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest] google_cloud_dialogflow_v2_suggest_smart_replies_request_object
7578
+ # @param [String] fields
7579
+ # Selector specifying which fields to include in a partial response.
7580
+ # @param [String] quota_user
7581
+ # Available to use for quota purposes for server-side applications. Can be any
7582
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7583
+ # @param [Google::Apis::RequestOptions] options
7584
+ # Request-specific options
7585
+ #
7586
+ # @yield [result, err] Result & error if block supplied
7587
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse] parsed result object
7588
+ # @yieldparam err [StandardError] error object if request failed
7589
+ #
7590
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse]
7591
+ #
7592
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7593
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7594
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7595
+ def suggest_project_location_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7596
+ command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestSmartReplies', options)
7597
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest::Representation
7598
+ command.request_object = google_cloud_dialogflow_v2_suggest_smart_replies_request_object
7599
+ command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse::Representation
7600
+ command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse
7601
+ command.params['parent'] = parent unless parent.nil?
7602
+ command.query['fields'] = fields unless fields.nil?
7603
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7604
+ execute_or_queue_command(command, &block)
7605
+ end
7606
+
7412
7607
  # Creates a knowledge base.
7413
7608
  # @param [String] parent
7414
7609
  # Required. The project to create a knowledge base for. Format: `projects//
@@ -7513,6 +7708,19 @@ module Google
7513
7708
  # @param [String] parent
7514
7709
  # Required. The project to list of knowledge bases for. Format: `projects//
7515
7710
  # locations/`.
7711
+ # @param [String] filter
7712
+ # The filter expression used to filter knowledge bases returned by the list
7713
+ # method. The expression has the following syntax: [AND ] ... The following
7714
+ # fields and operators are supported: * display_name with has(:) operator *
7715
+ # language_code with equals(=) operator Examples: * 'language_code=en-us'
7716
+ # matches knowledge bases with en-us language code. * 'display_name:articles'
7717
+ # matches knowledge bases whose display name contains "articles". * '
7718
+ # display_name:"Best Articles"' matches knowledge bases whose display name
7719
+ # contains "Best Articles". * 'language_code=en-gb AND display_name=articles'
7720
+ # matches all knowledge bases whose display name contains "articles" and whose
7721
+ # language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op
7722
+ # and will result in no filtering. For more information about filtering, see [
7723
+ # API Filtering](https://aip.dev/160).
7516
7724
  # @param [Fixnum] page_size
7517
7725
  # The maximum number of items to return in a single page. By default 10 and at
7518
7726
  # most 100.
@@ -7535,11 +7743,12 @@ module Google
7535
7743
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7536
7744
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7537
7745
  # @raise [Google::Apis::AuthorizationError] Authorization is required
7538
- def list_project_location_knowledge_bases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7746
+ def list_project_location_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7539
7747
  command = make_simple_command(:get, 'v2/{+parent}/knowledgeBases', options)
7540
7748
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse::Representation
7541
7749
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse
7542
7750
  command.params['parent'] = parent unless parent.nil?
7751
+ command.query['filter'] = filter unless filter.nil?
7543
7752
  command.query['pageSize'] = page_size unless page_size.nil?
7544
7753
  command.query['pageToken'] = page_token unless page_token.nil?
7545
7754
  command.query['fields'] = fields unless fields.nil?
@@ -7658,6 +7867,44 @@ module Google
7658
7867
  execute_or_queue_command(command, &block)
7659
7868
  end
7660
7869
 
7870
+ # Exports a smart messaging candidate document into the specified destination.
7871
+ # This method is a [long-running operation](https://cloud.google.com/dialogflow/
7872
+ # cx/docs/how/long-running-operation). The returned `Operation` type has the
7873
+ # following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `
7874
+ # response`: Document
7875
+ # @param [String] name
7876
+ # Required. The name of the document to export. Format: `projects//locations//
7877
+ # knowledgeBases//documents/`.
7878
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest] google_cloud_dialogflow_v2_export_document_request_object
7879
+ # @param [String] fields
7880
+ # Selector specifying which fields to include in a partial response.
7881
+ # @param [String] quota_user
7882
+ # Available to use for quota purposes for server-side applications. Can be any
7883
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7884
+ # @param [Google::Apis::RequestOptions] options
7885
+ # Request-specific options
7886
+ #
7887
+ # @yield [result, err] Result & error if block supplied
7888
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
7889
+ # @yieldparam err [StandardError] error object if request failed
7890
+ #
7891
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
7892
+ #
7893
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7894
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7895
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7896
+ def export_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_export_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7897
+ command = make_simple_command(:post, 'v2/{+name}:export', options)
7898
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest::Representation
7899
+ command.request_object = google_cloud_dialogflow_v2_export_document_request_object
7900
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
7901
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
7902
+ command.params['name'] = name unless name.nil?
7903
+ command.query['fields'] = fields unless fields.nil?
7904
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7905
+ execute_or_queue_command(command, &block)
7906
+ end
7907
+
7661
7908
  # Retrieves the specified document.
7662
7909
  # @param [String] name
7663
7910
  # Required. The name of the document to retrieve. Format `projects//locations//
@@ -7689,10 +7936,59 @@ module Google
7689
7936
  execute_or_queue_command(command, &block)
7690
7937
  end
7691
7938
 
7939
+ # Creates documents by importing data from external sources. Dialogflow supports
7940
+ # up to 350 documents in each request. If you try to import more, Dialogflow
7941
+ # will return an error. This method is a [long-running operation](https://cloud.
7942
+ # google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
7943
+ # Operation` type has the following method-specific fields: - `metadata`:
7944
+ # KnowledgeOperationMetadata - `response`: ImportDocumentsResponse
7945
+ # @param [String] parent
7946
+ # Required. The knowledge base to import documents into. Format: `projects//
7947
+ # locations//knowledgeBases/`.
7948
+ # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentsRequest] google_cloud_dialogflow_v2_import_documents_request_object
7949
+ # @param [String] fields
7950
+ # Selector specifying which fields to include in a partial response.
7951
+ # @param [String] quota_user
7952
+ # Available to use for quota purposes for server-side applications. Can be any
7953
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7954
+ # @param [Google::Apis::RequestOptions] options
7955
+ # Request-specific options
7956
+ #
7957
+ # @yield [result, err] Result & error if block supplied
7958
+ # @yieldparam result [Google::Apis::DialogflowV2::GoogleLongrunningOperation] parsed result object
7959
+ # @yieldparam err [StandardError] error object if request failed
7960
+ #
7961
+ # @return [Google::Apis::DialogflowV2::GoogleLongrunningOperation]
7962
+ #
7963
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7964
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7965
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7966
+ def import_project_location_knowledge_basis_document(parent, google_cloud_dialogflow_v2_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7967
+ command = make_simple_command(:post, 'v2/{+parent}/documents:import', options)
7968
+ command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentsRequest::Representation
7969
+ command.request_object = google_cloud_dialogflow_v2_import_documents_request_object
7970
+ command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
7971
+ command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
7972
+ command.params['parent'] = parent unless parent.nil?
7973
+ command.query['fields'] = fields unless fields.nil?
7974
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7975
+ execute_or_queue_command(command, &block)
7976
+ end
7977
+
7692
7978
  # Returns the list of all documents of the knowledge base.
7693
7979
  # @param [String] parent
7694
7980
  # Required. The knowledge base to list all documents for. Format: `projects//
7695
7981
  # locations//knowledgeBases/`.
7982
+ # @param [String] filter
7983
+ # The filter expression used to filter documents returned by the list method.
7984
+ # The expression has the following syntax: [AND ] ... The following fields and
7985
+ # operators are supported: * knowledge_types with has(:) operator * display_name
7986
+ # with has(:) operator * state with equals(=) operator Examples: * "
7987
+ # knowledge_types:FAQ" matches documents with FAQ knowledge type. * "
7988
+ # display_name:customer" matches documents whose display name contains "customer"
7989
+ # . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ
7990
+ # AND state=ACTIVE" matches all active FAQ documents. For more information about
7991
+ # filtering, see [API Filtering](https://aip.dev/160).
7696
7992
  # @param [Fixnum] page_size
7697
7993
  # The maximum number of items to return in a single page. By default 10 and at
7698
7994
  # most 100.
@@ -7715,11 +8011,12 @@ module Google
7715
8011
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7716
8012
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7717
8013
  # @raise [Google::Apis::AuthorizationError] Authorization is required
7718
- def list_project_location_knowledge_basis_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
8014
+ def list_project_location_knowledge_basis_documents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7719
8015
  command = make_simple_command(:get, 'v2/{+parent}/documents', options)
7720
8016
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse::Representation
7721
8017
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListDocumentsResponse
7722
8018
  command.params['parent'] = parent unless parent.nil?
8019
+ command.query['filter'] = filter unless filter.nil?
7723
8020
  command.query['pageSize'] = page_size unless page_size.nil?
7724
8021
  command.query['pageToken'] = page_token unless page_token.nil?
7725
8022
  command.query['fields'] = fields unless fields.nil?
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dialogflow_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.25.0
4
+ version: 0.29.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-11-15 00:00:00.000000000 Z
11
+ date: 2022-01-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v2/v0.25.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v2/v0.29.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v2
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Dialogflow API V2