Vertex AI v1beta1 API - Class MemoryBankServiceClient (1.0.0-beta38)

public abstract class MemoryBankServiceClient

Reference documentation and code samples for the Vertex AI v1beta1 API class MemoryBankServiceClient.

MemoryBankService client wrapper, for convenient use.

Inheritance

object > MemoryBankServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

MemoryBankServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Remarks

A service for managing memories for LLM applications.

Properties

CreateMemoryOperationsClient

public virtual OperationsClient CreateMemoryOperationsClient { get; }

The long-running operations client for CreateMemory.

Property Value
Type	Description
`OperationsClient`

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
`string`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default MemoryBankService scopes.

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default MemoryBankService scopes are:

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

DeleteMemoryOperationsClient

public virtual OperationsClient DeleteMemoryOperationsClient { get; }

The long-running operations client for DeleteMemory.

Property Value
Type	Description
`OperationsClient`

GenerateMemoriesOperationsClient

public virtual OperationsClient GenerateMemoriesOperationsClient { get; }

The long-running operations client for GenerateMemories.

Property Value
Type	Description
`OperationsClient`

GrpcClient

public virtual MemoryBankService.MemoryBankServiceClient GrpcClient { get; }

The underlying gRPC MemoryBankService client

Property Value
Type	Description
`MemoryBankServiceMemoryBankServiceClient`

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
`IAMPolicyClient`

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`

UpdateMemoryOperationsClient

public virtual OperationsClient UpdateMemoryOperationsClient { get; }

The long-running operations client for UpdateMemory.

Property Value
Type	Description
`OperationsClient`

Methods

Create()

public static MemoryBankServiceClient Create()

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

Returns
Type	Description
`MemoryBankServiceClient`	The created MemoryBankServiceClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
`TaskMemoryBankServiceClient`	The task representing the created MemoryBankServiceClient.

CreateMemory(CreateMemoryRequest, CallSettings)

public virtual Operation<Memory, CreateMemoryOperationMetadata> CreateMemory(CreateMemoryRequest request, CallSettings callSettings = null)

Create a Memory.

Parameters
Name	Description
`request`	`CreateMemoryRequest` 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
`OperationMemoryCreateMemoryOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
CreateMemoryRequest request = new CreateMemoryRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Memory = new Memory(),
};
// Make the request
Operation<Memory, CreateMemoryOperationMetadata> response = memoryBankServiceClient.CreateMemory(request);

// Poll until the returned long-running operation is complete
Operation<Memory, CreateMemoryOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, CreateMemoryOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceCreateMemory(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

CreateMemoryAsync(CreateMemoryRequest, CallSettings)

public virtual Task<Operation<Memory, CreateMemoryOperationMetadata>> CreateMemoryAsync(CreateMemoryRequest request, CallSettings callSettings = null)

Create a Memory.

Parameters
Name	Description
`request`	`CreateMemoryRequest` 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
`TaskOperationMemoryCreateMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
CreateMemoryRequest request = new CreateMemoryRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Memory = new Memory(),
};
// Make the request
Operation<Memory, CreateMemoryOperationMetadata> response = await memoryBankServiceClient.CreateMemoryAsync(request);

// Poll until the returned long-running operation is complete
Operation<Memory, CreateMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, CreateMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceCreateMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

CreateMemoryAsync(CreateMemoryRequest, CancellationToken)

public virtual Task<Operation<Memory, CreateMemoryOperationMetadata>> CreateMemoryAsync(CreateMemoryRequest request, CancellationToken cancellationToken)

Create a Memory.

Parameters
Name	Description
`request`	`CreateMemoryRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationMemoryCreateMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
CreateMemoryRequest request = new CreateMemoryRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Memory = new Memory(),
};
// Make the request
Operation<Memory, CreateMemoryOperationMetadata> response = await memoryBankServiceClient.CreateMemoryAsync(request);

// Poll until the returned long-running operation is complete
Operation<Memory, CreateMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, CreateMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceCreateMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

DeleteMemory(DeleteMemoryRequest, CallSettings)

public virtual Operation<Empty, DeleteMemoryOperationMetadata> DeleteMemory(DeleteMemoryRequest request, CallSettings callSettings = null)

Delete a Memory.

