Retail v2 API - Class ConversationalSearchServiceClient (2.15.0)

public abstract class ConversationalSearchServiceClient

Reference documentation and code samples for the Retail v2 API class ConversationalSearchServiceClient.

ConversationalSearchService client wrapper, for convenient use.

Inheritance

object > ConversationalSearchServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ConversationalSearchServiceClientImpl

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Service for retail conversational search.

This feature is only available for users who have Retail Conversational Search enabled. Enable Retail Conversational Search on Cloud Console before using this feature.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ConversationalSearchService service, which is a host of "retail.googleapis.com" and a port of 443.

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ConversationalSearchService scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default ConversationalSearchService scopes are:

https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual ConversationalSearchService.ConversationalSearchServiceClient GrpcClient { get; }

The underlying gRPC ConversationalSearchService client

Property Value
Type	Description
`ConversationalSearchServiceConversationalSearchServiceClient`

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

ConversationalSearch(ConversationalSearchRequest, CallSettings)

public virtual ConversationalSearchServiceClient.ConversationalSearchStream ConversationalSearch(ConversationalSearchRequest request, CallSettings callSettings = null)

Performs a conversational search.

This feature is only available for users who have Conversational Search enabled.

Parameters
Name	Description
`request`	`ConversationalSearchRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ConversationalSearchServiceClientConversationalSearchStream`	The server stream.

Example

// Create client
ConversationalSearchServiceClient conversationalSearchServiceClient = ConversationalSearchServiceClient.Create();
// Initialize request argument(s)
ConversationalSearchRequest request = new ConversationalSearchRequest
{
    Placement = "",
    BranchAsBranchName = BranchName.FromProjectLocationCatalogBranch("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]"),
    Query = "",
    PageCategories = { "", },
    ConversationId = "",
    SearchParams = new ConversationalSearchRequest.Types.SearchParams(),
    UserInfo = new UserInfo(),
    ConversationalFilteringSpec = new ConversationalSearchRequest.Types.ConversationalFilteringSpec(),
    VisitorId = "",
    UserLabels = { { "", "" }, },
    SafetySettings =
    {
        new SafetySetting(),
    },
};
// Make the request, returning a streaming response
using ConversationalSearchServiceClient.ConversationalSearchStream response = conversationalSearchServiceClient.ConversationalSearch(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ConversationalSearchResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ConversationalSearchResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

Create()

public static ConversationalSearchServiceClient Create()

Synchronously creates a ConversationalSearchServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ConversationalSearchServiceClientBuilder.

Returns
Type	Description
`ConversationalSearchServiceClient`	The created ConversationalSearchServiceClient.

CreateAsync(CancellationToken)

public static Task<ConversationalSearchServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a ConversationalSearchServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ConversationalSearchServiceClientBuilder.

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskConversationalSearchServiceClient`	The task representing the created ConversationalSearchServiceClient.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`Task`	A task representing the asynchronous shutdown operation.