# Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::ConversationModels::Client (v1.16.1)

1.16.1 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.1 1.11.0 1.10.1 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.1 1.0.0 0.34.0 0.33.0 0.32.2 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.1 0.16.0 0.15.2 0.14.0 0.13.0 0.12.0 Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::ConversationModels::Client.

Client for the ConversationModels service.


<br />

Manages a collection of models for human agent assistant.

## Inherits

- Object

## Includes

- [Google::Cloud::Dialogflow::V2::ConversationModels::Paths](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Paths)

## Methods

### .configure

    def self.configure() { |config| ... } -> Client::Configuration

Configure the ConversationModels Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client-Configuration "Google::Cloud::Dialogflow::V2::ConversationModels::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client-Configuration))
**Example**

```ruby
# Modify the configuration for all ConversationModels clients
::Google::Cloud::Dialogflow::V2::ConversationModels::Client.configure do |config|
  config.timeout = 10.0
end
```

### #configure

    def configure() { |config| ... } -> Client::Configuration

Configure the ConversationModels Client instance.


The configuration is set to the derived mode, meaning that values can be changed,
but structural changes (adding new fields, etc.) are not allowed. Structural changes
should be made on [Client.configure](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client#Google__Cloud__Dialogflow__V2__ConversationModels__Client_configure_class_ "Google::Cloud::Dialogflow::V2::ConversationModels::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client-Configuration "Google::Cloud::Dialogflow::V2::ConversationModels::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client-Configuration))

### #create_conversation_model

    def create_conversation_model(request, options = nil) -> ::Gapic::Operation
    def create_conversation_model(parent: nil, conversation_model: nil) -> ::Gapic::Operation

Creates a model.

This method is a [long-running
operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
The returned `Operation` type has the following method-specific fields:

- `metadata`: [CreateConversationModelOperationMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-CreateConversationModelOperationMetadata "Google::Cloud::Dialogflow::V2::CreateConversationModelOperationMetadata (class)")
- `response`: [ConversationModel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModel "Google::Cloud::Dialogflow::V2::ConversationModel (class)")
**Overloads**

    def create_conversation_model(request, options = nil) -> ::Gapic::Operation

Pass arguments to `create_conversation_model` via a request object, either of type [Google::Cloud::Dialogflow::V2::CreateConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-CreateConversationModelRequest "Google::Cloud::Dialogflow::V2::CreateConversationModelRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::CreateConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-CreateConversationModelRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def create_conversation_model(parent: nil, conversation_model: nil) -> ::Gapic::Operation

Pass arguments to `create_conversation_model` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- The project to create conversation model for. Format: `projects/<Project ID>`
- **conversation_model** ([::Google::Cloud::Dialogflow::V2::ConversationModel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModel), ::Hash) --- Required. The conversation model to create.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::CreateConversationModelRequest.new

# Call the create_conversation_model method.
result = client.create_conversation_model request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #create_conversation_model_evaluation

    def create_conversation_model_evaluation(request, options = nil) -> ::Gapic::Operation
    def create_conversation_model_evaluation(parent: nil, conversation_model_evaluation: nil) -> ::Gapic::Operation

Creates evaluation of a conversation model.
**Overloads**

    def create_conversation_model_evaluation(request, options = nil) -> ::Gapic::Operation

Pass arguments to `create_conversation_model_evaluation` via a request object, either of type [Google::Cloud::Dialogflow::V2::CreateConversationModelEvaluationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-CreateConversationModelEvaluationRequest "Google::Cloud::Dialogflow::V2::CreateConversationModelEvaluationRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::CreateConversationModelEvaluationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-CreateConversationModelEvaluationRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def create_conversation_model_evaluation(parent: nil, conversation_model_evaluation: nil) -> ::Gapic::Operation

Pass arguments to `create_conversation_model_evaluation` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. The conversation model resource name. Format: `projects/<Project ID>/locations/<Location
  ID>/conversationModels/<Conversation Model ID>`
- **conversation_model_evaluation** ([::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModelEvaluation), ::Hash) --- Required. The conversation model evaluation to be created.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::CreateConversationModelEvaluationRequest.new

# Call the create_conversation_model_evaluation method.
result = client.create_conversation_model_evaluation request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #delete_conversation_model

    def delete_conversation_model(request, options = nil) -> ::Gapic::Operation
    def delete_conversation_model(name: nil) -> ::Gapic::Operation

Deletes a model.

This method is a [long-running
operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
The returned `Operation` type has the following method-specific fields:

- `metadata`: [DeleteConversationModelOperationMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-DeleteConversationModelOperationMetadata "Google::Cloud::Dialogflow::V2::DeleteConversationModelOperationMetadata (class)")
- `response`: An [Empty
  message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
**Overloads**

    def delete_conversation_model(request, options = nil) -> ::Gapic::Operation

Pass arguments to `delete_conversation_model` via a request object, either of type [DeleteConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-DeleteConversationModelRequest "Google::Cloud::Dialogflow::V2::DeleteConversationModelRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::DeleteConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-DeleteConversationModelRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def delete_conversation_model(name: nil) -> ::Gapic::Operation

Pass arguments to `delete_conversation_model` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. The conversation model to delete. Format: `projects/<Project ID>/conversationModels/<Conversation Model ID>`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::DeleteConversationModelRequest.new

# Call the delete_conversation_model method.
result = client.delete_conversation_model request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #deploy_conversation_model

    def deploy_conversation_model(request, options = nil) -> ::Gapic::Operation
    def deploy_conversation_model(name: nil) -> ::Gapic::Operation

Deploys a model. If a model is already deployed, deploying it
has no effect. A model can only serve prediction requests after it gets
deployed. For article suggestion, custom model will not be used unless
it is deployed.

This method is a [long-running
operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
The returned `Operation` type has the following method-specific fields:

- `metadata`: [DeployConversationModelOperationMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-DeployConversationModelOperationMetadata "Google::Cloud::Dialogflow::V2::DeployConversationModelOperationMetadata (class)")
- `response`: An [Empty
  message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
**Overloads**

    def deploy_conversation_model(request, options = nil) -> ::Gapic::Operation

Pass arguments to `deploy_conversation_model` via a request object, either of type [DeployConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-DeployConversationModelRequest "Google::Cloud::Dialogflow::V2::DeployConversationModelRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::DeployConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-DeployConversationModelRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def deploy_conversation_model(name: nil) -> ::Gapic::Operation

Pass arguments to `deploy_conversation_model` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. The conversation model to deploy. Format: `projects/<Project ID>/conversationModels/<Conversation Model ID>`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::DeployConversationModelRequest.new

# Call the deploy_conversation_model method.
result = client.deploy_conversation_model request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #get_conversation_model

    def get_conversation_model(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::ConversationModel
    def get_conversation_model(name: nil) -> ::Google::Cloud::Dialogflow::V2::ConversationModel

Gets conversation model.
**Overloads**

    def get_conversation_model(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::ConversationModel

Pass arguments to `get_conversation_model` via a request object, either of type [GetConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-GetConversationModelRequest "Google::Cloud::Dialogflow::V2::GetConversationModelRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::GetConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-GetConversationModelRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_conversation_model(name: nil) -> ::Google::Cloud::Dialogflow::V2::ConversationModel

Pass arguments to `get_conversation_model` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. The conversation model to retrieve. Format: `projects/<Project ID>/conversationModels/<Conversation Model ID>`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Dialogflow::V2::ConversationModel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModel))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Dialogflow::V2::ConversationModel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModel))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::GetConversationModelRequest.new

# Call the get_conversation_model method.
result = client.get_conversation_model request

# The returned object is of type Google::Cloud::Dialogflow::V2::ConversationModel.
p result
```

### #get_conversation_model_evaluation

    def get_conversation_model_evaluation(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation
    def get_conversation_model_evaluation(name: nil) -> ::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation

Gets an evaluation of conversation model.
**Overloads**

    def get_conversation_model_evaluation(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation

Pass arguments to `get_conversation_model_evaluation` via a request object, either of type [GetConversationModelEvaluationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-GetConversationModelEvaluationRequest "Google::Cloud::Dialogflow::V2::GetConversationModelEvaluationRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::GetConversationModelEvaluationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-GetConversationModelEvaluationRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_conversation_model_evaluation(name: nil) -> ::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation

Pass arguments to `get_conversation_model_evaluation` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. The conversation model evaluation resource name. Format: `projects/<Project ID>/conversationModels/<Conversation Model
  ID>/evaluations/<Evaluation ID>`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModelEvaluation))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModelEvaluation))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::GetConversationModelEvaluationRequest.new

# Call the get_conversation_model_evaluation method.
result = client.get_conversation_model_evaluation request

# The returned object is of type Google::Cloud::Dialogflow::V2::ConversationModelEvaluation.
p result
```

### #initialize

    def initialize() { |config| ... } -> Client

Create a new ConversationModels client object.
**Yields**

- (config) --- Configure the ConversationModels client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Client)) --- a new instance of Client
**Example**

```ruby
# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::ConversationModels::Client.new do |config|
  config.timeout = 10.0
end
```

### #list_conversation_model_evaluations

    def list_conversation_model_evaluations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation>
    def list_conversation_model_evaluations(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation>

Lists evaluations of a conversation model.
**Overloads**

    def list_conversation_model_evaluations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation>

Pass arguments to `list_conversation_model_evaluations` via a request object, either of type [ListConversationModelEvaluationsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ListConversationModelEvaluationsRequest "Google::Cloud::Dialogflow::V2::ListConversationModelEvaluationsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::ListConversationModelEvaluationsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ListConversationModelEvaluationsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def list_conversation_model_evaluations(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation>

Pass arguments to `list_conversation_model_evaluations` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. The conversation model resource name. Format: `projects/<Project ID>/conversationModels/<Conversation Model ID>`
- **page_size** (::Integer) --- Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.
- **page_token** (::String) --- Optional. The next_page_token value returned from a previous list request.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::PagedEnumerable\<[::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModelEvaluation)\>)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::PagedEnumerable\<[::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModelEvaluation)\>)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::ListConversationModelEvaluationsRequest.new

# Call the list_conversation_model_evaluations method.
result = client.list_conversation_model_evaluations request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation.
  p item
end
```

### #list_conversation_models

    def list_conversation_models(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationModel>
    def list_conversation_models(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationModel>

Lists conversation models.
**Overloads**

    def list_conversation_models(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationModel>

Pass arguments to `list_conversation_models` via a request object, either of type [ListConversationModelsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ListConversationModelsRequest "Google::Cloud::Dialogflow::V2::ListConversationModelsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::ListConversationModelsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ListConversationModelsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def list_conversation_models(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationModel>

Pass arguments to `list_conversation_models` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. The project to list all conversation models for. Format: `projects/<Project ID>`
- **page_size** (::Integer) --- Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.
- **page_token** (::String) --- Optional. The next_page_token value returned from a previous list request.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::PagedEnumerable\<[::Google::Cloud::Dialogflow::V2::ConversationModel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModel)\>)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::PagedEnumerable\<[::Google::Cloud::Dialogflow::V2::ConversationModel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModel)\>)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::ListConversationModelsRequest.new

# Call the list_conversation_models method.
result = client.list_conversation_models request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dialogflow::V2::ConversationModel.
  p item
end
```

### #location_client

    def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.
**Returns**

- (Google::Cloud::Location::Locations::Client)

### #logger

    def logger() -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #operations_client

    def operations_client() -> ::Google::Cloud::Dialogflow::V2::ConversationModels::Operations

Get the associated client for long-running operations.
**Returns**

- ([::Google::Cloud::Dialogflow::V2::ConversationModels::Operations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-ConversationModels-Operations))

### #undeploy_conversation_model

    def undeploy_conversation_model(request, options = nil) -> ::Gapic::Operation
    def undeploy_conversation_model(name: nil) -> ::Gapic::Operation

Undeploys a model. If the model is not deployed this method has no effect.
If the model is currently being used:

- For article suggestion, article suggestion will fallback to the default model if model is undeployed.

This method is a [long-running
operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
The returned `Operation` type has the following method-specific fields:

- `metadata`: [UndeployConversationModelOperationMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-UndeployConversationModelOperationMetadata "Google::Cloud::Dialogflow::V2::UndeployConversationModelOperationMetadata (class)")
- `response`: An [Empty
  message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
**Overloads**

    def undeploy_conversation_model(request, options = nil) -> ::Gapic::Operation

Pass arguments to `undeploy_conversation_model` via a request object, either of type [UndeployConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-UndeployConversationModelRequest "Google::Cloud::Dialogflow::V2::UndeployConversationModelRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Dialogflow::V2::UndeployConversationModelRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-UndeployConversationModelRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def undeploy_conversation_model(name: nil) -> ::Gapic::Operation

Pass arguments to `undeploy_conversation_model` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. The conversation model to undeploy. Format: `projects/<Project ID>/conversationModels/<Conversation Model ID>`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::ConversationModels::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::UndeployConversationModelRequest.new

# Call the undeploy_conversation_model method.
result = client.undeploy_conversation_model request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)