Parameters
Name	Description
`request`	`DeleteMemoryRequest` 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
`OperationEmptyDeleteMemoryOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
DeleteMemoryRequest request = new DeleteMemoryRequest
{
    MemoryName = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]"),
};
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = memoryBankServiceClient.DeleteMemory(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceDeleteMemory(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteMemory(MemoryName, CallSettings)

public virtual Operation<Empty, DeleteMemoryOperationMetadata> DeleteMemory(MemoryName name, CallSettings callSettings = null)

Delete a Memory.

Parameters
Name	Description
`name`	`MemoryName` Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationEmptyDeleteMemoryOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
MemoryName name = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]");
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = memoryBankServiceClient.DeleteMemory(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceDeleteMemory(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteMemory(string, CallSettings)

public virtual Operation<Empty, DeleteMemoryOperationMetadata> DeleteMemory(string name, CallSettings callSettings = null)

Delete a Memory.

Parameters
Name	Description
`name`	`string` Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationEmptyDeleteMemoryOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]/memories/[MEMORY]";
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = memoryBankServiceClient.DeleteMemory(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceDeleteMemory(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteMemoryAsync(DeleteMemoryRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteMemoryOperationMetadata>> DeleteMemoryAsync(DeleteMemoryRequest request, CallSettings callSettings = null)

Delete a Memory.

Parameters
Name	Description
`request`	`DeleteMemoryRequest` 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
`TaskOperationEmptyDeleteMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteMemoryRequest request = new DeleteMemoryRequest
{
    MemoryName = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]"),
};
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = await memoryBankServiceClient.DeleteMemoryAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceDeleteMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteMemoryAsync(DeleteMemoryRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteMemoryOperationMetadata>> DeleteMemoryAsync(DeleteMemoryRequest request, CancellationToken cancellationToken)

Delete a Memory.

Parameters
Name	Description
`request`	`DeleteMemoryRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationEmptyDeleteMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteMemoryRequest request = new DeleteMemoryRequest
{
    MemoryName = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]"),
};
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = await memoryBankServiceClient.DeleteMemoryAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceDeleteMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteMemoryAsync(MemoryName, CallSettings)

public virtual Task<Operation<Empty, DeleteMemoryOperationMetadata>> DeleteMemoryAsync(MemoryName name, CallSettings callSettings = null)

Delete a Memory.

Parameters
Name	Description
`name`	`MemoryName` Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationEmptyDeleteMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
MemoryName name = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]");
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = await memoryBankServiceClient.DeleteMemoryAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceDeleteMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteMemoryAsync(MemoryName, CancellationToken)

public virtual Task<Operation<Empty, DeleteMemoryOperationMetadata>> DeleteMemoryAsync(MemoryName name, CancellationToken cancellationToken)

Delete a Memory.

Parameters
Name	Description
`name`	`MemoryName` Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationEmptyDeleteMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
MemoryName name = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]");
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = await memoryBankServiceClient.DeleteMemoryAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceDeleteMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteMemoryAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteMemoryOperationMetadata>> DeleteMemoryAsync(string name, CallSettings callSettings = null)

Delete a Memory.

Parameters
Name	Description
`name`	`string` Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationEmptyDeleteMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]/memories/[MEMORY]";
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = await memoryBankServiceClient.DeleteMemoryAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceDeleteMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteMemoryAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteMemoryOperationMetadata>> DeleteMemoryAsync(string name, CancellationToken cancellationToken)

Delete a Memory.

Parameters
Name	Description
`name`	`string` Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationEmptyDeleteMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]/memories/[MEMORY]";
// Make the request
Operation<Empty, DeleteMemoryOperationMetadata> response = await memoryBankServiceClient.DeleteMemoryAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceDeleteMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GenerateMemories(GenerateMemoriesRequest, CallSettings)

public virtual Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> GenerateMemories(GenerateMemoriesRequest request, CallSettings callSettings = null)

Generate memories.

Parameters
Name	Description
`request`	`GenerateMemoriesRequest` 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
`OperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
GenerateMemoriesRequest request = new GenerateMemoriesRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    VertexSessionSource = new GenerateMemoriesRequest.Types.VertexSessionSource(),
    DisableConsolidation = false,
    Scope = { { "", "" }, },
};
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = memoryBankServiceClient.GenerateMemories(request);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceGenerateMemories(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GenerateMemories(ReasoningEngineName, CallSettings)

public virtual Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> GenerateMemories(ReasoningEngineName parent, CallSettings callSettings = null)

Generate memories.

Parameters
Name	Description
`parent`	`ReasoningEngineName` Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
ReasoningEngineName parent = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = memoryBankServiceClient.GenerateMemories(parent);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceGenerateMemories(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GenerateMemories(string, CallSettings)

public virtual Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> GenerateMemories(string parent, CallSettings callSettings = null)

Generate memories.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]";
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = memoryBankServiceClient.GenerateMemories(parent);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceGenerateMemories(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GenerateMemoriesAsync(GenerateMemoriesRequest, CallSettings)

public virtual Task<Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata>> GenerateMemoriesAsync(GenerateMemoriesRequest request, CallSettings callSettings = null)

Generate memories.

Parameters
Name	Description
`request`	`GenerateMemoriesRequest` 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
`TaskOperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
GenerateMemoriesRequest request = new GenerateMemoriesRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    VertexSessionSource = new GenerateMemoriesRequest.Types.VertexSessionSource(),
    DisableConsolidation = false,
    Scope = { { "", "" }, },
};
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = await memoryBankServiceClient.GenerateMemoriesAsync(request);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceGenerateMemoriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GenerateMemoriesAsync(GenerateMemoriesRequest, CancellationToken)

public virtual Task<Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata>> GenerateMemoriesAsync(GenerateMemoriesRequest request, CancellationToken cancellationToken)

Generate memories.

Parameters
Name	Description
`request`	`GenerateMemoriesRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
GenerateMemoriesRequest request = new GenerateMemoriesRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    VertexSessionSource = new GenerateMemoriesRequest.Types.VertexSessionSource(),
    DisableConsolidation = false,
    Scope = { { "", "" }, },
};
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = await memoryBankServiceClient.GenerateMemoriesAsync(request);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceGenerateMemoriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GenerateMemoriesAsync(ReasoningEngineName, CallSettings)

public virtual Task<Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata>> GenerateMemoriesAsync(ReasoningEngineName parent, CallSettings callSettings = null)

Generate memories.

Parameters
Name	Description
`parent`	`ReasoningEngineName` Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
ReasoningEngineName parent = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = await memoryBankServiceClient.GenerateMemoriesAsync(parent);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceGenerateMemoriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GenerateMemoriesAsync(ReasoningEngineName, CancellationToken)

public virtual Task<Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata>> GenerateMemoriesAsync(ReasoningEngineName parent, CancellationToken cancellationToken)

Generate memories.

Parameters
Name	Description
`parent`	`ReasoningEngineName` Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
ReasoningEngineName parent = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = await memoryBankServiceClient.GenerateMemoriesAsync(parent);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceGenerateMemoriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GenerateMemoriesAsync(string, CallSettings)

public virtual Task<Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata>> GenerateMemoriesAsync(string parent, CallSettings callSettings = null)

Generate memories.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]";
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = await memoryBankServiceClient.GenerateMemoriesAsync(parent);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceGenerateMemoriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GenerateMemoriesAsync(string, CancellationToken)

