Skip to content

Commit

Permalink
feat: added page in TestConfig (#239)
Browse files Browse the repository at this point in the history 
* feat: added page in TestConfig
docs: clarified wording around Cloud Storage usage

PiperOrigin-RevId: 433282831

Source-Link: googleapis/googleapis@0e87dc7

Source-Link: googleapis/googleapis-gen@1928631
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTkyODYzMWYzZWU5MTQ4OGZlMDdiM2Q4MTg4YTUyZDEwODYyNDUzYSJ9
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] authored Mar 9, 2022
1 parent 01ad9ec commit ae5cb3d
Show file tree
Hide file tree
Showing 16 changed files with 163 additions and 8 deletions.
12 changes: 12 additions & 0 deletions packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/agent.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,12 @@ message ExportAgentRequest {
// export the agent to. The format of this URI must be
// `gs://<bucket-name>/<object-name>`.
// If left unspecified, the serialized agent is returned inline.
//
// Dialogflow performs a write operation for the Cloud Storage object
// on the caller's behalf, so your request authentication must
// have write permissions for the object. For more information, see
// [Dialogflow access
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
string agent_uri = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. Environment name. If not set, draft environment is assumed.
Expand Down Expand Up @@ -405,6 +411,12 @@ message RestoreAgentRequest {
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
// to restore agent from. The format of this URI must be
// `gs://<bucket-name>/<object-name>`.
//
// Dialogflow performs a read operation for the Cloud Storage object
// on the caller's behalf, so your request authentication must
// have read permissions for the object. For more information, see
// [Dialogflow access
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
string agent_uri = 2;

// Uncompressed raw byte content for agent.
Expand Down
12 changes: 12 additions & 0 deletions packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/flow.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,12 @@ message ImportFlowRequest {
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
// to import flow from. The format of this URI must be
// `gs://<bucket-name>/<object-name>`.
//
// Dialogflow performs a read operation for the Cloud Storage object
// on the caller's behalf, so your request authentication must
// have read permissions for the object. For more information, see
// [Dialogflow access
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
string flow_uri = 2;

// Uncompressed raw byte content for flow.
Expand Down Expand Up @@ -595,6 +601,12 @@ message ExportFlowRequest {
// export the flow to. The format of this URI must be
// `gs://<bucket-name>/<object-name>`.
// If left unspecified, the serialized flow is returned inline.
//
// Dialogflow performs a write operation for the Cloud Storage object
// on the caller's behalf, so your request authentication must
// have write permissions for the object. For more information, see
// [Dialogflow access
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
string flow_uri = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. Whether to export flows referenced by the specified flow.
Expand Down
31 changes: 30 additions & 1 deletion packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3/test_case.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -270,12 +270,29 @@ message TestConfig {
// Session parameters to be compared when calculating differences.
repeated string tracking_parameters = 1;

// Flow name. If not set, default start flow is assumed.
// Flow name to start the test case with.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>`.
//
// Only one of `flow` and `page` should be set to indicate the starting point
// of the test case. If both are set, `page` takes precedence over `flow`. If
// neither is set, the test case will start with start page on the default
// start flow.
string flow = 2 [(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/Flow"
}];

// The [page][google.cloud.dialogflow.cx.v3.Page] to start the test case with.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>/pages/<Page ID>`.
//
// Only one of `flow` and `page` should be set to indicate the starting point
// of the test case. If both are set, `page` takes precedence over `flow`. If
// neither is set, the test case will start with start page on the default
// start flow.
string page = 3 [(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/Page"
}];
}

// One interaction between a human and virtual agent. The human provides some
Expand Down Expand Up @@ -744,6 +761,12 @@ message ImportTestCasesRequest {
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
// to import test cases from. The format of this URI must be
// `gs://<bucket-name>/<object-name>`.
//
// Dialogflow performs a read operation for the Cloud Storage object
// on the caller's behalf, so your request authentication must
// have read permissions for the object. For more information, see
// [Dialogflow access
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
string gcs_uri = 2;

// Uncompressed raw byte content for test cases.
Expand Down Expand Up @@ -806,6 +829,12 @@ message ExportTestCasesRequest {
// export the test cases to. The format of this URI must be
// `gs://<bucket-name>/<object-name>`. If unspecified, the serialized test
// cases is returned inline.
//
// Dialogflow performs a write operation for the Cloud Storage object
// on the caller's behalf, so your request authentication must
// have write permissions for the object. For more information, see
// [Dialogflow access
// control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
string gcs_uri = 2;
}

Expand Down
6 changes: 6 additions & 0 deletions packages/google-cloud-dialogflow-cx/protos/protos.d.ts
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 24 additions & 1 deletion packages/google-cloud-dialogflow-cx/protos/protos.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions packages/google-cloud-dialogflow-cx/protos/protos.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions packages/google-cloud-dialogflow-cx/samples/generated/v3/agents.export_agent.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ function main(name) {
* export the agent to. The format of this URI must be
* `gs://<bucket-name>/<object-name>`.
* If left unspecified, the serialized agent is returned inline.
* Dialogflow performs a write operation for the Cloud Storage object
* on the caller's behalf, so your request authentication must
* have write permissions for the object. For more information, see
* Dialogflow access
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
*/
// const agentUri = 'abc123'
/**
Expand Down
5 changes: 5 additions & 0 deletions packages/google-cloud-dialogflow-cx/samples/generated/v3/agents.restore_agent.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ function main(name) {
* The Google Cloud Storage (https://cloud.google.com/storage/docs/) URI
* to restore agent from. The format of this URI must be
* `gs://<bucket-name>/<object-name>`.
* Dialogflow performs a read operation for the Cloud Storage object
* on the caller's behalf, so your request authentication must
* have read permissions for the object. For more information, see
* Dialogflow access
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
*/
// const agentUri = 'abc123'
/**
Expand Down
5 changes: 5 additions & 0 deletions packages/google-cloud-dialogflow-cx/samples/generated/v3/flows.export_flow.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ function main(name) {
* export the flow to. The format of this URI must be
* `gs://<bucket-name>/<object-name>`.
* If left unspecified, the serialized flow is returned inline.
* Dialogflow performs a write operation for the Cloud Storage object
* on the caller's behalf, so your request authentication must
* have write permissions for the object. For more information, see
* Dialogflow access
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
*/
// const flowUri = 'abc123'
/**
Expand Down
5 changes: 5 additions & 0 deletions packages/google-cloud-dialogflow-cx/samples/generated/v3/flows.import_flow.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ function main(parent) {
* The Google Cloud Storage (https://cloud.google.com/storage/docs/) URI
* to import flow from. The format of this URI must be
* `gs://<bucket-name>/<object-name>`.
* Dialogflow performs a read operation for the Cloud Storage object
* on the caller's behalf, so your request authentication must
* have read permissions for the object. For more information, see
* Dialogflow access
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
*/
// const flowUri = 'abc123'
/**
Expand Down
12 changes: 6 additions & 6 deletions ...ud-dialogflow-cx/samples/generated/v3/snippet_metadata.google.cloud.dialogflow.cx.v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@
"segments": [
{
"start": 25,
"end": 65,
"end": 70,
"type": "FULL"
}
],
Expand Down Expand Up @@ -286,7 +286,7 @@
"segments": [
{
"start": 25,
"end": 66,
"end": 71,
"type": "FULL"
}
],
Expand Down Expand Up @@ -1898,7 +1898,7 @@
"segments": [
{
"start": 25,
"end": 66,
"end": 71,
"type": "FULL"
}
],
Expand Down Expand Up @@ -1950,7 +1950,7 @@
"segments": [
{
"start": 25,
"end": 64,
"end": 69,
"type": "FULL"
}
],
Expand Down Expand Up @@ -3466,7 +3466,7 @@
"segments": [
{
"start": 25,
"end": 62,
"end": 67,
"type": "FULL"
}
],
Expand Down Expand Up @@ -3514,7 +3514,7 @@
"segments": [
{
"start": 25,
"end": 74,
"end": 79,
"type": "FULL"
}
],
Expand Down
5 changes: 5 additions & 0 deletions packages/google-cloud-dialogflow-cx/samples/generated/v3/test_cases.export_test_cases.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ function main(parent) {
* export the test cases to. The format of this URI must be
* `gs://<bucket-name>/<object-name>`. If unspecified, the serialized test
* cases is returned inline.
* Dialogflow performs a write operation for the Cloud Storage object
* on the caller's behalf, so your request authentication must
* have write permissions for the object. For more information, see
* Dialogflow access
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
*/
// const gcsUri = 'abc123'
/**
Expand Down
5 changes: 5 additions & 0 deletions packages/google-cloud-dialogflow-cx/samples/generated/v3/test_cases.import_test_cases.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ function main(parent) {
* The Google Cloud Storage (https://cloud.google.com/storage/docs/) URI
* to import test cases from. The format of this URI must be
* `gs://<bucket-name>/<object-name>`.
* Dialogflow performs a read operation for the Cloud Storage object
* on the caller's behalf, so your request authentication must
* have read permissions for the object. For more information, see
* Dialogflow access
* control (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
*/
// const gcsUri = 'abc123'
/**
Expand Down
12 changes: 12 additions & 0 deletions packages/google-cloud-dialogflow-cx/src/v3/agents_client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1030,6 +1030,12 @@ export class AgentsClient {
* export the agent to. The format of this URI must be
* `gs://<bucket-name>/<object-name>`.
* If left unspecified, the serialized agent is returned inline.
*
* Dialogflow performs a write operation for the Cloud Storage object
* on the caller's behalf, so your request authentication must
* have write permissions for the object. For more information, see
* [Dialogflow access
* control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
* @param {string} [request.environment]
* Optional. Environment name. If not set, draft environment is assumed.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
Expand Down Expand Up @@ -1192,6 +1198,12 @@ export class AgentsClient {
* The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
* to restore agent from. The format of this URI must be
* `gs://<bucket-name>/<object-name>`.
*
* Dialogflow performs a read operation for the Cloud Storage object
* on the caller's behalf, so your request authentication must
* have read permissions for the object. For more information, see
* [Dialogflow access
* control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
* @param {Buffer} request.agentContent
* Uncompressed raw byte content for agent.
* @param {google.cloud.dialogflow.cx.v3.RestoreAgentRequest.RestoreOption} request.restoreOption
Expand Down
Loading

0 comments on commit ae5cb3d

Please sign in to comment.