• Home
• com.google.apis
• google-api-services-dialogflow
• v3-rev20240617-2.0.0
• source code
• Dialogflow.Projects.Locations.Agents.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.dialogflow.v3.Dialogflow.Projects.Locations.Agents.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dialogflow.v3
Class Dialogflow.Projects.Locations.Agents



java.lang.Object


com.google.api.services.dialogflow.v3.Dialogflow.Projects.Locations.Agents







Enclosing class:
Dialogflow.Projects.Locations




public class Dialogflow.Projects.Locations.Agents
extends Object
The "agents" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Dialogflow.Projects.Locations.Agents.Changelogs
The "changelogs" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.Create 


class 
Dialogflow.Projects.Locations.Agents.Delete 


class 
Dialogflow.Projects.Locations.Agents.EntityTypes
The "entityTypes" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.Environments
The "environments" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.Export 


class 
Dialogflow.Projects.Locations.Agents.Flows
The "flows" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.Generators
The "generators" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.Get 


class 
Dialogflow.Projects.Locations.Agents.GetGenerativeSettings 


class 
Dialogflow.Projects.Locations.Agents.GetValidationResult 


class 
Dialogflow.Projects.Locations.Agents.Intents
The "intents" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.List 


class 
Dialogflow.Projects.Locations.Agents.Patch 


class 
Dialogflow.Projects.Locations.Agents.Restore 


class 
Dialogflow.Projects.Locations.Agents.Sessions
The "sessions" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.TestCases
The "testCases" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.TransitionRouteGroups
The "transitionRouteGroups" collection of methods.



class 
Dialogflow.Projects.Locations.Agents.UpdateGenerativeSettings 


class 
Dialogflow.Projects.Locations.Agents.Validate 


class 
Dialogflow.Projects.Locations.Agents.Webhooks
The "webhooks" collection of methods.










Constructor Summary

Constructors 

Constructor and Description


Agents() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Dialogflow.Projects.Locations.Agents.Changelogs
changelogs()
An accessor for creating requests from the Changelogs collection.



Dialogflow.Projects.Locations.Agents.Create
create(String parent,
      GoogleCloudDialogflowCxV3Agent content)
Creates an agent in the specified location.



Dialogflow.Projects.Locations.Agents.Delete
delete(String name)
Deletes the specified agent.



Dialogflow.Projects.Locations.Agents.EntityTypes
entityTypes()
An accessor for creating requests from the EntityTypes collection.



Dialogflow.Projects.Locations.Agents.Environments
environments()
An accessor for creating requests from the Environments collection.



Dialogflow.Projects.Locations.Agents.Export
export(String name,
      GoogleCloudDialogflowCxV3ExportAgentRequest content)
Exports the specified agent to a binary file.



Dialogflow.Projects.Locations.Agents.Flows
flows()
An accessor for creating requests from the Flows collection.



Dialogflow.Projects.Locations.Agents.Generators
generators()
An accessor for creating requests from the Generators collection.



Dialogflow.Projects.Locations.Agents.Get
get(String name)
Retrieves the specified agent.



Dialogflow.Projects.Locations.Agents.GetGenerativeSettings
getGenerativeSettings(String name)
Gets the generative settings for the agent.



Dialogflow.Projects.Locations.Agents.GetValidationResult
getValidationResult(String name)
Gets the latest agent validation result.



Dialogflow.Projects.Locations.Agents.Intents
intents()
An accessor for creating requests from the Intents collection.



Dialogflow.Projects.Locations.Agents.List
list(String parent)
Returns the list of all agents in the specified location.



Dialogflow.Projects.Locations.Agents.Patch
patch(String name,
     GoogleCloudDialogflowCxV3Agent content)
Updates the specified agent.



Dialogflow.Projects.Locations.Agents.Restore
restore(String name,
       GoogleCloudDialogflowCxV3RestoreAgentRequest content)
Restores the specified agent from a binary file.



Dialogflow.Projects.Locations.Agents.Sessions
sessions()
An accessor for creating requests from the Sessions collection.