public virtual Task<Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata>> GenerateMemoriesAsync(string parent, CancellationToken cancellationToken)

Generate memories.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]";
// Make the request
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> response = await memoryBankServiceClient.GenerateMemoriesAsync(parent);

// Poll until the returned long-running operation is complete
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GenerateMemoriesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceGenerateMemoriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GenerateMemoriesResponse retrievedResult = retrievedResponse.Result;
}

GetMemory(GetMemoryRequest, CallSettings)

public virtual Memory GetMemory(GetMemoryRequest request, CallSettings callSettings = null)

Get a Memory.

Parameters
Name	Description
`request`	`GetMemoryRequest` 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
`Memory`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
GetMemoryRequest request = new GetMemoryRequest
{
    MemoryName = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]"),
};
// Make the request
Memory response = memoryBankServiceClient.GetMemory(request);

GetMemory(MemoryName, CallSettings)

public virtual Memory GetMemory(MemoryName name, CallSettings callSettings = null)

Get a Memory.

Parameters
Name	Description
`name`	`MemoryName` Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Memory`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
MemoryName name = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]");
// Make the request
Memory response = memoryBankServiceClient.GetMemory(name);

GetMemory(string, CallSettings)

public virtual Memory GetMemory(string name, CallSettings callSettings = null)

Get a Memory.

Parameters
Name	Description
`name`	`string` Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Memory`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]/memories/[MEMORY]";
// Make the request
Memory response = memoryBankServiceClient.GetMemory(name);

GetMemoryAsync(GetMemoryRequest, CallSettings)

