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

docs: more detailed docs on APIs such as Environment, Intents, Sessions. #247

Merged
merged 1 commit into from
Jul 28, 2020
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
Original file line number Diff line number Diff line change
Expand Up @@ -41,30 +41,7 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Agents are best described as Natural Language Understanding (NLU) modules
* that transform user requests into actionable data. You can include agents in your app, product,
* or service to determine user intent and respond to the user in a natural way.
*
* <p>After you create an agent, you can add [Intents][google.cloud.dialogflow.v2beta1.Intents],
* [Contexts][google.cloud.dialogflow.v2beta1.Contexts], [Entity
* Types][google.cloud.dialogflow.v2beta1.EntityTypes],
* [Webhooks][google.cloud.dialogflow.v2beta1.WebhookRequest], and so on to manage the flow of a
* conversation and match user input to predefined intents and actions.
*
* <p>You can create an agent using both Dialogflow Standard Edition and Dialogflow Enterprise
* Edition. For details, see [Dialogflow
* Editions](https://cloud.google.com/dialogflow/docs/editions).
*
* <p>You can save your agent for backup or versioning by exporting the agent by using the
* [ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent] method. You can import a saved
* agent by using the [ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent] method.
*
* <p>Dialogflow provides several [prebuilt
* agents](https://cloud.google.com/dialogflow/docs/agents-prebuilt) for common conversation
* scenarios such as determining a date and time, converting currency, and so on.
*
* <p>For more information about agents, see the [Dialogflow
* documentation](https://cloud.google.com/dialogflow/docs/agents-overview).
* Service Description: Service for managing [Agents][google.cloud.dialogflow.v2beta1.Agent].
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,7 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: A context represents additional information included with user input or with
* an intent returned by the Dialogflow API. Contexts are helpful for differentiating user input
* which may be vague or have a different meaning depending on additional details from your
* application such as user setting and preferences, previous user input, where the user is in your
* application, geographic location, and so on.
*
* <p>You can include contexts as input parameters of a
* [DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent] (or
* [StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]) request,
* or as output contexts included in the returned intent. Contexts expire when an intent is matched,
* after the number of `DetectIntent` requests specified by the `lifespan_count` parameter, or after
* 20 minutes if no intents are matched for a `DetectIntent` request.
*
* <p>For more information about contexts, see the [Dialogflow
* documentation](https://cloud.google.com/dialogflow/docs/contexts-overview).
* Service Description: Service for managing [Contexts][google.cloud.dialogflow.v2beta1.Context].
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Manages documents of a knowledge base.
* Service Description: Service for managing knowledge
* [Documents][google.cloud.dialogflow.v2beta1.Document].
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,31 +41,8 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Entities are extracted from user input and represent parameters that are
* meaningful to your application. For example, a date range, a proper name such as a geographic
* location or landmark, and so on. Entities represent actionable data for your application.
*
* <p>When you define an entity, you can also include synonyms that all map to that entity. For
* example, "soft drink", "soda", "pop", and so on.
*
* <p>There are three types of entities:
*
* <p>&#42; &#42;&#42;System&#42;&#42; - entities that are defined by the Dialogflow API for common
* data types such as date, time, currency, and so on. A system entity is represented by the
* `EntityType` type.
*
* <p>&#42; &#42;&#42;Custom&#42;&#42; - entities that are defined by you that represent actionable
* data that is meaningful to your application. For example, you could define a `pizza.sauce` entity
* for red or white pizza sauce, a `pizza.cheese` entity for the different types of cheese on a
* pizza, a `pizza.topping` entity for different toppings, and so on. A custom entity is represented
* by the `EntityType` type.
*
* <p>&#42; &#42;&#42;User&#42;&#42; - entities that are built for an individual user such as
* favorites, preferences, playlists, and so on. A user entity is represented by the
* [SessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityType] type.
*
* <p>For more information about entity types, see the [Dialogflow
* documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
* Service Description: Service for managing
* [EntityTypes][google.cloud.dialogflow.v2beta1.EntityType].
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Manages agent environments.
* Service Description: Service for managing
* [Environments][google.cloud.dialogflow.v2beta1.Environment].
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,33 +42,7 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: An intent represents a mapping between input from a user and an action to be
* taken by your application. When you pass user input to the
* [DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent] (or
* [StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]) method,
* the Dialogflow API analyzes the input and searches for a matching intent. If no match is found,
* the Dialogflow API returns a fallback intent (`is_fallback` = true).
*
* <p>You can provide additional information for the Dialogflow API to use to match user input to an
* intent by adding the following to your intent.
*
* <p>&#42; &#42;&#42;Contexts&#42;&#42; - provide additional context for intent analysis. For
* example, if an intent is related to an object in your application that plays music, you can
* provide a context to determine when to match the intent if the user input is "turn it off". You
* can include a context that matches the intent when there is previous user input of "play music",
* and not when there is previous user input of "turn on the light".
*
* <p>&#42; &#42;&#42;Events&#42;&#42; - allow for matching an intent by using an event name instead
* of user input. Your application can provide an event name and related parameters to the
* Dialogflow API to match an intent. For example, when your application starts, you can send a
* welcome event with a user name parameter to the Dialogflow API to match an intent with a
* personalized welcome message for the user.
*
* <p>&#42; &#42;&#42;Training phrases&#42;&#42; - provide examples of user input to train the
* Dialogflow API agent to better match intents.
*
* <p>For more information about intents, see the [Dialogflow
* documentation](https://cloud.google.com/dialogflow/docs/intents-overview).
* Service Description: Service for managing [Intents][google.cloud.dialogflow.v2beta1.Intent].
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,8 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Manages knowledge bases.
*
* <p>Allows users to setup and maintain knowledge bases with their knowledge data.
* Service Description: Service for managing
* [KnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBase].
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,8 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Entities are extracted from user input and represent parameters that are
* meaningful to your application. For example, a date range, a proper name such as a geographic
* location or landmark, and so on. Entities represent actionable data for your application.
*
* <p>Session entity types are referred to as &#42;&#42;User&#42;&#42; entity types and are entities
* that are built for an individual user such as favorites, preferences, playlists, and so on. You
* can redefine a session entity type at the session level.
*
* <p>Session entity methods do not work with Google Assistant integration. Contact Dialogflow
* support if you need to use session entities with Google Assistant integration.
*
* <p>For more information about entity types, see the [Dialogflow
* documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
* Service Description: Service for managing
* [SessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityType].
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@

// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: A session represents an interaction with a user. You retrieve user input and
* pass it to the [DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent] (or
* [StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]) method
* to determine user intent and respond.
* Service Description: A service used for session interactions.
*
* <p>For more information, see the [API interactions
* guide](https://cloud.google.com/dialogflow/docs/api-overview).
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
Expand Down Expand Up @@ -171,6 +171,8 @@ public SessionsStub getStub() {
* appropriate `Session ID` and `User Id`. They can be a random number or some type of user
* and session identifiers (preferably hashed). The length of the `Session ID` and `User ID`
* must not exceed 36 characters.
* <p>For more information, see the [API interactions
* guide](https://cloud.google.com/dialogflow/docs/api-overview).
* @param queryInput Required. The input specification. It can be set to:
* <p>1. an audio config which instructs the speech recognizer how to process the speech
* audio,
Expand Down Expand Up @@ -211,6 +213,8 @@ public final DetectIntentResponse detectIntent(SessionName session, QueryInput q
* appropriate `Session ID` and `User Id`. They can be a random number or some type of user
* and session identifiers (preferably hashed). The length of the `Session ID` and `User ID`
* must not exceed 36 characters.
* <p>For more information, see the [API interactions
* guide](https://cloud.google.com/dialogflow/docs/api-overview).
* @param queryInput Required. The input specification. It can be set to:
* <p>1. an audio config which instructs the speech recognizer how to process the speech
* audio,
Expand Down
Loading