Class ConversationalSearchServiceClient (0.13.4)

Service for conversational search.

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the conversational search service client.

Releases underlying transport's resources.

Returns a fully-qualified answer string.

Answer query method.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_answer_query():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    query = discoveryengine_v1alpha.Query()
    query.text = "text_value"

    request = discoveryengine_v1alpha.AnswerQueryRequest(
        serving_config="serving_config_value",
        query=query,
    )

    # Make the request
    response = client.answer_query(request=request)

    # Handle the response
    print(response)

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.

Returns a fully-qualified chunk string.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Returns a fully-qualified conversation string.

Converses a conversation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_converse_conversation():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.ConverseConversationRequest(
        name="name_value",
    )

    # Make the request
    response = client.converse_conversation(request=request)

    # Handle the response
    print(response)

Creates a Conversation.

If the xref_Conversation to create already exists, an ALREADY_EXISTS error is returned.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_create_conversation():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.CreateConversationRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_conversation(request=request)

    # Handle the response
    print(response)

Creates a Session.

If the xref_Session to create already exists, an ALREADY_EXISTS error is returned.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_create_session():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.CreateSessionRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_session(request=request)

    # Handle the response
    print(response)

Returns a fully-qualified data_store string.

Deletes a Conversation.

If the xref_Conversation to delete does not exist, a NOT_FOUND error is returned.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_delete_conversation():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.DeleteConversationRequest(
        name="name_value",
    )

    # Make the request
    client.delete_conversation(request=request)

Deletes a Session.

If the xref_Session to delete does not exist, a NOT_FOUND error is returned.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_delete_session():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.DeleteSessionRequest(
        name="name_value",
    )

    # Make the request
    client.delete_session(request=request)

Returns a fully-qualified document string.

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Gets a Answer.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_get_answer():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.GetAnswerRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_answer(request=request)

    # Handle the response
    print(response)

Gets a Conversation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_get_conversation():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.GetConversationRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_conversation(request=request)

    # Handle the response
    print(response)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Gets the latest state of a long-running operation.

Gets a Session.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_get_session():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.GetSessionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_session(request=request)

    # Handle the response
    print(response)

Lists all Conversations by their parent xref_DataStore.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_list_conversations():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.ListConversationsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_conversations(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists operations that match the specified filter in the request.

Lists all Sessions by their parent xref_DataStore.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_list_sessions():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.ListSessionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_sessions(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parses a answer path into its component segments.

Parses a chunk path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a conversation path into its component segments.

Parses a data_store path into its component segments.

Parses a document path into its component segments.

Parses a serving_config path into its component segments.

Parses a session path into its component segments.

Returns a fully-qualified serving_config string.

Returns a fully-qualified session string.

Updates a Conversation.

xref_Conversation action type cannot be changed. If the xref_Conversation to update does not exist, a NOT_FOUND error is returned.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_update_conversation():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.UpdateConversationRequest(
    )

    # Make the request
    response = client.update_conversation(request=request)

    # Handle the response
    print(response)

Updates a Session.

xref_Session action type cannot be changed. If the xref_Session to update does not exist, a NOT_FOUND error is returned.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1alpha

def sample_update_session():
    # Create a client
    client = discoveryengine_v1alpha.ConversationalSearchServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.UpdateSessionRequest(
    )

    # Make the request
    response = client.update_session(request=request)

    # Handle the response
    print(response)