public virtual Task<Memory> GetMemoryAsync(GetMemoryRequest request, CallSettings callSettings = null)

Get a Memory.

Parameters
Name	Description
`request`	`GetMemoryRequest` 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
`TaskMemory`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
GetMemoryRequest request = new GetMemoryRequest
{
    MemoryName = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]"),
};
// Make the request
Memory response = await memoryBankServiceClient.GetMemoryAsync(request);

GetMemoryAsync(GetMemoryRequest, CancellationToken)

public virtual Task<Memory> GetMemoryAsync(GetMemoryRequest request, CancellationToken cancellationToken)

Get a Memory.

Parameters
Name	Description
`request`	`GetMemoryRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskMemory`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
GetMemoryRequest request = new GetMemoryRequest
{
    MemoryName = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]"),
};
// Make the request
Memory response = await memoryBankServiceClient.GetMemoryAsync(request);

GetMemoryAsync(MemoryName, CallSettings)

public virtual Task<Memory> GetMemoryAsync(MemoryName name, CallSettings callSettings = null)

Get a Memory.

Parameters
Name	Description
`name`	`MemoryName` Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskMemory`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
MemoryName name = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]");
// Make the request
Memory response = await memoryBankServiceClient.GetMemoryAsync(name);

GetMemoryAsync(MemoryName, CancellationToken)

public virtual Task<Memory> GetMemoryAsync(MemoryName name, CancellationToken cancellationToken)

Get a Memory.

Parameters
Name	Description
`name`	`MemoryName` Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskMemory`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
MemoryName name = MemoryName.FromProjectLocationReasoningEngineMemory("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[MEMORY]");
// Make the request
Memory response = await memoryBankServiceClient.GetMemoryAsync(name);

GetMemoryAsync(string, CallSettings)

public virtual Task<Memory> GetMemoryAsync(string name, CallSettings callSettings = null)

Get a Memory.

Parameters
Name	Description
`name`	`string` Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskMemory`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]/memories/[MEMORY]";
// Make the request
Memory response = await memoryBankServiceClient.GetMemoryAsync(name);

GetMemoryAsync(string, CancellationToken)

public virtual Task<Memory> GetMemoryAsync(string name, CancellationToken cancellationToken)

Get a Memory.

Parameters
Name	Description
`name`	`string` Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskMemory`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]/memories/[MEMORY]";
// Make the request
Memory response = await memoryBankServiceClient.GetMemoryAsync(name);

ListMemories(ListMemoriesRequest, CallSettings)

public virtual PagedEnumerable<ListMemoriesResponse, Memory> ListMemories(ListMemoriesRequest request, CallSettings callSettings = null)

List Memories.

