Package cloud.google.com/go/agentplatform (v0.20.0)

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Package agentplatform provides a client for interacting with Agent Platform APIs.

New users are encouraged to use the Google GenAI Go SDK available at google.golang.org/genai.

See cloud.google.com/go/agentplatform for the currently supported functionality.

AgentEngines

type AgentEngines struct {
	Sessions  *Sessions
	Sandboxes *Sandboxes
	Memories  *Memories
	// contains filtered or unexported fields
}

func (AgentEngines) Create

func (m AgentEngines) Create(ctx context.Context, config *types.CreateAgentEngineConfig) (*types.AgentEngineOperation, error)

Create creates an agent engine based on the provided configuration and returns the operation object representing the creation process.

func (AgentEngines) Delete

func (m AgentEngines) Delete(ctx context.Context, name string, force bool, config *types.DeleteAgentEngineConfig) (*types.DeleteAgentEngineOperation, error)

Delete deletes the agent engine with the specified name and returns the operation object representing the deletion process.

func (AgentEngines) Get

func (m AgentEngines) Get(ctx context.Context, name string, config *types.GetAgentEngineConfig) (*types.ReasoningEngine, error)

Get returns the agent engine with the specified name and returns the agent engine object representing the get agent engine process.

func (AgentEngines) GetAgentOperation

func (m AgentEngines) GetAgentOperation(ctx context.Context, operationName string, config *types.GetAgentEngineOperationConfig) (*types.AgentEngineOperation, error)

GetAgentOperation returns the operation object representing the get agent operation process.

func (AgentEngines) List

func (m AgentEngines) List(ctx context.Context, config *types.ListAgentEngineConfig) (*types.ListReasoningEnginesResponse, error)

List lists the agent engines that match the provided configuration and returns the list of agent engines and the operation object representing the listing process.

func (AgentEngines) Query

func (m AgentEngines) Query(ctx context.Context, name string, config *types.QueryAgentEngineConfig) (*types.QueryReasoningEngineResponse, error)

Query queries the agent engine with the specified name and returns the response object representing the query agent engine process.

func (AgentEngines) Update

func (m AgentEngines) Update(ctx context.Context, name string, config *types.UpdateAgentEngineConfig) (*types.AgentEngineOperation, error)

Update updates the agent engine with the specified name and returns the operation object representing the update process.

Client

type Client struct {
	AgentEngines *clientAgentEngines
}

A Client is a Google Vertex AI client.

func NewClient

func NewClient(ctx context.Context, cc *genai.ClientConfig) (*Client, error)

NewClient creates a new Google Vertex AI client and configures the the GenAI components.

Memories

type Memories struct {
	MemoryRevisions *MemoryRevisions
	// contains filtered or unexported fields
}

func (Memories) Create

func (m Memories) Create(ctx context.Context, name string, fact string, scope map[string]string, config *types.AgentEngineMemoryConfig) (*types.AgentEngineMemoryOperation, error)

Create creates a new memory for the given name, fact, scope, and config.

func (Memories) Delete

func (m Memories) Delete(ctx context.Context, name string, config *types.DeleteAgentEngineMemoryConfig) (*types.DeleteAgentEngineMemoryOperation, error)

func (Memories) Generate

func (m Memories) Generate(ctx context.Context, name string, vertexSessionSource *types.GenerateMemoriesRequestVertexSessionSource, directContentsSource *types.GenerateMemoriesRequestDirectContentsSource, directMemoriesSource *types.GenerateMemoriesRequestDirectMemoriesSource, scope *map[string]string, config *types.GenerateAgentEngineMemoriesConfig) (*types.AgentEngineGenerateMemoriesOperation, error)

Generate generates the memories for the given name, vertex session source, direct contents source, direct memories source, scope, and config, and returns the operation.

func (Memories) Get

func (m Memories) Get(ctx context.Context, name string, config *types.GetAgentEngineMemoryConfig) (*types.Memory, error)

func (Memories) GetGenerateMemoriesOperation

func (m Memories) GetGenerateMemoriesOperation(ctx context.Context, operationName string, config *types.GetAgentEngineOperationConfig) (*types.AgentEngineGenerateMemoriesOperation, error)

GetGenerateMemoriesOperation returns the generate memories operation for the given operation name, vertex session source, direct contents source, direct memories source, scope, and config.

func (Memories) GetMemoryOperation

func (m Memories) GetMemoryOperation(ctx context.Context, operationName string, config *types.GetAgentEngineOperationConfig) (*types.AgentEngineMemoryOperation, error)

GetMemoryOperation returns the memory operation for the given operation name and config.

func (Memories) List

func (m Memories) List(ctx context.Context, name string, config *types.ListAgentEngineMemoryConfig) (*types.ListReasoningEnginesMemoriesResponse, error)

List lists the memories for the given name and config, and returns the response.

func (Memories) Purge

func (m Memories) Purge(ctx context.Context, name string, filter string, filterGroups []*types.MemoryConjunctionFilter, force bool, config *types.PurgeAgentEngineMemoriesConfig) (*types.AgentEnginePurgeMemoriesOperation, error)

Purge purges the memory for the given name, filter, filter groups, force, and config, and returns the purge memory operation.

func (Memories) Retrieve

func (m Memories) Retrieve(ctx context.Context, name string, scope map[string]string, similaritySearchParams *types.RetrieveMemoriesRequestSimilaritySearchParams, simpleRetrievalParams *types.RetrieveMemoriesRequestSimpleRetrievalParams, config *types.RetrieveAgentEngineMemoriesConfig) (*types.RetrieveMemoriesResponse, error)

