Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

feat: added support for TelephonyTransferCall #206

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions protos/google/cloud/dialogflow/cx/v3/audio_config.proto
Original file line number Diff line number Diff line change
Expand Up @@ -31,31 +31,6 @@ option java_package = "com.google.cloud.dialogflow.cx.v3";
option objc_class_prefix = "DF";
option ruby_package = "Google::Cloud::Dialogflow::CX::V3";

// Information for a word recognized by the speech recognizer.
message SpeechWordInfo {
// The word this info is for.
string word = 3;

// Time offset relative to the beginning of the audio that corresponds to the
// start of the spoken word. This is an experimental feature and the accuracy
// of the time offset can vary.
google.protobuf.Duration start_offset = 1;

// Time offset relative to the beginning of the audio that corresponds to the
// end of the spoken word. This is an experimental feature and the accuracy of
// the time offset can vary.
google.protobuf.Duration end_offset = 2;

// The Speech confidence between 0.0 and 1.0 for this word. A higher number
// indicates an estimated greater likelihood that the recognized word is
// correct. The default of 0.0 is a sentinel value indicating that confidence
// was not set.
//
// This field is not guaranteed to be fully stable over time for the same
// audio input. Users should also not rely on it to always be provided.
float confidence = 4;
}

// Audio encoding of the audio content sent in the conversational query request.
// Refer to the
// [Cloud Speech API
Expand Down Expand Up @@ -105,6 +80,31 @@ enum AudioEncoding {
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7;
}

// Information for a word recognized by the speech recognizer.
message SpeechWordInfo {
// The word this info is for.
string word = 3;

// Time offset relative to the beginning of the audio that corresponds to the
// start of the spoken word. This is an experimental feature and the accuracy
// of the time offset can vary.
google.protobuf.Duration start_offset = 1;

// Time offset relative to the beginning of the audio that corresponds to the
// end of the spoken word. This is an experimental feature and the accuracy of
// the time offset can vary.
google.protobuf.Duration end_offset = 2;

// The Speech confidence between 0.0 and 1.0 for this word. A higher number
// indicates an estimated greater likelihood that the recognized word is
// correct. The default of 0.0 is a sentinel value indicating that confidence
// was not set.
//
// This field is not guaranteed to be fully stable over time for the same
// audio input. Users should also not rely on it to always be provided.
float confidence = 4;
}