Dialogflow.Projects.Locations.Agents.TestCases
testCases()
An accessor for creating requests from the TestCases collection.



Dialogflow.Projects.Locations.Agents.TransitionRouteGroups
transitionRouteGroups()
An accessor for creating requests from the TransitionRouteGroups collection.



Dialogflow.Projects.Locations.Agents.UpdateGenerativeSettings
updateGenerativeSettings(String name,
                        GoogleCloudDialogflowCxV3GenerativeSettings content)
Updates the generative settings for the agent.



Dialogflow.Projects.Locations.Agents.Validate
validate(String name,
        GoogleCloudDialogflowCxV3ValidateAgentRequest content)
Validates the specified agent and creates or updates validation results.



Dialogflow.Projects.Locations.Agents.Webhooks
webhooks()
An accessor for creating requests from the Webhooks collection.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Agents
public Agents()









Method Detail





create
public Dialogflow.Projects.Locations.Agents.Create create(String parent,
                                                          GoogleCloudDialogflowCxV3Agent content)
                                                   throws IOException
Creates an agent in the specified location. Note: You should always train flows prior to sending
 them queries. See the [training
 documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

 Create a request for the method "agents.create".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The location to create a agent for. Format: `projects//locations/`.
content - the GoogleCloudDialogflowCxV3Agent
Returns:
the request
Throws:
IOException








delete
public Dialogflow.Projects.Locations.Agents.Delete delete(String name)
                                                   throws IOException
Deletes the specified agent.

 Create a request for the method "agents.delete".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The name of the agent to delete. Format: `projects//locations//agents/`.
Returns:
the request
Throws:
IOException








export
public Dialogflow.Projects.Locations.Agents.Export export(String name,
                                                          GoogleCloudDialogflowCxV3ExportAgentRequest content)
                                                   throws IOException
Exports the specified agent to a binary file. 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`: An empty [Struct
 message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -
 `response`: ExportAgentResponse

 Create a request for the method "agents.export".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The name of the agent to export. Format: `projects//locations//agents/`.
content - the GoogleCloudDialogflowCxV3ExportAgentRequest
Returns:
the request
Throws:
IOException








get
public Dialogflow.Projects.Locations.Agents.Get get(String name)
                                             throws IOException
Retrieves the specified agent.

 Create a request for the method "agents.get".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The name of the agent. Format: `projects//locations//agents/`.
Returns:
the request
Throws:
IOException








getGenerativeSettings
public Dialogflow.Projects.Locations.Agents.GetGenerativeSettings getGenerativeSettings(String name)
                                                                                 throws IOException
Gets the generative settings for the agent.

 Create a request for the method "agents.getGenerativeSettings".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Required. Format: `projects//locations//agents//generativeSettings`.
Returns:
the request
Throws:
IOException








getValidationResult
public Dialogflow.Projects.Locations.Agents.GetValidationResult getValidationResult(String name)
                                                                             throws IOException
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is
 called.

 Create a request for the method "agents.getValidationResult".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The agent name. Format: `projects//locations//agents//validationResult`.
Returns:
the request
Throws:
IOException








list
public Dialogflow.Projects.Locations.Agents.List list(String parent)
                                               throws IOException
Returns the list of all agents in the specified location.

 Create a request for the method "agents.list".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The location to list all agents for. Format: `projects//locations/`.
Returns:
the request
Throws:
IOException








patch
public Dialogflow.Projects.Locations.Agents.Patch patch(String name,
                                                        GoogleCloudDialogflowCxV3Agent content)
                                                 throws IOException
Updates the specified agent. Note: You should always train flows prior to sending them queries.
 See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

 Create a request for the method "agents.patch".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent
        populates the name automatically. Format: `projects//locations//agents/`.
content - the GoogleCloudDialogflowCxV3Agent
Returns:
the request
Throws:
IOException








restore
public Dialogflow.Projects.Locations.Agents.Restore restore(String name,
                                                            GoogleCloudDialogflowCxV3RestoreAgentRequest content)
                                                     throws IOException
Restores the specified agent from a binary file. Replaces the current agent with a new one. Note
 that all existing resources in agent (e.g. intents, entity types, flows) will be removed. 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`: An empty [Struct message](https://developers.google.com/protocol-
 buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty
 message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
 Note: You should always train flows prior to sending them queries. See the [training
 documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

 Create a request for the method "agents.restore".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The name of the agent to restore into. Format: `projects//locations//agents/`.
content - the GoogleCloudDialogflowCxV3RestoreAgentRequest
Returns:
the request
Throws:
IOException








updateGenerativeSettings
public Dialogflow.Projects.Locations.Agents.UpdateGenerativeSettings updateGenerativeSettings(String name,
                                                                                              GoogleCloudDialogflowCxV3GenerativeSettings content)
                                                                                       throws IOException
Updates the generative settings for the agent.

 Create a request for the method "agents.updateGenerativeSettings".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Format: `projects//locations//agents//generativeSettings`.
content - the GoogleCloudDialogflowCxV3GenerativeSettings
Returns:
the request
Throws:
IOException








validate
public Dialogflow.Projects.Locations.Agents.Validate validate(String name,
                                                              GoogleCloudDialogflowCxV3ValidateAgentRequest content)
                                                       throws IOException
Validates the specified agent and creates or updates validation results. The agent in draft
 version is validated. Please call this API after the training is completed to get the complete
 validation results.

 Create a request for the method "agents.validate".

 This request holds the parameters needed by the dialogflow server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The agent to validate. Format: `projects//locations//agents/`.
content - the GoogleCloudDialogflowCxV3ValidateAgentRequest
Returns:
the request
Throws:
IOException








changelogs
public Dialogflow.Projects.Locations.Agents.Changelogs changelogs()
An accessor for creating requests from the Changelogs collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.Changelogs.List request = dialogflow.changelogs().list(parameters ...)
 

Returns:
the resource collection








entityTypes
public Dialogflow.Projects.Locations.Agents.EntityTypes entityTypes()
An accessor for creating requests from the EntityTypes collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.EntityTypes.List request = dialogflow.entityTypes().list(parameters ...)
 

Returns:
the resource collection








environments
public Dialogflow.Projects.Locations.Agents.Environments environments()
An accessor for creating requests from the Environments collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.Environments.List request = dialogflow.environments().list(parameters ...)
 

Returns:
the resource collection








flows
public Dialogflow.Projects.Locations.Agents.Flows flows()
An accessor for creating requests from the Flows collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.Flows.List request = dialogflow.flows().list(parameters ...)
 

Returns:
the resource collection








generators
public Dialogflow.Projects.Locations.Agents.Generators generators()
An accessor for creating requests from the Generators collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.Generators.List request = dialogflow.generators().list(parameters ...)
 

Returns:
the resource collection








intents
public Dialogflow.Projects.Locations.Agents.Intents intents()
An accessor for creating requests from the Intents collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.Intents.List request = dialogflow.intents().list(parameters ...)
 

Returns:
the resource collection








sessions
public Dialogflow.Projects.Locations.Agents.Sessions sessions()
An accessor for creating requests from the Sessions collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.Sessions.List request = dialogflow.sessions().list(parameters ...)
 

Returns:
the resource collection








testCases
public Dialogflow.Projects.Locations.Agents.TestCases testCases()
An accessor for creating requests from the TestCases collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.TestCases.List request = dialogflow.testCases().list(parameters ...)
 

Returns:
the resource collection








transitionRouteGroups
public Dialogflow.Projects.Locations.Agents.TransitionRouteGroups transitionRouteGroups()
An accessor for creating requests from the TransitionRouteGroups collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.TransitionRouteGroups.List request = dialogflow.transitionRouteGroups().list(parameters ...)
 

Returns:
the resource collection








webhooks
public Dialogflow.Projects.Locations.Agents.Webhooks webhooks()
An accessor for creating requests from the Webhooks collection.

 
The typical use is:
 
    Dialogflow dialogflow = new Dialogflow(...);
    Dialogflow.Webhooks.List request = dialogflow.webhooks().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.