Dialogflow V2 API - Module Google::Cloud::Dialogflow::V2::Conversations::Paths (v1.4.0)

Reference documentation and code samples for the Dialogflow V2 API module Google::Cloud::Dialogflow::V2::Conversations::Paths.

Path helper methods for the Conversations API.

Extended By

Methods

#agent_path

def agent_path(project:) -> ::String
def agent_path(project:, location:) -> ::String

Create a fully-qualified Agent resource string.

Overloads 
def agent_path(project:) -> ::String
The resource will be in the following format:

projects/{project}/agent

Parameter
  • project (String) 
def agent_path(project:, location:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/agent

Parameters
  • project (String)
  • location (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#conversation_model_path

def conversation_model_path(project:, location:, conversation_model:) -> ::String
def conversation_model_path(project:, conversation_model:) -> ::String

Create a fully-qualified ConversationModel resource string.

Overloads 
def conversation_model_path(project:, location:, conversation_model:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/conversationModels/{conversation_model}

Parameters
  • project (String)
  • location (String)
  • conversation_model (String) 
def conversation_model_path(project:, conversation_model:) -> ::String
The resource will be in the following format:

projects/{project}/conversationModels/{conversation_model}

Parameters
  • project (String)
  • conversation_model (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#conversation_path

def conversation_path(project:, conversation:) -> ::String
def conversation_path(project:, location:, conversation:) -> ::String

Create a fully-qualified Conversation resource string.

Overloads 
def conversation_path(project:, conversation:) -> ::String
The resource will be in the following format:

projects/{project}/conversations/{conversation}

Parameters
  • project (String)
  • conversation (String) 
def conversation_path(project:, location:, conversation:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/conversations/{conversation}

Parameters
  • project (String)
  • location (String)
  • conversation (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#conversation_profile_path

def conversation_profile_path(project:, conversation_profile:) -> ::String
def conversation_profile_path(project:, location:, conversation_profile:) -> ::String

Create a fully-qualified ConversationProfile resource string.

Overloads 
def conversation_profile_path(project:, conversation_profile:) -> ::String
The resource will be in the following format:

projects/{project}/conversationProfiles/{conversation_profile}

Parameters
  • project (String)
  • conversation_profile (String) 
def conversation_profile_path(project:, location:, conversation_profile:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}

Parameters
  • project (String)
  • location (String)
  • conversation_profile (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#cx_security_settings_path

def cx_security_settings_path(project:, location:, security_settings:) -> ::String

Create a fully-qualified CXSecuritySettings resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/securitySettings/{security_settings}

Parameters
  • project (String)
  • location (String)
  • security_settings (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#data_store_path

def data_store_path(project:, location:, collection:, data_store:) -> ::String
def data_store_path(project:, location:, data_store:) -> ::String

Create a fully-qualified DataStore resource string.

Overloads 
def data_store_path(project:, location:, collection:, data_store:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • data_store (String) 
def data_store_path(project:, location:, data_store:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/dataStores/{data_store}

Parameters
  • project (String)
  • location (String)
  • data_store (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#document_path

def document_path(project:, knowledge_base:, document:) -> ::String
def document_path(project:, location:, knowledge_base:, document:) -> ::String

Create a fully-qualified Document resource string.

Overloads 
def document_path(project:, knowledge_base:, document:) -> ::String
The resource will be in the following format:

projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}

Parameters
  • project (String)
  • knowledge_base (String)
  • document (String) 
def document_path(project:, location:, knowledge_base:, document:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}

Parameters
  • project (String)
  • location (String)
  • knowledge_base (String)
  • document (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#generator_path

def generator_path(project:, location:, generator:) -> ::String

Create a fully-qualified Generator resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/generators/{generator}

Parameters
  • project (String)
  • location (String)
  • generator (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#knowledge_base_path

def knowledge_base_path(project:, knowledge_base:) -> ::String
def knowledge_base_path(project:, location:, knowledge_base:) -> ::String

Create a fully-qualified KnowledgeBase resource string.

Overloads 
def knowledge_base_path(project:, knowledge_base:) -> ::String
The resource will be in the following format:

projects/{project}/knowledgeBases/{knowledge_base}

Parameters
  • project (String)
  • knowledge_base (String) 
def knowledge_base_path(project:, location:, knowledge_base:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}

Parameters
  • project (String)
  • location (String)
  • knowledge_base (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#location_path

def location_path(project:, location:) -> ::String

Create a fully-qualified Location resource string.

The resource will be in the following format:

projects/{project}/locations/{location}

Parameters
  • project (String)
  • location (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#message_path

def message_path(project:, conversation:, message:) -> ::String
def message_path(project:, location:, conversation:, message:) -> ::String

Create a fully-qualified Message resource string.

Overloads 
def message_path(project:, conversation:, message:) -> ::String
The resource will be in the following format:

projects/{project}/conversations/{conversation}/messages/{message}

Parameters
  • project (String)
  • conversation (String)
  • message (String) 
def message_path(project:, location:, conversation:, message:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}

Parameters
  • project (String)
  • location (String)
  • conversation (String)
  • message (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#phrase_set_path

def phrase_set_path(project:, location:, phrase_set:) -> ::String

Create a fully-qualified PhraseSet resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/phraseSets/{phrase_set}

Parameters
  • project (String)
  • location (String)
  • phrase_set (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#project_path

def project_path(project:) -> ::String

Create a fully-qualified Project resource string.

The resource will be in the following format:

projects/{project}

Parameter
  • project (String)
Returns
  • (::String)