View Source GoogleApi.Dialogflow.V3.Api.Projects (google_api_dialogflow v0.88.2)
API calls for all endpoints tagged Projects
.
Summary
Functions
Retrieves the specified Changelog.
Returns the list of Changelogs.
Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the training documentation.
Deletes the specified agent.
Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
Exports the selected entity types.
Retrieves the specified entity type.
Imports the specified entitytypes into the agent.
Returns the list of all entity types in the specified agent.
Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
Fetches a list of continuous test results for a given environment.
Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: Environment
Deletes the specified Environment.
Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: DeployFlowMetadata - response
: DeployFlowResponse
Retrieves the specified Deployment.
Returns the list of all deployments in the specified Environment.
Creates an Experiment in the specified Environment.
Deletes the specified Experiment.
Retrieves the specified Experiment.
Returns the list of all experiments in the specified Environment.
Updates the specified Experiment.
Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.
Retrieves the specified Environment.
Returns the list of all environments in the specified Agent.
Looks up the history of the specified Environment.
Updates the specified Environment. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: Environment
Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: RunContinuousTestMetadata - response
: RunContinuousTestResponse
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.
Creates a session entity type.
Deletes the specified session entity type.
Retrieves the specified session entity type.
Returns the list of all session entity types in the specified session.
Updates the specified session entity type.
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
Returns preliminary intent match results, doesn't change the session status.
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
Exports the specified agent to a binary file. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: ExportAgentResponse
Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Deletes a specified flow.
Exports the specified flow to a binary file. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
Retrieves the specified flow.
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
Imports the specified flow to the specified agent from a binary file. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the training documentation.
Returns the list of all flows in the specified agent.
Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
Retrieves the specified page.
Returns the list of all pages in the specified flow.
Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: An Empty message Note: You should always train a flow prior to sending it queries. See the training documentation.
Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
Retrieves the specified TransitionRouteGroup.
Returns the list of all transition route groups in the specified flow.
Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.
Compares the specified base version with target version.
Creates a Version in the specified Flow. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: CreateVersionOperationMetadata - response
: Version
Deletes the specified Version.
Retrieves the specified Version.
Returns the list of all versions in the specified Flow.
Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: An Empty message
Updates the specified Version.
Creates a generator in the specified agent.
Deletes the specified generators.
Retrieves the specified generator.
Returns the list of all generators in the specified agent.
Update the specified generator.
Retrieves the specified agent.
Gets the generative settings for the agent.
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Exports the selected intents. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: ExportIntentsMetadata - response
: ExportIntentsResponse
Retrieves the specified intent.
Imports the specified intents into the agent. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: ImportIntentsMetadata - response
: ImportIntentsResponse
Returns the list of all intents in the specified agent.
Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Returns the list of all agents in the specified location.
Updates the specified agent. Note: You should always train flows prior to sending them queries. See the training documentation.
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. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: An Empty message Note: You should always train flows prior to sending them queries. See the training documentation.
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.
Creates a session entity type.
Deletes the specified session entity type.
Retrieves the specified session entity type.
Returns the list of all session entity types in the specified session.
Updates the specified session entity type.
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
Returns preliminary intent match results, doesn't change the session status.
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
Updates the feedback received from the user for a single turn of the bot response.
Batch deletes test cases.
Kicks off a batch run of test cases. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: BatchRunTestCasesMetadata - response
: BatchRunTestCasesResponse
Calculates the test coverage for an agent.
Creates a test case for the given agent.
Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: ExportTestCasesMetadata - response
: ExportTestCasesResponse
Gets a test case.
Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: ImportTestCasesMetadata - response
: ImportTestCasesResponse
Fetches a list of test cases for a given agent.
Updates the specified test case.
Gets a test case result.
Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.
Kicks off a test case run. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: RunTestCaseMetadata - response
: RunTestCaseResponse
Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
Retrieves the specified TransitionRouteGroup.
Returns the list of all transition route groups in the specified flow.
Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
Updates the generative settings for the agent.
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.
Creates a webhook in the specified agent.
Deletes the specified webhook.
Retrieves the specified webhook.
Returns the list of all webhooks in the specified agent.
Updates the specified webhook.
Gets information about a location.
Lists information about the supported locations for this service.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Create security settings in the specified location.
Deletes the specified SecuritySettings.
Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
Returns the list of all security settings in the specified location.
Updates the specified SecuritySettings.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Functions
dialogflow_projects_locations_agents_changelogs_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_changelogs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Changelog.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified Changelog.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the changelog to get. Format:projects//locations//agents//changelogs/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Changelog{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_changelogs_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_changelogs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListChangelogsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of Changelogs.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent containing the changelogs. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The filter string. Supports filter by user_email, resource, type and create_time. Some examples: 1. By user email: user_email = "someone@google.com" 2. By resource name: resource = "projects/123/locations/global/agents/456/flows/789" 3. By resource display name: display_name = "my agent" 4. By action: action = "Create" 5. By type: type = "flows" 6. By create time. Currently predicates oncreate_time
andcreate_time_epoch_seconds
are supported: create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.01Z 7. Combination of above filters: resource = "projects/123/locations/global/agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <= 2017-01-15T01:30:15.01Z -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListChangelogsResponse{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The location to create a agent for. Format:projects//locations/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the agent to delete. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_entity_types_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3EntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to create a entity type for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inentity_type
:EntityType.entities.value
EntityType.entities.synonyms
*EntityType.excluded_phrases.value
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3EntityType.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3EntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_entity_types_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the entity type to delete. Format:projects//locations//agents//entityTypes/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:force
(type:boolean()
) - This field has no effect for entity type not being used. For entity types that are used by intents or pages: Ifforce
is set to false, an error will be returned with message indicating the referencing resources. Ifforce
is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_entity_types_export(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_entity_types_export( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Exports the selected entity types.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent agent to export entity types. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExportEntityTypesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_entity_types_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_entity_types_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3EntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the entity type. Format:projects//locations//agents//entityTypes/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to retrieve the entity type for. The following fields are language dependent:EntityType.entities.value
EntityType.entities.synonyms
*EntityType.excluded_phrases.value
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3EntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_entity_types_import(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_entity_types_import( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Imports the specified entitytypes into the agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to import the entity types into. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ImportEntityTypesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_entity_types_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListEntityTypesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all entity types in the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to list all entity types for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to list entity types for. The following fields are language dependent:EntityType.entities.value
EntityType.entities.synonyms
*EntityType.excluded_phrases.value
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListEntityTypesResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_entity_types_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3EntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format:projects//locations//agents//entityTypes/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inentity_type
:EntityType.entities.value
EntityType.entities.synonyms
*EntityType.excluded_phrases.value
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:updateMask
(type:String.t
) - The mask to control which fields get updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3EntityType.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3EntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_continuous_test_results_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_continuous_test_results_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fetches a list of continuous test results for a given environment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The environment to list results for. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: Environment
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Agent to create an Environment for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Environment.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified Environment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Environment to delete. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_deploy_flow(connection, environment, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_deploy_flow( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: DeployFlowMetadata - response
: DeployFlowResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
environment
(type:String.t
) - Required. The environment to deploy the flow to. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DeployFlowRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_deployments_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_deployments_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Deployment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified Deployment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Deployment. Format:projects//locations//agents//environments//deployments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Deployment{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_deployments_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_deployments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListDeploymentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all deployments in the specified Environment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Environment to list all environments for. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 20 and at most 100. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListDeploymentsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_experiments_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_experiments_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an Experiment in the specified Environment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Agent to create an Environment for. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_experiments_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_experiments_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified Experiment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Environment to delete. Format:projects//locations//agents//environments//experiments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_experiments_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_experiments_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified Experiment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Environment. Format:projects//locations//agents//environments//experiments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_experiments_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_experiments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListExperimentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all experiments in the specified Environment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Environment to list all environments for. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 20 and at most 100. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListExperimentsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_experiments_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_experiments_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified Experiment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the experiment. Format: projects//locations//agents//environments//experiments/. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The mask to control which fields get updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_experiments_start(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_experiments_start( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the experiment to start. Format:projects//locations//agents//environments//experiments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3StartExperimentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_experiments_stop(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_experiments_stop( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the experiment to stop. Format:projects//locations//agents//environments//experiments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3StopExperimentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Experiment{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Environment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified Environment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Environment. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Environment{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListEnvironmentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all environments in the specified Agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Agent to list all environments for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 20 and at most 100. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListEnvironmentsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_lookup_environment_history(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_lookup_environment_history( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Looks up the history of the specified Environment.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the environment to look up the history for. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified Environment. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: Environment
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the environment. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The mask to control which fields get updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Environment.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_run_continuous_test(connection, environment, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_run_continuous_test( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: RunContinuousTestMetadata - response
: RunContinuousTestResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
environment
(type:String.t
) - Required. Format:projects//locations//agents//environments/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3RunContinuousTestRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_detect_intent(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_detect_intent( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session this query is sent to. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriateSession ID
. It can be a random number or some type of session identifiers (preferably hashed). The length of theSession ID
must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_entity_types_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a session entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The session to create a session entity type for. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_entity_types_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified session entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the session entity type to delete. Format:projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_entity_types_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_entity_types_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified session entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the session entity type. Format:projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_entity_types_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all session entity types in the specified session.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The session to list all session entity types from. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_entity_types_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified session entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The unique identifier of the session entity type. Format:projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - The mask to control which fields get updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_fulfill_intent(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_fulfill_intent( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FulfillIntentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session this query is sent to. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriateSession ID
. It can be a random number or some type of session identifiers (preferably hashed). The length of theSession ID
must not exceed 36 characters. For more information, see the sessions guide. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FulfillIntentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FulfillIntentResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_match_intent(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_match_intent( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3MatchIntentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns preliminary intent match results, doesn't change the session status.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session this query is sent to. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriateSession ID
. It can be a random number or some type of session identifiers (preferably hashed). The length of theSession ID
must not exceed 36 characters. For more information, see the sessions guide. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3MatchIntentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3MatchIntentResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_environments_sessions_server_streaming_detect_intent(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_environments_sessions_server_streaming_detect_intent( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session this query is sent to. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriateSession ID
. It can be a random number or some type of session identifiers (preferably hashed). The length of theSession ID
must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentResponse{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_export( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Exports the specified agent to a binary file. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: ExportAgentResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the agent to export. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExportAgentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Flow.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to create a flow for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inflow
:Flow.event_handlers.trigger_fulfillment.messages
Flow.event_handlers.trigger_fulfillment.conditional_cases
Flow.transition_routes.trigger_fulfillment.messages
Flow.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Flow.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Flow{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a specified flow.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the flow to delete. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:force
(type:boolean()
) - This field has no effect for flows with no incoming transitions. For flows with incoming transitions: Ifforce
is set to false, an error will be returned with message indicating the incoming transitions. Ifforce
is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_export(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_export( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Exports the specified flow to a binary file. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the flow to export. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExportFlowRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_flows_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Flow.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified flow.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the flow to get. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to retrieve the flow for. The following fields are language dependent:Flow.event_handlers.trigger_fulfillment.messages
Flow.event_handlers.trigger_fulfillment.conditional_cases
Flow.transition_routes.trigger_fulfillment.messages
Flow.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Flow{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_get_validation_result(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_get_validation_result( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FlowValidationResult.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The flow name. Format:projects//locations//agents//flows//validationResult
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - If not specified, the agent's default language is used.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FlowValidationResult{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_import(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_import( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Imports the specified flow to the specified agent from a binary file. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to import the flow into. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ImportFlowRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListFlowsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all flows in the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent containing the flows. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to list flows for. The following fields are language dependent:Flow.event_handlers.trigger_fulfillment.messages
Flow.event_handlers.trigger_fulfillment.conditional_cases
Flow.transition_routes.trigger_fulfillment.messages
Flow.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListFlowsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_pages_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_pages_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The flow to create a page for. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inpage
:Page.entry_fulfillment.messages
Page.entry_fulfillment.conditional_cases
Page.event_handlers.trigger_fulfillment.messages
Page.event_handlers.trigger_fulfillment.conditional_cases
Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages
Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
Page.form.parameters.fill_behavior.reprompt_event_handlers.messages
Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
Page.transition_routes.trigger_fulfillment.messages
Page.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Page.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Page{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_pages_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_pages_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the page to delete. Format:projects//locations//agents//Flows//pages/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:force
(type:boolean()
) - This field has no effect for pages with no incoming transitions. For pages with incoming transitions: Ifforce
is set to false, an error will be returned with message indicating the incoming transitions. Ifforce
is set to true, Dialogflow will remove the page, as well as any transitions to the page (i.e. Target page in event handlers or Target page in transition routes that point to this page will be cleared).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_pages_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_pages_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified page.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the page. Format:projects//locations//agents//flows//pages/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to retrieve the page for. The following fields are language dependent:Page.entry_fulfillment.messages
Page.entry_fulfillment.conditional_cases
Page.event_handlers.trigger_fulfillment.messages
Page.event_handlers.trigger_fulfillment.conditional_cases
Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages
Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
Page.form.parameters.fill_behavior.reprompt_event_handlers.messages
Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
Page.transition_routes.trigger_fulfillment.messages
Page.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Page{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_pages_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_pages_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListPagesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all pages in the specified flow.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The flow to list all pages for. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to list pages for. The following fields are language dependent:Page.entry_fulfillment.messages
Page.entry_fulfillment.conditional_cases
Page.event_handlers.trigger_fulfillment.messages
Page.event_handlers.trigger_fulfillment.conditional_cases
Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages
Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
Page.form.parameters.fill_behavior.reprompt_event_handlers.messages
Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
Page.transition_routes.trigger_fulfillment.messages
Page.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListPagesResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_pages_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_pages_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:projects//locations//agents//flows//pages/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inpage
:Page.entry_fulfillment.messages
Page.entry_fulfillment.conditional_cases
Page.event_handlers.trigger_fulfillment.messages
Page.event_handlers.trigger_fulfillment.conditional_cases
Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages
Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
Page.form.parameters.fill_behavior.reprompt_event_handlers.messages
Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
Page.transition_routes.trigger_fulfillment.messages
Page.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:updateMask
(type:String.t
) - The mask to control which fields get updated. If the mask is not present, all fields will be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Page.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Page{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Flow.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the flow. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inflow
:Flow.event_handlers.trigger_fulfillment.messages
Flow.event_handlers.trigger_fulfillment.conditional_cases
Flow.transition_routes.trigger_fulfillment.messages
Flow.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:updateMask
(type:String.t
) - The mask to control which fields get updated. If the mask is not present, all fields will be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Flow.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Flow{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_train(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_train( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: An Empty message Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The flow to train. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TrainFlowRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_transition_route_groups_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_transition_route_groups_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The flow to create an TransitionRouteGroup for. Format:projects//locations//agents//flows/
orprojects//locations//agents/
for agent-level groups. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inTransitionRouteGroup
:TransitionRouteGroup.transition_routes.trigger_fulfillment.messages
TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_transition_route_groups_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_transition_route_groups_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the TransitionRouteGroup to delete. Format:projects//locations//agents//flows//transitionRouteGroups/
orprojects//locations//agents//transitionRouteGroups/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:force
(type:boolean()
) - This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: Ifforce
is set to false, an error will be returned with message indicating pages that reference the transition route group. Ifforce
is set to true, Dialogflow will remove the transition route group, as well as any reference to it.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_transition_route_groups_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_transition_route_groups_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified TransitionRouteGroup.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the TransitionRouteGroup. Format:projects//locations//agents//flows//transitionRouteGroups/
orprojects//locations//agents//transitionRouteGroups/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to retrieve the transition route group for. The following fields are language dependent:TransitionRouteGroup.transition_routes.trigger_fulfillment.messages
TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_transition_route_groups_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_transition_route_groups_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all transition route groups in the specified flow.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The flow to list all transition route groups for. Format:projects//locations//agents//flows/
orprojects//locations//agents/. *
optional_params(*type:*
keyword()) - Optional parameters *
:"$.xgafv"(*type:*
String.t) - V1 error format. *
:access_token(*type:*
String.t) - OAuth access token. *
:alt(*type:*
String.t) - Data format for response. *
:callback(*type:*
String.t) - JSONP *
:fields(*type:*
String.t) - Selector specifying which fields to include in a partial response. *
:key(*type:*
String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. *
:oauth_token(*type:*
String.t) - OAuth 2.0 token for the current user. *
:prettyPrint(*type:*
boolean()) - Returns response with indentations and line breaks. *
:quotaUser(*type:*
String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. *
:uploadType(*type:*
String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). *
:upload_protocol(*type:*
String.t) - Upload protocol for media (e.g. "raw", "multipart"). *
:languageCode(*type:*
String.t) - The language to list transition route groups for. The following fields are language dependent: *
TransitionRouteGroup.transition_routes.trigger_fulfillment.messages*
TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_casesIf not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. *
:pageSize(*type:*
integer()) - The maximum number of items to return in a single page. By default 100 and at most 1000. *
:pageToken(*type:*
String.t) - The next_page_token value returned from a previous list request. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
dialogflow_projects_locations_agents_flows_transition_route_groups_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_transition_route_groups_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format:projects//locations//agents//flows//transitionRouteGroups/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inTransitionRouteGroup
:TransitionRouteGroup.transition_routes.trigger_fulfillment.messages
TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:updateMask
(type:String.t
) - The mask to control which fields get updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_validate(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_validate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FlowValidationResult.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The flow to validate. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ValidateFlowRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FlowValidationResult{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_versions_compare_versions(connection, base_version, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_versions_compare_versions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3CompareVersionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Compares the specified base version with target version.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
base_version
(type:String.t
) - Required. Name of the base flow version to compare with the target version. Use version ID0
to indicate the draft version of the specified flow. Format:projects//locations//agents//flows//versions/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3CompareVersionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3CompareVersionsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_versions_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_versions_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a Version in the specified Flow. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: CreateVersionOperationMetadata - response
: Version
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Flow to create an Version for. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Version.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_versions_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_versions_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified Version.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Version to delete. Format:projects//locations//agents//flows//versions/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_versions_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_versions_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Version.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified Version.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the Version. Format:projects//locations//agents//flows//versions/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Version{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_versions_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_versions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListVersionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all versions in the specified Flow.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Flow to list all versions for. Format:projects//locations//agents//flows/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 20 and at most 100. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListVersionsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_versions_load(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_versions_load( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: An Empty message
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The Version to be loaded to draft flow. Format:projects//locations//agents//flows//versions/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3LoadVersionRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_flows_versions_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_flows_versions_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Version.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified Version.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The mask to control which fields get updated. Currently onlydescription
anddisplay_name
can be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Version.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Version{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_generators_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_generators_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Generator.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a generator in the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to create a generator for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to create generators for the following fields: *Generator.prompt_text.text
If not specified, the agent's default language is used. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Generator.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Generator{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_generators_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_generators_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified generators.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the generator to delete. Format:projects//locations//agents//generators/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:force
(type:boolean()
) - This field has no effect for generators not being used. For generators that are used by pages/flows/transition route groups: Ifforce
is set to false, an error will be returned with message indicating the referenced resources. Ifforce
is set to true, Dialogflow will remove the generator, as well as any references to the generator (i.e. Generator) in fulfillments.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_generators_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_generators_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Generator.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified generator.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the generator. Format:projects//locations//agents//generators/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to list generators for.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Generator{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_generators_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_generators_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListGeneratorsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all generators in the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to list all generators for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to list generators for. -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListGeneratorsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_generators_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_generators_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Generator.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update the specified generator.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format:projects//locations//agents//generators/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to list generators for. -
:updateMask
(type:String.t
) - The mask to control which fields get updated. If the mask is not present, all fields will be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Generator.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Generator{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the agent. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_get_generative_settings(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_get_generative_settings( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3GenerativeSettings.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the generative settings for the agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects//locations//agents//generativeSettings
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - Required. Language code of the generative settings.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3GenerativeSettings{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_get_validation_result(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_get_validation_result( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentValidationResult.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The agent name. Format:projects//locations//agents//validationResult
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - If not specified, the agent's default language is used.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentValidationResult{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_intents_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_intents_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Intent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to create an intent for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inintent
: *Intent.training_phrases.parts.text
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Intent.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Intent{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_intents_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_intents_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the intent to delete. Format:projects//locations//agents//intents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_intents_export(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_intents_export( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Exports the selected intents. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: ExportIntentsMetadata - response
: ExportIntentsResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent agent to export intents. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExportIntentsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_intents_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_intents_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Intent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified intent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the intent. Format:projects//locations//agents//intents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to retrieve the intent for. The following fields are language dependent: *Intent.training_phrases.parts.text
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Intent{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_intents_import(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_intents_import( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Imports the specified intents into the agent. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: ImportIntentsMetadata - response
: ImportIntentsResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to import the intents into. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ImportIntentsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_intents_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_intents_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListIntentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all intents in the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to list all intents for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:intentView
(type:String.t
) - The resource view to apply to the returned intent. -
:languageCode
(type:String.t
) - The language to list intents for. The following fields are language dependent: *Intent.training_phrases.parts.text
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListIntentsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_intents_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_intents_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Intent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:projects//locations//agents//intents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inintent
: *Intent.training_phrases.parts.text
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:updateMask
(type:String.t
) - The mask to control which fields get updated. If the mask is not present, all fields will be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Intent.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Intent{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListAgentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all agents in the specified location.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The location to list all agents for. Format:projects//locations/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListAgentsResponse{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified agent. Note: You should always train flows prior to sending them queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - The mask to control which fields get updated. If the mask is not present, all fields will be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_restore( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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. The returned Operation
type has the following method-specific fields: - metadata
: An empty Struct message - response
: An Empty message Note: You should always train flows prior to sending them queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the agent to restore into. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3RestoreAgentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_detect_intent(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_detect_intent( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session this query is sent to. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriateSession ID
. It can be a random number or some type of session identifiers (preferably hashed). The length of theSession ID
must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_entity_types_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_entity_types_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a session entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The session to create a session entity type for. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_entity_types_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_entity_types_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified session entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the session entity type to delete. Format:projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_entity_types_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_entity_types_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified session entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the session entity type. Format:projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_entity_types_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all session entity types in the specified session.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The session to list all session entity types from. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_entity_types_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_entity_types_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified session entity type.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The unique identifier of the session entity type. Format:projects//locations//agents//sessions//entityTypes/
orprojects//locations//agents//environments//sessions//entityTypes/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - The mask to control which fields get updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SessionEntityType{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_fulfill_intent(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_fulfill_intent( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FulfillIntentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session this query is sent to. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriateSession ID
. It can be a random number or some type of session identifiers (preferably hashed). The length of theSession ID
must not exceed 36 characters. For more information, see the sessions guide. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FulfillIntentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3FulfillIntentResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_match_intent(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_match_intent( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3MatchIntentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns preliminary intent match results, doesn't change the session status.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session this query is sent to. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriateSession ID
. It can be a random number or some type of session identifiers (preferably hashed). The length of theSession ID
must not exceed 36 characters. For more information, see the sessions guide. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3MatchIntentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3MatchIntentResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_server_streaming_detect_intent(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_server_streaming_detect_intent( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session this query is sent to. Format:projects//locations//agents//sessions/
orprojects//locations//agents//environments//sessions/
. IfEnvironment ID
is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriateSession ID
. It can be a random number or some type of session identifiers (preferably hashed). The length of theSession ID
must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3DetectIntentResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_sessions_submit_answer_feedback(connection, session, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_sessions_submit_answer_feedback( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AnswerFeedback.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the feedback received from the user for a single turn of the bot response.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
session
(type:String.t
) - Required. The name of the session the feedback was sent to. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AnswerFeedback{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_batch_delete(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_batch_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Batch deletes test cases.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to delete test cases from. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_batch_run(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_batch_run( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Kicks off a batch run of test cases. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: BatchRunTestCasesMetadata - response
: BatchRunTestCasesResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Agent name. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3BatchRunTestCasesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_calculate_coverage(connection, agent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_calculate_coverage( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3CalculateCoverageResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Calculates the test coverage for an agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
agent
(type:String.t
) - Required. The agent to calculate coverage for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:type
(type:String.t
) - Required. The type of coverage requested.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3CalculateCoverageResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCase.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a test case for the given agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to create the test case for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCase.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCase{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_export(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_export( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: ExportTestCasesMetadata - response
: ExportTestCasesResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent where to export test cases from. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ExportTestCasesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCase.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a test case.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the testcase. Format:projects//locations//agents//testCases/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCase{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_import(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_import( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: ImportTestCasesMetadata - response
: ImportTestCasesResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to import test cases to. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ImportTestCasesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListTestCasesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fetches a list of test cases for a given agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to list all pages for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request. -
:view
(type:String.t
) - Specifies whether response should include all fields or just the metadata.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListTestCasesResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCase.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified test case.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format:projects//locations//agents//testCases/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The mask to specify which fields should be updated. ThecreationTime
andlastTestResult
cannot be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCase.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCase{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_results_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_results_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCaseResult.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a test case result.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the testcase. Format:projects//locations//agents//testCases//results/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TestCaseResult{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_results_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_results_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListTestCaseResultsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The test case to list results for. Format:projects//locations//agents//testCases/
. Specify a-
as a wildcard for TestCase ID to list results across multiple test cases. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The filter expression used to filter test case results. See API Filtering. The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operatorenvironment
=
,IN
(Use valuedraft
for draft environment)test_time
>
,<
latest
only returns the latest test result in all results for each test case. Examples: "environment=draft AND latest" matches the latest test result for each test case in the draft environment. "environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2". * "test_time > 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713. -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListTestCaseResultsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_test_cases_run(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_test_cases_run( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Kicks off a test case run. This method is a long-running operation. The returned Operation
type has the following method-specific fields: - metadata
: RunTestCaseMetadata - response
: RunTestCaseResponse
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format of test case name to run:projects//locations//agents//testCases/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3RunTestCaseRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_transition_route_groups_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_transition_route_groups_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The flow to create an TransitionRouteGroup for. Format:projects//locations//agents//flows/
orprojects//locations//agents/
for agent-level groups. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inTransitionRouteGroup
:TransitionRouteGroup.transition_routes.trigger_fulfillment.messages
TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_transition_route_groups_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_transition_route_groups_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the TransitionRouteGroup to delete. Format:projects//locations//agents//flows//transitionRouteGroups/
orprojects//locations//agents//transitionRouteGroups/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:force
(type:boolean()
) - This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: Ifforce
is set to false, an error will be returned with message indicating pages that reference the transition route group. Ifforce
is set to true, Dialogflow will remove the transition route group, as well as any reference to it.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_transition_route_groups_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_transition_route_groups_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified TransitionRouteGroup.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the TransitionRouteGroup. Format:projects//locations//agents//flows//transitionRouteGroups/
orprojects//locations//agents//transitionRouteGroups/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language to retrieve the transition route group for. The following fields are language dependent:TransitionRouteGroup.transition_routes.trigger_fulfillment.messages
TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_transition_route_groups_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_transition_route_groups_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all transition route groups in the specified flow.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The flow to list all transition route groups for. Format:projects//locations//agents//flows/
orprojects//locations//agents/. *
optional_params(*type:*
keyword()) - Optional parameters *
:"$.xgafv"(*type:*
String.t) - V1 error format. *
:access_token(*type:*
String.t) - OAuth access token. *
:alt(*type:*
String.t) - Data format for response. *
:callback(*type:*
String.t) - JSONP *
:fields(*type:*
String.t) - Selector specifying which fields to include in a partial response. *
:key(*type:*
String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. *
:oauth_token(*type:*
String.t) - OAuth 2.0 token for the current user. *
:prettyPrint(*type:*
boolean()) - Returns response with indentations and line breaks. *
:quotaUser(*type:*
String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. *
:uploadType(*type:*
String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). *
:upload_protocol(*type:*
String.t) - Upload protocol for media (e.g. "raw", "multipart"). *
:languageCode(*type:*
String.t) - The language to list transition route groups for. The following fields are language dependent: *
TransitionRouteGroup.transition_routes.trigger_fulfillment.messages*
TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_casesIf not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. *
:pageSize(*type:*
integer()) - The maximum number of items to return in a single page. By default 100 and at most 1000. *
:pageToken(*type:*
String.t) - The next_page_token value returned from a previous list request. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
dialogflow_projects_locations_agents_transition_route_groups_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_transition_route_groups_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format:projects//locations//agents//flows//transitionRouteGroups/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:languageCode
(type:String.t
) - The language of the following fields inTransitionRouteGroup
:TransitionRouteGroup.transition_routes.trigger_fulfillment.messages
TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. -
:updateMask
(type:String.t
) - The mask to control which fields get updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TransitionRouteGroup{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_update_generative_settings(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_update_generative_settings( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3GenerativeSettings.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the generative settings for the agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Format:projects//locations//agents//generativeSettings
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3GenerativeSettings.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3GenerativeSettings{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_agents_validate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentValidationResult.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The agent to validate. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ValidateAgentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentValidationResult{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_webhooks_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_webhooks_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Webhook.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a webhook in the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to create a webhook for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Webhook.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Webhook{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_webhooks_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_webhooks_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified webhook.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the webhook to delete. Format:projects//locations//agents//webhooks/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:force
(type:boolean()
) - This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: Ifforce
is set to false, an error will be returned with message indicating the referenced resources. Ifforce
is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_webhooks_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_webhooks_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Webhook.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified webhook.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the webhook. Format:projects//locations//agents//webhooks/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Webhook{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_webhooks_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_webhooks_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListWebhooksResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all webhooks in the specified agent.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The agent to list all webhooks for. Format:projects//locations//agents/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 100 and at most 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListWebhooksResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_agents_webhooks_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_agents_webhooks_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Webhook.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified webhook.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format:projects//locations//agents//webhooks/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - The mask to control which fields get updated. If the mask is not present, all fields will be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Webhook.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Webhook{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudLocationLocation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Resource name for the location. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudLocationLocation{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudLocationListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource that owns the locations collection, if applicable. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like"displayName=tokyo"
, and is documented in more detail in AIP-160. -
:pageSize
(type:integer()
) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken
(type:String.t
) - A page token received from thenext_page_token
field in the response. Send that page token to receive the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudLocationListLocationsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_operations_cancel(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource to be cancelled. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_locations_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningListOperationsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_security_settings_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_security_settings_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SecuritySettings.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create security settings in the specified location.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The location to create an SecuritySettings for. Format:projects//locations/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SecuritySettings.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SecuritySettings{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_security_settings_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_security_settings_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified SecuritySettings.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the SecuritySettings to delete. Format:projects//locations//securitySettings/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_security_settings_get(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_security_settings_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SecuritySettings.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the settings. Format:projects//locations//securitySettings/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SecuritySettings{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_security_settings_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_security_settings_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListSecuritySettingsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the list of all security settings in the specified location.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The location to list all security settings for. Format:projects//locations/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return in a single page. By default 20 and at most 100. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3ListSecuritySettingsResponse{}}
on success -
{:error, info}
on failure
dialogflow_projects_locations_security_settings_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dialogflow_projects_locations_security_settings_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SecuritySettings.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified SecuritySettings.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format:projects//locations//securitySettings/
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. -
:body
(type:GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SecuritySettings.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SecuritySettings{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource to be cancelled. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
@spec dialogflow_projects_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dialogflow.V3.Model.GoogleLongrunningListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.Dialogflow.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Dialogflow.V3.Model.GoogleLongrunningListOperationsResponse{}}
on success -
{:error, info}
on failure