You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
+39Lines changed: 39 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -115,6 +115,11 @@ <h3>Method Details</h3>
115
115
"phrase": "A String", # Required. The raw string content to be banned.
116
116
},
117
117
],
118
+
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
119
+
"failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization.
120
+
"responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.
121
+
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.
122
+
},
118
123
},
119
124
"enabledTools": { # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
120
125
"a_key": { # The enabled tools on a connector
@@ -155,6 +160,11 @@ <h3>Method Details</h3>
155
160
"phrase": "A String", # Required. The raw string content to be banned.
156
161
},
157
162
],
163
+
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
164
+
"failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization.
165
+
"responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.
166
+
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.
167
+
},
158
168
},
159
169
"enabledTools": { # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
160
170
"a_key": { # The enabled tools on a connector
@@ -194,6 +204,11 @@ <h3>Method Details</h3>
194
204
"phrase": "A String", # Required. The raw string content to be banned.
195
205
},
196
206
],
207
+
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
208
+
"failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization.
209
+
"responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.
210
+
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.
211
+
},
197
212
},
198
213
"enabledTools": { # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
199
214
"a_key": { # The enabled tools on a connector
@@ -290,6 +305,30 @@ <h3>Method Details</h3>
290
305
"assistSkippedReasons": [ # Reasons for not answering the assist call.
291
306
"A String",
292
307
],
308
+
"customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
309
+
"policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.
310
+
{ # Customer policy enforcement result for a single policy type.
311
+
"bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy.
312
+
"bannedPhrases": [ # The banned phrases that were found in the query or the answer.
313
+
"A String",
314
+
],
315
+
},
316
+
"modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy.
317
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error returned by Model Armor if the policy enforcement failed for some reason.
318
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
319
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
320
+
{
321
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
322
+
},
323
+
],
324
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
325
+
},
326
+
"modelArmorViolation": "A String", # The Model Armor violation that was found.
327
+
},
328
+
},
329
+
],
330
+
"verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
331
+
},
293
332
"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.
294
333
"replies": [ # Replies of the assistant.
295
334
{ # One part of the multi-part response of the assist call.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -130,6 +130,7 @@ <h3>Method Details</h3>
130
130
"dataStoreComponents": [ # For the data store collection, list of the children data stores.
131
131
{ # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
132
132
"contentConfig": "A String", # Output only. The content config of the data store.
133
+
"dataStoreConfigType": "A String", # Output only. The type of the data store config.
133
134
"displayName": "A String", # The display name of the data store.
134
135
"entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
135
136
"id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
+39Lines changed: 39 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -115,6 +115,11 @@ <h3>Method Details</h3>
115
115
"phrase": "A String", # Required. The raw string content to be banned.
116
116
},
117
117
],
118
+
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
119
+
"failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization.
120
+
"responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.
121
+
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.
122
+
},
118
123
},
119
124
"enabledTools": { # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
120
125
"a_key": { # The enabled tools on a connector
@@ -155,6 +160,11 @@ <h3>Method Details</h3>
155
160
"phrase": "A String", # Required. The raw string content to be banned.
156
161
},
157
162
],
163
+
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
164
+
"failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization.
165
+
"responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.
166
+
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.
167
+
},
158
168
},
159
169
"enabledTools": { # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
160
170
"a_key": { # The enabled tools on a connector
@@ -194,6 +204,11 @@ <h3>Method Details</h3>
194
204
"phrase": "A String", # Required. The raw string content to be banned.
195
205
},
196
206
],
207
+
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
208
+
"failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization.
209
+
"responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.
210
+
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.
211
+
},
197
212
},
198
213
"enabledTools": { # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
199
214
"a_key": { # The enabled tools on a connector
@@ -290,6 +305,30 @@ <h3>Method Details</h3>
290
305
"assistSkippedReasons": [ # Reasons for not answering the assist call.
291
306
"A String",
292
307
],
308
+
"customerPolicyEnforcementResult": { # Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks. # Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
309
+
"policyResults": [ # Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.
310
+
{ # Customer policy enforcement result for a single policy type.
311
+
"bannedPhraseEnforcementResult": { # Customer policy enforcement result for the banned phrase policy. # The policy enforcement result for the banned phrase policy.
312
+
"bannedPhrases": [ # The banned phrases that were found in the query or the answer.
313
+
"A String",
314
+
],
315
+
},
316
+
"modelArmorEnforcementResult": { # Customer policy enforcement result for the Model Armor policy. # The policy enforcement result for the Model Armor policy.
317
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error returned by Model Armor if the policy enforcement failed for some reason.
318
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
319
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
320
+
{
321
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
322
+
},
323
+
],
324
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
325
+
},
326
+
"modelArmorViolation": "A String", # The Model Armor violation that was found.
327
+
},
328
+
},
329
+
],
330
+
"verdict": "A String", # Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
331
+
},
293
332
"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.
294
333
"replies": [ # Replies of the assistant.
295
334
{ # One part of the multi-part response of the assist call.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -130,6 +130,7 @@ <h3>Method Details</h3>
130
130
"dataStoreComponents": [ # For the data store collection, list of the children data stores.
131
131
{ # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
132
132
"contentConfig": "A String", # Output only. The content config of the data store.
133
+
"dataStoreConfigType": "A String", # Output only. The type of the data store config.
133
134
"displayName": "A String", # The display name of the data store.
134
135
"entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
135
136
"id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
0 commit comments