Parameters
Name	Description
`request`	`ListMemoriesRequest` 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
`PagedEnumerableListMemoriesResponseMemory`	A pageable sequence of Memory resources.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
ListMemoriesRequest request = new ListMemoriesRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListMemoriesResponse, Memory> response = memoryBankServiceClient.ListMemories(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Memory item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListMemoriesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Memory item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Memory> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Memory item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListMemories(ReasoningEngineName, string, int?, CallSettings)

public virtual PagedEnumerable<ListMemoriesResponse, Memory> ListMemories(ReasoningEngineName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List Memories.

Parameters
Name	Description
`parent`	`ReasoningEngineName` Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListMemoriesResponseMemory`	A pageable sequence of Memory resources.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
ReasoningEngineName parent = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
// Make the request
PagedEnumerable<ListMemoriesResponse, Memory> response = memoryBankServiceClient.ListMemories(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Memory item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListMemoriesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Memory item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Memory> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Memory item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListMemories(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListMemoriesResponse, Memory> ListMemories(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List Memories.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListMemoriesResponseMemory`	A pageable sequence of Memory resources.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]";
// Make the request
PagedEnumerable<ListMemoriesResponse, Memory> response = memoryBankServiceClient.ListMemories(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Memory item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListMemoriesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Memory item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Memory> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Memory item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListMemoriesAsync(ListMemoriesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListMemoriesResponse, Memory> ListMemoriesAsync(ListMemoriesRequest request, CallSettings callSettings = null)

List Memories.

Parameters
Name	Description
`request`	`ListMemoriesRequest` 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
`PagedAsyncEnumerableListMemoriesResponseMemory`	A pageable asynchronous sequence of Memory resources.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
ListMemoriesRequest request = new ListMemoriesRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListMemoriesResponse, Memory> response = memoryBankServiceClient.ListMemoriesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Memory item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListMemoriesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Memory item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Memory> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Memory item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListMemoriesAsync(ReasoningEngineName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListMemoriesResponse, Memory> ListMemoriesAsync(ReasoningEngineName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List Memories.

Parameters
Name	Description
`parent`	`ReasoningEngineName` Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListMemoriesResponseMemory`	A pageable asynchronous sequence of Memory resources.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
ReasoningEngineName parent = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
// Make the request
PagedAsyncEnumerable<ListMemoriesResponse, Memory> response = memoryBankServiceClient.ListMemoriesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Memory item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListMemoriesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Memory item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Memory> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Memory item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListMemoriesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListMemoriesResponse, Memory> ListMemoriesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

List Memories.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`pageToken`	`string` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`int` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListMemoriesResponseMemory`	A pageable asynchronous sequence of Memory resources.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]";
// Make the request
PagedAsyncEnumerable<ListMemoriesResponse, Memory> response = memoryBankServiceClient.ListMemoriesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Memory item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListMemoriesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Memory item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Memory> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Memory item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateMemory(string, CallSettings)

public virtual Operation<Memory, CreateMemoryOperationMetadata> PollOnceCreateMemory(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateMemory.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationMemoryCreateMemoryOperationMetadata`	The result of polling the operation.

PollOnceCreateMemoryAsync(string, CallSettings)

public virtual Task<Operation<Memory, CreateMemoryOperationMetadata>> PollOnceCreateMemoryAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateMemory.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationMemoryCreateMemoryOperationMetadata`	A task representing the result of polling the operation.

PollOnceDeleteMemory(string, CallSettings)

public virtual Operation<Empty, DeleteMemoryOperationMetadata> PollOnceDeleteMemory(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteMemory.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationEmptyDeleteMemoryOperationMetadata`	The result of polling the operation.

PollOnceDeleteMemoryAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteMemoryOperationMetadata>> PollOnceDeleteMemoryAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteMemory.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationEmptyDeleteMemoryOperationMetadata`	A task representing the result of polling the operation.

PollOnceGenerateMemories(string, CallSettings)

public virtual Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata> PollOnceGenerateMemories(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of GenerateMemories.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	The result of polling the operation.

PollOnceGenerateMemoriesAsync(string, CallSettings)

public virtual Task<Operation<GenerateMemoriesResponse, GenerateMemoriesOperationMetadata>> PollOnceGenerateMemoriesAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of GenerateMemories.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationGenerateMemoriesResponseGenerateMemoriesOperationMetadata`	A task representing the result of polling the operation.

PollOnceUpdateMemory(string, CallSettings)

public virtual Operation<Memory, UpdateMemoryOperationMetadata> PollOnceUpdateMemory(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateMemory.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationMemoryUpdateMemoryOperationMetadata`	The result of polling the operation.

PollOnceUpdateMemoryAsync(string, CallSettings)

public virtual Task<Operation<Memory, UpdateMemoryOperationMetadata>> PollOnceUpdateMemoryAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateMemory.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationMemoryUpdateMemoryOperationMetadata`	A task representing the result of polling the operation.

RetrieveMemories(ReasoningEngineName, CallSettings)

public virtual RetrieveMemoriesResponse RetrieveMemories(ReasoningEngineName parent, CallSettings callSettings = null)

Retrieve memories.

Parameters
Name	Description
`parent`	`ReasoningEngineName` Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`RetrieveMemoriesResponse`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
ReasoningEngineName parent = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
// Make the request
RetrieveMemoriesResponse response = memoryBankServiceClient.RetrieveMemories(parent);

RetrieveMemories(RetrieveMemoriesRequest, CallSettings)

public virtual RetrieveMemoriesResponse RetrieveMemories(RetrieveMemoriesRequest request, CallSettings callSettings = null)

Retrieve memories.

Parameters
Name	Description
`request`	`RetrieveMemoriesRequest` 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
`RetrieveMemoriesResponse`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
RetrieveMemoriesRequest request = new RetrieveMemoriesRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    SimilaritySearchParams = new RetrieveMemoriesRequest.Types.SimilaritySearchParams(),
    Scope = { { "", "" }, },
};
// Make the request
RetrieveMemoriesResponse response = memoryBankServiceClient.RetrieveMemories(request);

RetrieveMemories(string, CallSettings)

public virtual RetrieveMemoriesResponse RetrieveMemories(string parent, CallSettings callSettings = null)

Retrieve memories.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`RetrieveMemoriesResponse`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]";
// Make the request
RetrieveMemoriesResponse response = memoryBankServiceClient.RetrieveMemories(parent);

RetrieveMemoriesAsync(ReasoningEngineName, CallSettings)

public virtual Task<RetrieveMemoriesResponse> RetrieveMemoriesAsync(ReasoningEngineName parent, CallSettings callSettings = null)

Retrieve memories.

Parameters
Name	Description
`parent`	`ReasoningEngineName` Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskRetrieveMemoriesResponse`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
ReasoningEngineName parent = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
// Make the request
RetrieveMemoriesResponse response = await memoryBankServiceClient.RetrieveMemoriesAsync(parent);

RetrieveMemoriesAsync(ReasoningEngineName, CancellationToken)

public virtual Task<RetrieveMemoriesResponse> RetrieveMemoriesAsync(ReasoningEngineName parent, CancellationToken cancellationToken)

Retrieve memories.

Parameters
Name	Description
`parent`	`ReasoningEngineName` Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskRetrieveMemoriesResponse`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
ReasoningEngineName parent = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
// Make the request
RetrieveMemoriesResponse response = await memoryBankServiceClient.RetrieveMemoriesAsync(parent);

RetrieveMemoriesAsync(RetrieveMemoriesRequest, CallSettings)

public virtual Task<RetrieveMemoriesResponse> RetrieveMemoriesAsync(RetrieveMemoriesRequest request, CallSettings callSettings = null)

Retrieve memories.

Parameters
Name	Description
`request`	`RetrieveMemoriesRequest` 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
`TaskRetrieveMemoriesResponse`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
RetrieveMemoriesRequest request = new RetrieveMemoriesRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    SimilaritySearchParams = new RetrieveMemoriesRequest.Types.SimilaritySearchParams(),
    Scope = { { "", "" }, },
};
// Make the request
RetrieveMemoriesResponse response = await memoryBankServiceClient.RetrieveMemoriesAsync(request);

RetrieveMemoriesAsync(RetrieveMemoriesRequest, CancellationToken)

public virtual Task<RetrieveMemoriesResponse> RetrieveMemoriesAsync(RetrieveMemoriesRequest request, CancellationToken cancellationToken)

Retrieve memories.

Parameters
Name	Description
`request`	`RetrieveMemoriesRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskRetrieveMemoriesResponse`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
RetrieveMemoriesRequest request = new RetrieveMemoriesRequest
{
    ParentAsReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    SimilaritySearchParams = new RetrieveMemoriesRequest.Types.SimilaritySearchParams(),
    Scope = { { "", "" }, },
};
// Make the request
RetrieveMemoriesResponse response = await memoryBankServiceClient.RetrieveMemoriesAsync(request);

RetrieveMemoriesAsync(string, CallSettings)

public virtual Task<RetrieveMemoriesResponse> RetrieveMemoriesAsync(string parent, CallSettings callSettings = null)

Retrieve memories.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskRetrieveMemoriesResponse`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]";
// Make the request
RetrieveMemoriesResponse response = await memoryBankServiceClient.RetrieveMemoriesAsync(parent);

RetrieveMemoriesAsync(string, CancellationToken)

public virtual Task<RetrieveMemoriesResponse> RetrieveMemoriesAsync(string parent, CancellationToken cancellationToken)

Retrieve memories.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskRetrieveMemoriesResponse`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/reasoningEngines/[REASONING_ENGINE]";
// Make the request
RetrieveMemoriesResponse response = await memoryBankServiceClient.RetrieveMemoriesAsync(parent);

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.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateMemory(Memory, FieldMask, CallSettings)

public virtual Operation<Memory, UpdateMemoryOperationMetadata> UpdateMemory(Memory memory, FieldMask updateMask, CallSettings callSettings = null)

Update a Memory.

Parameters
Name	Description
`memory`	`Memory` Required. The Memory which replaces the resource on the server.
`updateMask`	`FieldMask` Optional. Mask specifying which fields to update. Supported fields: `display_name` `description` `fact`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationMemoryUpdateMemoryOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
Memory memory = new Memory();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Memory, UpdateMemoryOperationMetadata> response = memoryBankServiceClient.UpdateMemory(memory, updateMask);

// Poll until the returned long-running operation is complete
Operation<Memory, UpdateMemoryOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, UpdateMemoryOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceUpdateMemory(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

UpdateMemory(UpdateMemoryRequest, CallSettings)

public virtual Operation<Memory, UpdateMemoryOperationMetadata> UpdateMemory(UpdateMemoryRequest request, CallSettings callSettings = null)

Update a Memory.

Parameters
Name	Description
`request`	`UpdateMemoryRequest` 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
`OperationMemoryUpdateMemoryOperationMetadata`	The RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = MemoryBankServiceClient.Create();
// Initialize request argument(s)
UpdateMemoryRequest request = new UpdateMemoryRequest
{
    Memory = new Memory(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Memory, UpdateMemoryOperationMetadata> response = memoryBankServiceClient.UpdateMemory(request);

// Poll until the returned long-running operation is complete
Operation<Memory, UpdateMemoryOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, UpdateMemoryOperationMetadata> retrievedResponse = memoryBankServiceClient.PollOnceUpdateMemory(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

UpdateMemoryAsync(Memory, FieldMask, CallSettings)

public virtual Task<Operation<Memory, UpdateMemoryOperationMetadata>> UpdateMemoryAsync(Memory memory, FieldMask updateMask, CallSettings callSettings = null)

Update a Memory.

Parameters
Name	Description
`memory`	`Memory` Required. The Memory which replaces the resource on the server.
`updateMask`	`FieldMask` Optional. Mask specifying which fields to update. Supported fields: `display_name` `description` `fact`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationMemoryUpdateMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
Memory memory = new Memory();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Memory, UpdateMemoryOperationMetadata> response = await memoryBankServiceClient.UpdateMemoryAsync(memory, updateMask);

// Poll until the returned long-running operation is complete
Operation<Memory, UpdateMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, UpdateMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceUpdateMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

UpdateMemoryAsync(Memory, FieldMask, CancellationToken)

public virtual Task<Operation<Memory, UpdateMemoryOperationMetadata>> UpdateMemoryAsync(Memory memory, FieldMask updateMask, CancellationToken cancellationToken)

Update a Memory.

Parameters
Name	Description
`memory`	`Memory` Required. The Memory which replaces the resource on the server.
`updateMask`	`FieldMask` Optional. Mask specifying which fields to update. Supported fields: `display_name` `description` `fact`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationMemoryUpdateMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
Memory memory = new Memory();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Memory, UpdateMemoryOperationMetadata> response = await memoryBankServiceClient.UpdateMemoryAsync(memory, updateMask);

// Poll until the returned long-running operation is complete
Operation<Memory, UpdateMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, UpdateMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceUpdateMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

UpdateMemoryAsync(UpdateMemoryRequest, CallSettings)

public virtual Task<Operation<Memory, UpdateMemoryOperationMetadata>> UpdateMemoryAsync(UpdateMemoryRequest request, CallSettings callSettings = null)

Update a Memory.

Parameters
Name	Description
`request`	`UpdateMemoryRequest` 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
`TaskOperationMemoryUpdateMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateMemoryRequest request = new UpdateMemoryRequest
{
    Memory = new Memory(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Memory, UpdateMemoryOperationMetadata> response = await memoryBankServiceClient.UpdateMemoryAsync(request);

// Poll until the returned long-running operation is complete
Operation<Memory, UpdateMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, UpdateMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceUpdateMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

UpdateMemoryAsync(UpdateMemoryRequest, CancellationToken)

public virtual Task<Operation<Memory, UpdateMemoryOperationMetadata>> UpdateMemoryAsync(UpdateMemoryRequest request, CancellationToken cancellationToken)

Update a Memory.

Parameters
Name	Description
`request`	`UpdateMemoryRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationMemoryUpdateMemoryOperationMetadata`	A Task containing the RPC response.

Example

// Create client
MemoryBankServiceClient memoryBankServiceClient = await MemoryBankServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateMemoryRequest request = new UpdateMemoryRequest
{
    Memory = new Memory(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Memory, UpdateMemoryOperationMetadata> response = await memoryBankServiceClient.UpdateMemoryAsync(request);

// Poll until the returned long-running operation is complete
Operation<Memory, UpdateMemoryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Memory result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Memory, UpdateMemoryOperationMetadata> retrievedResponse = await memoryBankServiceClient.PollOnceUpdateMemoryAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Memory retrievedResult = retrievedResponse.Result;
}

Vertex AI v1beta1 API - Class MemoryBankServiceClient (1.0.0-beta38) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Inherited Members

Derived Types

Namespace

Assembly

Remarks

Properties

CreateMemoryOperationsClient

DefaultEndpoint

DefaultScopes

DeleteMemoryOperationsClient

GenerateMemoriesOperationsClient

GrpcClient

IAMPolicyClient

LocationsClient

ServiceMetadata

UpdateMemoryOperationsClient

Methods

Create()

CreateAsync(CancellationToken)

CreateMemory(CreateMemoryRequest, CallSettings)

CreateMemoryAsync(CreateMemoryRequest, CallSettings)

CreateMemoryAsync(CreateMemoryRequest, CancellationToken)

DeleteMemory(DeleteMemoryRequest, CallSettings)

DeleteMemory(MemoryName, CallSettings)

DeleteMemory(string, CallSettings)

DeleteMemoryAsync(DeleteMemoryRequest, CallSettings)

DeleteMemoryAsync(DeleteMemoryRequest, CancellationToken)

DeleteMemoryAsync(MemoryName, CallSettings)

DeleteMemoryAsync(MemoryName, CancellationToken)

DeleteMemoryAsync(string, CallSettings)

DeleteMemoryAsync(string, CancellationToken)

GenerateMemories(GenerateMemoriesRequest, CallSettings)

GenerateMemories(ReasoningEngineName, CallSettings)

GenerateMemories(string, CallSettings)

GenerateMemoriesAsync(GenerateMemoriesRequest, CallSettings)

GenerateMemoriesAsync(GenerateMemoriesRequest, CancellationToken)

GenerateMemoriesAsync(ReasoningEngineName, CallSettings)

GenerateMemoriesAsync(ReasoningEngineName, CancellationToken)

GenerateMemoriesAsync(string, CallSettings)

GenerateMemoriesAsync(string, CancellationToken)

GetMemory(GetMemoryRequest, CallSettings)

GetMemory(MemoryName, CallSettings)

GetMemory(string, CallSettings)

GetMemoryAsync(GetMemoryRequest, CallSettings)

GetMemoryAsync(GetMemoryRequest, CancellationToken)

GetMemoryAsync(MemoryName, CallSettings)

GetMemoryAsync(MemoryName, CancellationToken)

GetMemoryAsync(string, CallSettings)

GetMemoryAsync(string, CancellationToken)

ListMemories(ListMemoriesRequest, CallSettings)

ListMemories(ReasoningEngineName, string, int?, CallSettings)

ListMemories(string, string, int?, CallSettings)

ListMemoriesAsync(ListMemoriesRequest, CallSettings)

ListMemoriesAsync(ReasoningEngineName, string, int?, CallSettings)

ListMemoriesAsync(string, string, int?, CallSettings)

PollOnceCreateMemory(string, CallSettings)

PollOnceCreateMemoryAsync(string, CallSettings)

PollOnceDeleteMemory(string, CallSettings)

PollOnceDeleteMemoryAsync(string, CallSettings)

PollOnceGenerateMemories(string, CallSettings)

PollOnceGenerateMemoriesAsync(string, CallSettings)

PollOnceUpdateMemory(string, CallSettings)

PollOnceUpdateMemoryAsync(string, CallSettings)

RetrieveMemories(ReasoningEngineName, CallSettings)

RetrieveMemories(RetrieveMemoriesRequest, CallSettings)

RetrieveMemories(string, CallSettings)

RetrieveMemoriesAsync(ReasoningEngineName, CallSettings)

RetrieveMemoriesAsync(ReasoningEngineName, CancellationToken)

RetrieveMemoriesAsync(RetrieveMemoriesRequest, CallSettings)

RetrieveMemoriesAsync(RetrieveMemoriesRequest, CancellationToken)

RetrieveMemoriesAsync(string, CallSettings)

RetrieveMemoriesAsync(string, CancellationToken)

ShutdownDefaultChannelsAsync()

UpdateMemory(Memory, FieldMask, CallSettings)

UpdateMemory(UpdateMemoryRequest, CallSettings)

UpdateMemoryAsync(Memory, FieldMask, CallSettings)

UpdateMemoryAsync(Memory, FieldMask, CancellationToken)

UpdateMemoryAsync(UpdateMemoryRequest, CallSettings)

Vertex AI v1beta1 API - Class MemoryBankServiceClient (1.0.0-beta38)