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

Commit

Permalink
docs: clarified meaning of the legacy editions docs: clarified semant…
Browse files Browse the repository at this point in the history
…ic of the streaming APIs (#759)

* docs: clarified meaning of the legacy editions docs: clarified semantic of the streaming APIs

PiperOrigin-RevId: 405426307

Source-Link: googleapis/googleapis@a51c341

Source-Link: googleapis/googleapis-gen@c59fe82
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYzU5ZmU4MmVlMDU5NzQwMGI2OWJkZDE5M2IzYjJlMTVlMTNlYjlkMCJ9

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Oct 26, 2021
1 parent 728c688 commit 9d53e67
Show file tree
Hide file tree
Showing 7 changed files with 247 additions and 214 deletions.
Expand Up @@ -571,7 +571,7 @@ public enum Tier implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* Standard tier.
* Trial Edition, previously known as Standard Edition.
* </pre>
*
* <code>TIER_STANDARD = 1;</code>
Expand All @@ -581,7 +581,7 @@ public enum Tier implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* Enterprise tier (Essentials).
* Essentials Edition, previously known as Enterprise Essential Edition.
* </pre>
*
* <code>TIER_ENTERPRISE = 2;</code>
Expand All @@ -591,11 +591,13 @@ public enum Tier implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* Enterprise tier (Plus).
* Essentials Edition (same as TIER_ENTERPRISE), previously known as
* Enterprise Plus Edition.
* </pre>
*
* <code>TIER_ENTERPRISE_PLUS = 3;</code>
* <code>TIER_ENTERPRISE_PLUS = 3 [deprecated = true];</code>
*/
@java.lang.Deprecated
TIER_ENTERPRISE_PLUS(3),
UNRECOGNIZED(-1),
;
Expand All @@ -614,7 +616,7 @@ public enum Tier implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* Standard tier.
* Trial Edition, previously known as Standard Edition.
* </pre>
*
* <code>TIER_STANDARD = 1;</code>
Expand All @@ -624,7 +626,7 @@ public enum Tier implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* Enterprise tier (Essentials).
* Essentials Edition, previously known as Enterprise Essential Edition.
* </pre>
*
* <code>TIER_ENTERPRISE = 2;</code>
Expand All @@ -634,12 +636,13 @@ public enum Tier implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* Enterprise tier (Plus).
* Essentials Edition (same as TIER_ENTERPRISE), previously known as
* Enterprise Plus Edition.
* </pre>
*
* <code>TIER_ENTERPRISE_PLUS = 3;</code>
* <code>TIER_ENTERPRISE_PLUS = 3 [deprecated = true];</code>
*/
public static final int TIER_ENTERPRISE_PLUS_VALUE = 3;
@java.lang.Deprecated public static final int TIER_ENTERPRISE_PLUS_VALUE = 3;

public final int getNumber() {
if (this == UNRECOGNIZED) {
Expand Down
Expand Up @@ -98,7 +98,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "lidation_result.proto\032#google/longrunnin"
+ "g/operations.proto\032\033google/protobuf/empt"
+ "y.proto\032 google/protobuf/field_mask.prot"
+ "o\"\373\006\n\005Agent\022C\n\006parent\030\001 \001(\tB3\340A\002\372A-\n+clo"
+ "o\"\377\006\n\005Agent\022C\n\006parent\030\001 \001(\tB3\340A\002\372A-\n+clo"
+ "udresourcemanager.googleapis.com/Project"
+ "\022\024\n\014display_name\030\002 \001(\t\022\035\n\025default_langua"
+ "ge_code\030\003 \001(\t\022 \n\030supported_language_code"
Expand All @@ -115,106 +115,106 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "TCH_MODE_ML_ONLY\020\002\"l\n\nApiVersion\022\033\n\027API_"
+ "VERSION_UNSPECIFIED\020\000\022\022\n\016API_VERSION_V1\020"
+ "\001\022\022\n\016API_VERSION_V2\020\002\022\031\n\025API_VERSION_V2_"
+ "BETA_1\020\003\"^\n\004Tier\022\024\n\020TIER_UNSPECIFIED\020\000\022\021"
+ "\n\rTIER_STANDARD\020\001\022\023\n\017TIER_ENTERPRISE\020\002\022\030"
+ "\n\024TIER_ENTERPRISE_PLUS\020\003:m\352Aj\n\037dialogflo"
+ "w.googleapis.com/Agent\022\030projects/{projec"
+ "t}/agent\022-projects/{project}/locations/{"
+ "location}/agent\"J\n\017GetAgentRequest\0227\n\006pa"
+ "rent\030\001 \001(\tB\'\340A\002\372A!\022\037dialogflow.googleapi"
+ "s.com/Agent\"~\n\017SetAgentRequest\022:\n\005agent\030"
+ "\001 \001(\0132&.google.cloud.dialogflow.v2beta1."
+ "AgentB\003\340A\002\022/\n\013update_mask\030\002 \001(\0132\032.google"
+ ".protobuf.FieldMask\"M\n\022DeleteAgentReques"
+ "t\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037dialogflow.go"
+ "ogleapis.com/Agent\"0\n\010SubAgent\022\017\n\007projec"
+ "t\030\001 \001(\t\022\023\n\013environment\030\002 \001(\t\"u\n\023SearchAg"
+ "entsRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037dia"
+ "logflow.googleapis.com/Agent\022\021\n\tpage_siz"
+ "e\030\002 \001(\005\022\022\n\npage_token\030\003 \001(\t\"g\n\024SearchAge"
+ "ntsResponse\0226\n\006agents\030\001 \003(\0132&.google.clo"
+ "ud.dialogflow.v2beta1.Agent\022\027\n\017next_page"
+ "_token\030\002 \001(\t\"L\n\021TrainAgentRequest\0227\n\006par"
+ "ent\030\001 \001(\tB\'\340A\002\372A!\022\037dialogflow.googleapis"
+ ".com/Agent\"`\n\022ExportAgentRequest\0227\n\006pare"
+ "nt\030\001 \001(\tB\'\340A\002\372A!\022\037dialogflow.googleapis."
+ "com/Agent\022\021\n\tagent_uri\030\002 \001(\t\"L\n\023ExportAg"
+ "entResponse\022\023\n\tagent_uri\030\001 \001(\tH\000\022\027\n\ragen"
+ "t_content\030\002 \001(\014H\000B\007\n\005agent\"\204\001\n\022ImportAge"
+ "ntRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037dialo"
+ "gflow.googleapis.com/Agent\022\023\n\tagent_uri\030"
+ "\002 \001(\tH\000\022\027\n\ragent_content\030\003 \001(\014H\000B\007\n\005agen"
+ "t\"\205\001\n\023RestoreAgentRequest\0227\n\006parent\030\001 \001("
+ "\tB\'\340A\002\372A!\022\037dialogflow.googleapis.com/Age"
+ "nt\022\023\n\tagent_uri\030\002 \001(\tH\000\022\027\n\ragent_content"
+ "\030\003 \001(\014H\000B\007\n\005agent\"q\n\032GetValidationResult"
+ "Request\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037dialogf"
+ "low.googleapis.com/Agent\022\032\n\rlanguage_cod"
+ "e\030\003 \001(\tB\003\340A\0012\312\022\n\006Agents\022\313\001\n\010GetAgent\0220.g"
+ "oogle.cloud.dialogflow.v2beta1.GetAgentR"
+ "equest\032&.google.cloud.dialogflow.v2beta1"
+ ".Agent\"e\202\323\344\223\002V\022\"/v2beta1/{parent=project"
+ "s/*}/agentZ0\022./v2beta1/{parent=projects/"
+ "*/locations/*}/agent\332A\006parent\022\344\001\n\010SetAge"
+ "nt\0220.google.cloud.dialogflow.v2beta1.Set"
+ "AgentRequest\032&.google.cloud.dialogflow.v"
+ "2beta1.Agent\"~\202\323\344\223\002p\"(/v2beta1/{agent.pa"
+ "rent=projects/*}/agent:\005agentZ=\"4/v2beta"
+ "1/{agent.parent=projects/*/locations/*}/"
+ "agent:\005agent\332A\005agent\022\301\001\n\013DeleteAgent\0223.g"
+ "oogle.cloud.dialogflow.v2beta1.DeleteAge"
+ "ntRequest\032\026.google.protobuf.Empty\"e\202\323\344\223\002"
+ "V*\"/v2beta1/{parent=projects/*}/agentZ0*"
+ "./v2beta1/{parent=projects/*/locations/*"
+ "}/agent\332A\006parent\022\360\001\n\014SearchAgents\0224.goog"
+ "le.cloud.dialogflow.v2beta1.SearchAgents"
+ "Request\0325.google.cloud.dialogflow.v2beta"
+ "1.SearchAgentsResponse\"s\202\323\344\223\002d\022)/v2beta1"
+ "/{parent=projects/*}/agent:searchZ7\0225/v2"
+ "beta1/{parent=projects/*/locations/*}/ag"
+ "ent:search\332A\006parent\022\213\002\n\nTrainAgent\0222.goo"
+ "gle.cloud.dialogflow.v2beta1.TrainAgentR"
+ "equest\032\035.google.longrunning.Operation\"\251\001"
+ "\202\323\344\223\002h\"(/v2beta1/{parent=projects/*}/age"
+ "nt:train:\001*Z9\"4/v2beta1/{parent=projects"
+ "/*/locations/*}/agent:train:\001*\332A\006parent\312"
+ "A/\n\025google.protobuf.Empty\022\026google.protob"
+ "uf.Struct\022\255\002\n\013ExportAgent\0223.google.cloud"
+ ".dialogflow.v2beta1.ExportAgentRequest\032\035"
+ ".google.longrunning.Operation\"\311\001\202\323\344\223\002j\")"
+ "/v2beta1/{parent=projects/*}/agent:expor"
+ "t:\001*Z:\"5/v2beta1/{parent=projects/*/loca"
+ "tions/*}/agent:export:\001*\332A\006parent\312AM\n3go"
+ "ogle.cloud.dialogflow.v2beta1.ExportAgen"
+ "tResponse\022\026google.protobuf.Struct\022\206\002\n\013Im"
+ "portAgent\0223.google.cloud.dialogflow.v2be"
+ "ta1.ImportAgentRequest\032\035.google.longrunn"
+ "ing.Operation\"\242\001\202\323\344\223\002j\")/v2beta1/{parent"
+ "=projects/*}/agent:import:\001*Z:\"5/v2beta1"
+ "/{parent=projects/*/locations/*}/agent:i"
+ "mport:\001*\312A/\n\025google.protobuf.Empty\022\026goog"
+ "le.protobuf.Struct\022\212\002\n\014RestoreAgent\0224.go"
+ "ogle.cloud.dialogflow.v2beta1.RestoreAge"
+ "ntRequest\032\035.google.longrunning.Operation"
+ "\"\244\001\202\323\344\223\002l\"*/v2beta1/{parent=projects/*}/"
+ "agent:restore:\001*Z;\"6/v2beta1/{parent=pro"
+ "jects/*/locations/*}/agent:restore:\001*\312A/"
+ "\n\025google.protobuf.Empty\022\026google.protobuf"
+ ".Struct\022\205\002\n\023GetValidationResult\022;.google"
+ ".cloud.dialogflow.v2beta1.GetValidationR"
+ "esultRequest\0321.google.cloud.dialogflow.v"
+ "2beta1.ValidationResult\"~\202\323\344\223\002x\0223/v2beta"
+ "1/{parent=projects/*}/agent/validationRe"
+ "sultZA\022?/v2beta1/{parent=projects/*/loca"
+ "tions/*}/agent/validationResult\032x\312A\031dial"
+ "ogflow.googleapis.com\322AYhttps://www.goog"
+ "leapis.com/auth/cloud-platform,https://w"
+ "ww.googleapis.com/auth/dialogflowB\250\001\n#co"
+ "m.google.cloud.dialogflow.v2beta1B\nAgent"
+ "ProtoP\001ZIgoogle.golang.org/genproto/goog"
+ "leapis/cloud/dialogflow/v2beta1;dialogfl"
+ "ow\370\001\001\242\002\002DF\252\002\037Google.Cloud.Dialogflow.V2b"
+ "eta1b\006proto3"
+ "BETA_1\020\003\"b\n\004Tier\022\024\n\020TIER_UNSPECIFIED\020\000\022\021"
+ "\n\rTIER_STANDARD\020\001\022\023\n\017TIER_ENTERPRISE\020\002\022\034"
+ "\n\024TIER_ENTERPRISE_PLUS\020\003\032\002\010\001:m\352Aj\n\037dialo"
+ "gflow.googleapis.com/Agent\022\030projects/{pr"
+ "oject}/agent\022-projects/{project}/locatio"
+ "ns/{location}/agent\"J\n\017GetAgentRequest\0227"
+ "\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037dialogflow.googl"
+ "eapis.com/Agent\"~\n\017SetAgentRequest\022:\n\005ag"
+ "ent\030\001 \001(\0132&.google.cloud.dialogflow.v2be"
+ "ta1.AgentB\003\340A\002\022/\n\013update_mask\030\002 \001(\0132\032.go"
+ "ogle.protobuf.FieldMask\"M\n\022DeleteAgentRe"
+ "quest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037dialogflo"
+ "w.googleapis.com/Agent\"0\n\010SubAgent\022\017\n\007pr"
+ "oject\030\001 \001(\t\022\023\n\013environment\030\002 \001(\t\"u\n\023Sear"
+ "chAgentsRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022"
+ "\037dialogflow.googleapis.com/Agent\022\021\n\tpage"
+ "_size\030\002 \001(\005\022\022\n\npage_token\030\003 \001(\t\"g\n\024Searc"
+ "hAgentsResponse\0226\n\006agents\030\001 \003(\0132&.google"
+ ".cloud.dialogflow.v2beta1.Agent\022\027\n\017next_"
+ "page_token\030\002 \001(\t\"L\n\021TrainAgentRequest\0227\n"
+ "\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037dialogflow.google"
+ "apis.com/Agent\"`\n\022ExportAgentRequest\0227\n\006"
+ "parent\030\001 \001(\tB\'\340A\002\372A!\022\037dialogflow.googlea"
+ "pis.com/Agent\022\021\n\tagent_uri\030\002 \001(\t\"L\n\023Expo"
+ "rtAgentResponse\022\023\n\tagent_uri\030\001 \001(\tH\000\022\027\n\r"
+ "agent_content\030\002 \001(\014H\000B\007\n\005agent\"\204\001\n\022Impor"
+ "tAgentRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037d"
+ "ialogflow.googleapis.com/Agent\022\023\n\tagent_"
+ "uri\030\002 \001(\tH\000\022\027\n\ragent_content\030\003 \001(\014H\000B\007\n\005"
+ "agent\"\205\001\n\023RestoreAgentRequest\0227\n\006parent\030"
+ "\001 \001(\tB\'\340A\002\372A!\022\037dialogflow.googleapis.com"
+ "/Agent\022\023\n\tagent_uri\030\002 \001(\tH\000\022\027\n\ragent_con"
+ "tent\030\003 \001(\014H\000B\007\n\005agent\"q\n\032GetValidationRe"
+ "sultRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\022\037dia"
+ "logflow.googleapis.com/Agent\022\032\n\rlanguage"
+ "_code\030\003 \001(\tB\003\340A\0012\312\022\n\006Agents\022\313\001\n\010GetAgent"
+ "\0220.google.cloud.dialogflow.v2beta1.GetAg"
+ "entRequest\032&.google.cloud.dialogflow.v2b"
+ "eta1.Agent\"e\202\323\344\223\002V\022\"/v2beta1/{parent=pro"
+ "jects/*}/agentZ0\022./v2beta1/{parent=proje"
+ "cts/*/locations/*}/agent\332A\006parent\022\344\001\n\010Se"
+ "tAgent\0220.google.cloud.dialogflow.v2beta1"
+ ".SetAgentRequest\032&.google.cloud.dialogfl"
+ "ow.v2beta1.Agent\"~\202\323\344\223\002p\"(/v2beta1/{agen"
+ "t.parent=projects/*}/agent:\005agentZ=\"4/v2"
+ "beta1/{agent.parent=projects/*/locations"
+ "/*}/agent:\005agent\332A\005agent\022\301\001\n\013DeleteAgent"
+ "\0223.google.cloud.dialogflow.v2beta1.Delet"
+ "eAgentRequest\032\026.google.protobuf.Empty\"e\202"
+ "\323\344\223\002V*\"/v2beta1/{parent=projects/*}/agen"
+ "tZ0*./v2beta1/{parent=projects/*/locatio"
+ "ns/*}/agent\332A\006parent\022\360\001\n\014SearchAgents\0224."
+ "google.cloud.dialogflow.v2beta1.SearchAg"
+ "entsRequest\0325.google.cloud.dialogflow.v2"
+ "beta1.SearchAgentsResponse\"s\202\323\344\223\002d\022)/v2b"
+ "eta1/{parent=projects/*}/agent:searchZ7\022"
+ "5/v2beta1/{parent=projects/*/locations/*"
+ "}/agent:search\332A\006parent\022\213\002\n\nTrainAgent\0222"
+ ".google.cloud.dialogflow.v2beta1.TrainAg"
+ "entRequest\032\035.google.longrunning.Operatio"
+ "n\"\251\001\202\323\344\223\002h\"(/v2beta1/{parent=projects/*}"
+ "/agent:train:\001*Z9\"4/v2beta1/{parent=proj"
+ "ects/*/locations/*}/agent:train:\001*\332A\006par"
+ "ent\312A/\n\025google.protobuf.Empty\022\026google.pr"
+ "otobuf.Struct\022\255\002\n\013ExportAgent\0223.google.c"
+ "loud.dialogflow.v2beta1.ExportAgentReque"
+ "st\032\035.google.longrunning.Operation\"\311\001\202\323\344\223"
+ "\002j\")/v2beta1/{parent=projects/*}/agent:e"
+ "xport:\001*Z:\"5/v2beta1/{parent=projects/*/"
+ "locations/*}/agent:export:\001*\332A\006parent\312AM"
+ "\n3google.cloud.dialogflow.v2beta1.Export"
+ "AgentResponse\022\026google.protobuf.Struct\022\206\002"
+ "\n\013ImportAgent\0223.google.cloud.dialogflow."
+ "v2beta1.ImportAgentRequest\032\035.google.long"
+ "running.Operation\"\242\001\202\323\344\223\002j\")/v2beta1/{pa"
+ "rent=projects/*}/agent:import:\001*Z:\"5/v2b"
+ "eta1/{parent=projects/*/locations/*}/age"
+ "nt:import:\001*\312A/\n\025google.protobuf.Empty\022\026"
+ "google.protobuf.Struct\022\212\002\n\014RestoreAgent\022"
+ "4.google.cloud.dialogflow.v2beta1.Restor"
+ "eAgentRequest\032\035.google.longrunning.Opera"
+ "tion\"\244\001\202\323\344\223\002l\"*/v2beta1/{parent=projects"
+ "/*}/agent:restore:\001*Z;\"6/v2beta1/{parent"
+ "=projects/*/locations/*}/agent:restore:\001"
+ "*\312A/\n\025google.protobuf.Empty\022\026google.prot"
+ "obuf.Struct\022\205\002\n\023GetValidationResult\022;.go"
+ "ogle.cloud.dialogflow.v2beta1.GetValidat"
+ "ionResultRequest\0321.google.cloud.dialogfl"
+ "ow.v2beta1.ValidationResult\"~\202\323\344\223\002x\0223/v2"
+ "beta1/{parent=projects/*}/agent/validati"
+ "onResultZA\022?/v2beta1/{parent=projects/*/"
+ "locations/*}/agent/validationResult\032x\312A\031"
+ "dialogflow.googleapis.com\322AYhttps://www."
+ "googleapis.com/auth/cloud-platform,https"
+ "://www.googleapis.com/auth/dialogflowB\250\001"
+ "\n#com.google.cloud.dialogflow.v2beta1B\nA"
+ "gentProtoP\001ZIgoogle.golang.org/genproto/"
+ "googleapis/cloud/dialogflow/v2beta1;dial"
+ "ogflow\370\001\001\242\002\002DF\252\002\037Google.Cloud.Dialogflow"
+ ".V2beta1b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
Expand Down
Expand Up @@ -25,10 +25,11 @@
* The top-level message returned from the
* `StreamingDetectIntent` method.
* Multiple response messages can be returned in order:
* 1. If the input was set to streaming audio, the first one or more messages
* contain `recognition_result`. Each `recognition_result` represents a more
* complete transcript of what the user said. The last `recognition_result`
* has `is_final` set to `true`.
* 1. If the `StreamingDetectIntentRequest.input_audio` field was
* set, the `recognition_result` field is populated for one
* or more messages.
* See the [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] message for details
* about the result message sequence.
* 2. The next message contains `response_id`, `query_result`,
* `alternative_query_results` and optionally `webhook_status` if a WebHook
* was called.
Expand Down Expand Up @@ -844,10 +845,11 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
* The top-level message returned from the
* `StreamingDetectIntent` method.
* Multiple response messages can be returned in order:
* 1. If the input was set to streaming audio, the first one or more messages
* contain `recognition_result`. Each `recognition_result` represents a more
* complete transcript of what the user said. The last `recognition_result`
* has `is_final` set to `true`.
* 1. If the `StreamingDetectIntentRequest.input_audio` field was
* set, the `recognition_result` field is populated for one
* or more messages.
* See the [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] message for details
* about the result message sequence.
* 2. The next message contains `response_id`, `query_result`,
* `alternative_query_results` and optionally `webhook_status` if a WebHook
* was called.
Expand Down

0 comments on commit 9d53e67

Please sign in to comment.