com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.Engines

public class DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants
extends Object

The "assistants" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents The "agents" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Create
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Delete
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Get
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.List
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Patch
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.StreamAssist

Constructor Summary

Constructors

Constructor and Description
Assistants()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents	agents() An accessor for creating requests from the Agents collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Create	create(String parent, GoogleCloudDiscoveryengineV1Assistant content) Creates an Assistant.
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Delete	delete(String name) Deletes an Assistant.
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Get	get(String name) Gets an Assistant.
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.List	list(String parent) Lists all Assistants under an Engine.
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Patch	patch(String name, GoogleCloudDiscoveryengineV1Assistant content) Updates an Assistant Create a request for the method "assistants.patch".
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.StreamAssist	streamAssist(String name, GoogleCloudDiscoveryengineV1StreamAssistRequest content) Assists the user with a query in a streaming fashion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Assistants

public Assistants()

Method Detail

create

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Create create(String parent,
                                                                                       GoogleCloudDiscoveryengineV1Assistant content)
                                                                                throws IOException

Creates an Assistant. Create a request for the method "assistants.create". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`

content - the GoogleCloudDiscoveryengineV1Assistant

Returns:

the request

Throws:

IOException

delete

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Delete delete(String name)
                                                                                throws IOException

Deletes an Assistant. Create a request for the method "assistants.delete". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{ collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.

Returns:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Get get(String name)
                                                                          throws IOException

Gets an Assistant. Create a request for the method "assistants.get". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{ collection}/engines/{engine}/assistants/{assistant}`

Returns:

the request

Throws:

IOException

list

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.List list(String parent)
                                                                            throws IOException

Lists all Assistants under an Engine. Create a request for the method "assistants.list". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`

Returns:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Patch patch(String name,
                                                                                     GoogleCloudDiscoveryengineV1Assistant content)
                                                                              throws IOException

Updates an Assistant Create a request for the method "assistants.patch". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collecti ons/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.

content - the GoogleCloudDiscoveryengineV1Assistant

Returns:

the request

Throws:

IOException

streamAssist

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.StreamAssist streamAssist(String name,
                                                                                                   GoogleCloudDiscoveryengineV1StreamAssistRequest content)
                                                                                            throws IOException

Assists the user with a query in a streaming fashion. Create a request for the method "assistants.streamAssist". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/colle ctions/{collection}/engines/{engine}/assistants/{assistant}`

content - the GoogleCloudDiscoveryengineV1StreamAssistRequest

Returns:

the request

Throws:

IOException

agents

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents agents()

An accessor for creating requests from the Agents collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Agents.List request = discoveryengine.agents().list(parameters ...)
 

Returns:

the resource collection