// Instructs the speech recognizer on how to process the audio content.
message InputAudioConfig {
// Required. Audio encoding of the audio content to process.
Expand Down
1 change: 1 addition & 0 deletions protos/google/cloud/dialogflow/cx/v3/environment.proto
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/dialogflow/cx/v3/test_case.proto";
import "google/cloud/dialogflow/cx/v3/webhook.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
Expand Down
15 changes: 15 additions & 0 deletions protos/google/cloud/dialogflow/cx/v3/response_message.proto
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,17 @@ message ResponseMessage {
repeated Segment segments = 1;
}

// Represents the signal that telles the client to transfer the phone call
// connected to the agent to a third-party endpoint.
message TelephonyTransferCall {
// Endpoint to transfer the call to.
oneof endpoint {
// Transfer the call to a phone number
// in [E.164 format](https://en.wikipedia.org/wiki/E.164).
string phone_number = 1;
}
}

// Required. The rich response message.
oneof message {
// Returns a text response.
Expand Down Expand Up @@ -202,5 +213,9 @@ message ResponseMessage {
// This message is generated by Dialogflow only and not supposed to be
// defined by the user.
MixedAudio mixed_audio = 13 [(google.api.field_behavior) = OUTPUT_ONLY];

// A signal that the client should transfer the phone call connected to
// this agent to a third-party endpoint.
TelephonyTransferCall telephony_transfer_call = 18;
}
}
111 changes: 47 additions & 64 deletions protos/google/cloud/dialogflow/cx/v3/version.proto
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ service Versions {
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/dialogflow";

// Returns the list of all versions in the specified
// [Flow][google.cloud.dialogflow.cx.v3.Flow].
// Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
rpc ListVersions(ListVersionsRequest) returns (ListVersionsResponse) {
option (google.api.http) = {
get: "/v3/{parent=projects/*/locations/*/agents/*/flows/*}/versions"
Expand All @@ -64,18 +63,15 @@ service Versions {
option (google.api.method_signature) = "name";
}

// Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified
// [Flow][google.cloud.dialogflow.cx.v3.Flow].
// Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
//
// This method is a [long-running
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
// The returned `Operation` type has the following method-specific fields:
//
// - `metadata`:
// [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
// - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
// - `response`: [Version][google.cloud.dialogflow.cx.v3.Version]
rpc CreateVersion(CreateVersionRequest)
returns (google.longrunning.Operation) {
rpc CreateVersion(CreateVersionRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v3/{parent=projects/*/locations/*/agents/*/flows/*}/versions"
body: "version"
Expand Down Expand Up @@ -127,8 +123,7 @@ service Versions {
}

// Compares the specified base version with target version.
rpc CompareVersions(CompareVersionsRequest)
returns (CompareVersionsResponse) {
rpc CompareVersions(CompareVersionsRequest) returns (CompareVersionsResponse) {
option (google.api.http) = {
post: "/v3/{base_version=projects/*/locations/*/agents/*/flows/*/versions/*}:compareVersions"
body: "*"
Expand All @@ -141,11 +136,11 @@ service Versions {
// [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].
message CreateVersionOperationMetadata {
// Name of the created version.
// Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>/versions/<Version ID>`.
string version = 1 [(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/Version"
}];
type: "dialogflow.googleapis.com/Version"
}];
}

// Represents a version of a flow.
Expand All @@ -170,10 +165,9 @@ message Version {
FAILED = 3;
}

// Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
// Version ID is a self-increasing number generated by Dialogflow upon version
// creation.
// Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>/versions/<Version ID>. Version ID is a self-increasing
// number generated by Dialogflow upon version creation.
string name = 1;

// Required. The human-readable name of the version. Limit of 64 characters.
Expand All @@ -187,20 +181,18 @@ message Version {
NluSettings nlu_settings = 4 [(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. Create time of the version.
google.protobuf.Timestamp create_time = 5
[(google.api.field_behavior) = OUTPUT_ONLY];
google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. The state of this version. This field is read-only and cannot
// be set by create and update methods.
// Output only. The state of this version. This field is read-only and cannot be set by
// create and update methods.
State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The request message for
// [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
// The request message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
message ListVersionsRequest {
// Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all
// versions for. Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
// Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -216,8 +208,7 @@ message ListVersionsRequest {
string page_token = 3;
}

// The response message for
// [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
// The response message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].
message ListVersionsResponse {
// A list of versions. There will be a maximum number of items returned based
// on the page_size field in the request. The list may in some cases be empty
Expand All @@ -229,12 +220,11 @@ message ListVersionsResponse {
string next_page_token = 2;
}

// The request message for
// [Versions.GetVersion][google.cloud.dialogflow.cx.v3.Versions.GetVersion].
// The request message for [Versions.GetVersion][google.cloud.dialogflow.cx.v3.Versions.GetVersion].
message GetVersionRequest {
// Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version].
// Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>/versions/<Version ID>`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -243,12 +233,11 @@ message GetVersionRequest {
];
}

// The request message for
// [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].
// The request message for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].
message CreateVersionRequest {
// Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an
// [Version][google.cloud.dialogflow.cx.v3.Version] for. Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
// Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -260,24 +249,21 @@ message CreateVersionRequest {
Version version = 2 [(google.api.field_behavior) = REQUIRED];
}

// The request message for
// [Versions.UpdateVersion][google.cloud.dialogflow.cx.v3.Versions.UpdateVersion].
// The request message for [Versions.UpdateVersion][google.cloud.dialogflow.cx.v3.Versions.UpdateVersion].
message UpdateVersionRequest {
// Required. The version to update.
Version version = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The mask to control which fields get updated. Currently only
// `description` and `display_name` can be updated.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
// Required. The mask to control which fields get updated. Currently only `description`
// and `display_name` can be updated.
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
}

// The request message for
// [Versions.DeleteVersion][google.cloud.dialogflow.cx.v3.Versions.DeleteVersion].
// The request message for [Versions.DeleteVersion][google.cloud.dialogflow.cx.v3.Versions.DeleteVersion].
message DeleteVersionRequest {
// Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]
// to delete. Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
// Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>/versions/<Version ID>`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -286,12 +272,11 @@ message DeleteVersionRequest {
];
}

// The request message for
// [Versions.LoadVersion][google.cloud.dialogflow.cx.v3.Versions.LoadVersion].
// The request message for [Versions.LoadVersion][google.cloud.dialogflow.cx.v3.Versions.LoadVersion].
message LoadVersionRequest {
// Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded
// to draft flow. Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
// Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft flow.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
// ID>/flows/<Flow ID>/versions/<Version ID>`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -306,14 +291,13 @@ message LoadVersionRequest {
bool allow_override_agent_resources = 2;
}

// The request message for
// [Versions.CompareVersions][google.cloud.dialogflow.cx.v3.Versions.CompareVersions].
// The request message for [Versions.CompareVersions][google.cloud.dialogflow.cx.v3.Versions.CompareVersions].
message CompareVersionsRequest {
// Required. Name of the base flow version to compare with the target version.
// Use version ID `0` to indicate the draft version of the specified flow.
// Required. Name of the base flow version to compare with the target version. Use
// version ID `0` to indicate the draft version of the specified flow.
//
// Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
// Format: `projects/<Project ID>/locations/<Location ID>/agents/
// <Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
string base_version = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -323,8 +307,8 @@ message CompareVersionsRequest {

// Required. Name of the target flow version to compare with the
// base version. Use version ID `0` to indicate the draft version of the
// specified flow. Format:
// `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
// specified flow. Format: `projects/<Project ID>/locations/<Location
// ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
string target_version = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -342,8 +326,7 @@ message CompareVersionsRequest {
string language_code = 3;
}

// The response message for
// [Versions.CompareVersions][google.cloud.dialogflow.cx.v3.Versions.CompareVersions].
// The response message for [Versions.CompareVersions][google.cloud.dialogflow.cx.v3.Versions.CompareVersions].
message CompareVersionsResponse {
// JSON representation of the base version content.
string base_version_content_json = 1;
Expand Down
Loading