Discovery Engine V1 API - Module Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Paths (v0.8.0)

Reference documentation and code samples for the Discovery Engine V1 API module Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Paths.

Path helper methods for the ConversationalSearchService API.

Extended By

Methods

#answer_path

def answer_path(project:, location:, data_store:, session:, answer:) -> ::String
def answer_path(project:, location:, collection:, data_store:, session:, answer:) -> ::String
def answer_path(project:, location:, collection:, engine:, session:, answer:) -> ::String

Create a fully-qualified Answer resource string.

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

projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}

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

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}

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

projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • engine (String)
  • session (String)
  • answer (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#chunk_path

def chunk_path(project:, location:, data_store:, branch:, document:, chunk:) -> ::String
def chunk_path(project:, location:, collection:, data_store:, branch:, document:, chunk:) -> ::String

Create a fully-qualified Chunk resource string.

Overloads 
def chunk_path(project:, location:, data_store:, branch:, document:, chunk:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}

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

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • data_store (String)
  • branch (String)
  • document (String)
  • chunk (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#conversation_path

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

Create a fully-qualified Conversation resource string.

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

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

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

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

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

projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}

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

#data_store_path

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

Create a fully-qualified DataStore resource string.

Overloads 
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) 
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)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#document_path

def document_path(project:, location:, data_store:, branch:, document:) -> ::String
def document_path(project:, location:, collection:, data_store:, branch:, document:) -> ::String

Create a fully-qualified Document resource string.

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

projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}

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

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}

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

#serving_config_path

def serving_config_path(project:, location:, data_store:, serving_config:) -> ::String
def serving_config_path(project:, location:, collection:, data_store:, serving_config:) -> ::String
def serving_config_path(project:, location:, collection:, engine:, serving_config:) -> ::String

Create a fully-qualified ServingConfig resource string.

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

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

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

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

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

projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • engine (String)
  • serving_config (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#session_path

def session_path(project:, location:, data_store:, session:) -> ::String
def session_path(project:, location:, collection:, data_store:, session:) -> ::String
def session_path(project:, location:, collection:, engine:, session:) -> ::String

Create a fully-qualified Session resource string.

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

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

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

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

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

projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • engine (String)
  • session (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)