Retrieve retrieves the memories for the given name, scope, similarity search params, simple retrieval params, and config, and returns the response.

func (Memories) RetrieveProfiles

func (m Memories) RetrieveProfiles(ctx context.Context, name string, scope map[string]string, config *types.RetrieveMemoryProfilesConfig) (*types.RetrieveProfilesResponse, error)

func (Memories) Rollback

func (m Memories) Rollback(ctx context.Context, name string, targetRevisionId string, config *types.RollbackAgentEngineMemoryConfig) (*types.AgentEngineRollbackMemoryOperation, error)

Rollback rolls back the memory to the given target revision id and returns the rollback memory operation.

func (Memories) Update

func (m Memories) Update(ctx context.Context, name string, fact string, scope *map[string]string, config *types.UpdateAgentEngineMemoryConfig) (*types.AgentEngineMemoryOperation, error)

Update updates the memory for the given name, fact, scope, and config, and returns the memory operation.

MemoryRevisions

type MemoryRevisions struct {
	// contains filtered or unexported fields
}

func (MemoryRevisions) Get

func (m MemoryRevisions) Get(ctx context.Context, name string, config *types.GetAgentEngineMemoryRevisionConfig) (*types.MemoryRevision, error)

func (MemoryRevisions) List

func (m MemoryRevisions) List(ctx context.Context, name string, config *types.ListAgentEngineMemoryRevisionsConfig) (*types.ListAgentEngineMemoryRevisionsResponse, error)

List lists the memory revisions for the given name and config, and returns the response.

Sandboxes

type Sandboxes struct {
	// contains filtered or unexported fields
}

func (Sandboxes) Create

func (m Sandboxes) Create(ctx context.Context, name string, spec *types.SandboxEnvironmentSpec, config *types.CreateAgentEngineSandboxConfig) (*types.AgentEngineSandboxOperation, error)

Create creates a sandbox for the given name, spec, and config, and returns the sandbox operation.

func (Sandboxes) Delete

func (m Sandboxes) Delete(ctx context.Context, name string, config *types.DeleteAgentEngineSandboxConfig) (*types.DeleteAgentEngineSandboxOperation, error)

Delete deletes the sandbox with the specified name and returns the sandbox operation representing the deletion process.

func (Sandboxes) ExecuteCode

func (m Sandboxes) ExecuteCode(ctx context.Context, name string, inputs []*types.Chunk, config *types.ExecuteCodeAgentEngineSandboxConfig) (*types.ExecuteSandboxEnvironmentResponse, error)

ExecuteCode executes the code for the given name, inputs, and config, and returns the response.

func (Sandboxes) Get

func (m Sandboxes) Get(ctx context.Context, name string, config *types.GetAgentEngineSandboxConfig) (*types.SandboxEnvironment, error)

Get returns the sandbox with the specified name and returns the sandbox object representing the get sandbox process.

func (Sandboxes) GetSandboxOperation

func (m Sandboxes) GetSandboxOperation(ctx context.Context, operationName string, config *types.GetAgentEngineOperationConfig) (*types.AgentEngineSandboxOperation, error)

GetSandboxOperation returns the sandbox operation for the given operation name and config, and returns the sandbox operation.

func (Sandboxes) List

func (m Sandboxes) List(ctx context.Context, name string, config *types.ListAgentEngineSandboxesConfig) (*types.ListAgentEngineSandboxesResponse, error)

List lists the sandboxes for the given name and config, and returns the response.

SessionEvents

type SessionEvents struct {
	// contains filtered or unexported fields
}

func (SessionEvents) Append

func (m SessionEvents) Append(ctx context.Context, name string, author string, invocationId string, timestamp time.Time, config *types.AppendAgentEngineSessionEventConfig) (*types.AppendAgentEngineSessionEventResponse, error)

func (SessionEvents) List

func (m SessionEvents) List(ctx context.Context, name string, config *types.ListAgentEngineSessionEventsConfig) (*types.ListAgentEngineSessionEventsResponse, error)

List lists the session events for the given name and config, and returns the response.

Sessions

type Sessions struct {
	SessionEvents *SessionEvents
	// contains filtered or unexported fields
}

func (Sessions) Create

func (m Sessions) Create(ctx context.Context, name string, userId string, config *types.CreateAgentEngineSessionConfig) (*types.AgentEngineSessionOperation, error)

Create creates a session for the given name, user ID, and config, and returns the session operation.

func (Sessions) Delete

func (m Sessions) Delete(ctx context.Context, name string, config *types.DeleteAgentEngineSessionConfig) (*types.DeleteAgentEngineSessionOperation, error)

func (Sessions) Get

func (m Sessions) Get(ctx context.Context, name string, config *types.GetAgentEngineSessionConfig) (*types.Session, error)

func (Sessions) GetSessionOperation

func (m Sessions) GetSessionOperation(ctx context.Context, operationName string, config *types.GetAgentEngineOperationConfig) (*types.AgentEngineSessionOperation, error)

GetSessionOperation returns the session operation for the given operation name and config, and returns the session operation representing the get session process.

func (Sessions) List

func (m Sessions) List(ctx context.Context, name string, config *types.ListAgentEngineSessionsConfig) (*types.ListReasoningEnginesSessionsResponse, error)

List lists the sessions for the given name and config, and returns the response.

func (Sessions) Update

func (m Sessions) Update(ctx context.Context, name string, config *types.UpdateAgentEngineSessionConfig) (*types.AgentEngineSessionOperation, error)

Update updates the session with the specified name and returns the session operation representing the update session process.