Dialogflow API v2 - Package cloud.google.com/go/dialogflow/apiv2 (v1.9.0)

Stay organized with collections Save and categorize content based on your preferences.

Package dialogflow is an auto-generated package for the Dialogflow API.

Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).

Example usage

To get started with this package, create a client.

ctx := context.Background()
c, err := dialogflow.NewAgentsClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
c, err := dialogflow.NewAgentsClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &dialogflowpb.GetAgentRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetAgentRequest.
}
resp, err := c.GetAgent(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

AgentIterator

type AgentIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.Agent, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AgentIterator manages a stream of *dialogflowpb.Agent.

func (*AgentIterator) Next

func (it *AgentIterator) Next() (*dialogflowpb.Agent, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*AgentIterator) PageInfo

func (it *AgentIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

AgentsCallOptions

type AgentsCallOptions struct {
	GetAgent            []gax.CallOption
	SetAgent            []gax.CallOption
	DeleteAgent         []gax.CallOption
	SearchAgents        []gax.CallOption
	TrainAgent          []gax.CallOption
	ExportAgent         []gax.CallOption
	ImportAgent         []gax.CallOption
	RestoreAgent        []gax.CallOption
	GetValidationResult []gax.CallOption
}

AgentsCallOptions contains the retry settings for each method of AgentsClient.

AgentsClient

type AgentsClient struct {

	// The call options for this service.
	CallOptions *AgentsCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

AgentsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Agents.

func NewAgentsClient

func NewAgentsClient(ctx context.Context, opts ...option.ClientOption) (*AgentsClient, error)

NewAgentsClient creates a new agents client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Agents.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*AgentsClient) Close

func (c *AgentsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*AgentsClient) Connection

func (c *AgentsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*AgentsClient) DeleteAgent

func (c *AgentsClient) DeleteAgent(ctx context.Context, req *dialogflowpb.DeleteAgentRequest, opts ...gax.CallOption) error

DeleteAgent deletes the specified agent.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#DeleteAgentRequest.
	}
	err = c.DeleteAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AgentsClient) ExportAgent

ExportAgent exports the specified agent to a ZIP file.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: An empty Struct message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: ExportAgentResponse

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ExportAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ExportAgentRequest.
	}
	op, err := c.ExportAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AgentsClient) ExportAgentOperation

func (c *AgentsClient) ExportAgentOperation(name string) *ExportAgentOperation

ExportAgentOperation returns a new ExportAgentOperation from a given name. The name must be that of a previously created ExportAgentOperation, possibly from a different process.

func (*AgentsClient) GetAgent

GetAgent retrieves the specified agent.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetAgentRequest.
	}
	resp, err := c.GetAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AgentsClient) GetValidationResult

GetValidationResult gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetValidationResultRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetValidationResultRequest.
	}
	resp, err := c.GetValidationResult(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AgentsClient) ImportAgent

ImportAgent imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: An empty Struct message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: An Empty message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

The operation only tracks when importing is complete, not when it is done training.

Note: You should always train an agent prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/es/docs/training).

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ImportAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ImportAgentRequest.
	}
	op, err := c.ImportAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AgentsClient) ImportAgentOperation

func (c *AgentsClient) ImportAgentOperation(name string) *ImportAgentOperation

ImportAgentOperation returns a new ImportAgentOperation from a given name. The name must be that of a previously created ImportAgentOperation, possibly from a different process.

func (*AgentsClient) RestoreAgent

RestoreAgent restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: An empty Struct message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: An Empty message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

The operation only tracks when restoring is complete, not when it is done training.

Note: You should always train an agent prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/es/docs/training).

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.RestoreAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#RestoreAgentRequest.
	}
	op, err := c.RestoreAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AgentsClient) RestoreAgentOperation

func (c *AgentsClient) RestoreAgentOperation(name string) *RestoreAgentOperation

RestoreAgentOperation returns a new RestoreAgentOperation from a given name. The name must be that of a previously created RestoreAgentOperation, possibly from a different process.

func (*AgentsClient) SearchAgents

SearchAgents returns the list of agents.

Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id “-”. Refer to List Sub-Collections (at https://cloud.google.com/apis/design/design_patterns#list_sub-collections).

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.SearchAgentsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#SearchAgentsRequest.
	}
	it := c.SearchAgents(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*AgentsClient) SetAgent

SetAgent creates/updates the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/es/docs/training).

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.SetAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#SetAgentRequest.
	}
	resp, err := c.SetAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AgentsClient) TrainAgent

TrainAgent trains the specified agent.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: An empty Struct message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)

response: An Empty message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Note: You should always train an agent prior to sending it queries. See the training documentation (at https://cloud.google.com/dialogflow/es/docs/training).

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAgentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.TrainAgentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#TrainAgentRequest.
	}
	op, err := c.TrainAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AgentsClient) TrainAgentOperation

func (c *AgentsClient) TrainAgentOperation(name string) *TrainAgentOperation

TrainAgentOperation returns a new TrainAgentOperation from a given name. The name must be that of a previously created TrainAgentOperation, possibly from a different process.

AnswerRecordIterator

type AnswerRecordIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.AnswerRecord, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AnswerRecordIterator manages a stream of *dialogflowpb.AnswerRecord.

func (*AnswerRecordIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*AnswerRecordIterator) PageInfo

func (it *AnswerRecordIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

AnswerRecordsCallOptions

type AnswerRecordsCallOptions struct {
	ListAnswerRecords  []gax.CallOption
	UpdateAnswerRecord []gax.CallOption
}

AnswerRecordsCallOptions contains the retry settings for each method of AnswerRecordsClient.

AnswerRecordsClient

type AnswerRecordsClient struct {

	// The call options for this service.
	CallOptions *AnswerRecordsCallOptions
	// contains filtered or unexported fields
}

AnswerRecordsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing AnswerRecords.

func NewAnswerRecordsClient

func NewAnswerRecordsClient(ctx context.Context, opts ...option.ClientOption) (*AnswerRecordsClient, error)

NewAnswerRecordsClient creates a new answer records client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing AnswerRecords.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAnswerRecordsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*AnswerRecordsClient) Close

func (c *AnswerRecordsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*AnswerRecordsClient) Connection

func (c *AnswerRecordsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*AnswerRecordsClient) ListAnswerRecords

ListAnswerRecords returns the list of all answer records in the specified project in reverse chronological order.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAnswerRecordsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListAnswerRecordsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ListAnswerRecordsRequest.
	}
	it := c.ListAnswerRecords(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*AnswerRecordsClient) UpdateAnswerRecord

UpdateAnswerRecord updates the specified answer record.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewAnswerRecordsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateAnswerRecordRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#UpdateAnswerRecordRequest.
	}
	resp, err := c.UpdateAnswerRecord(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

BatchCreateEntitiesOperation

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

BatchCreateEntitiesOperation manages a long-running operation from BatchCreateEntities.

func (*BatchCreateEntitiesOperation) Done

Done reports whether the long-running operation has completed.

func (*BatchCreateEntitiesOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*BatchCreateEntitiesOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*BatchCreateEntitiesOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*BatchCreateEntitiesOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

BatchDeleteEntitiesOperation

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

BatchDeleteEntitiesOperation manages a long-running operation from BatchDeleteEntities.

func (*BatchDeleteEntitiesOperation) Done

Done reports whether the long-running operation has completed.

func (*BatchDeleteEntitiesOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*BatchDeleteEntitiesOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*BatchDeleteEntitiesOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*BatchDeleteEntitiesOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

BatchDeleteEntityTypesOperation

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

BatchDeleteEntityTypesOperation manages a long-running operation from BatchDeleteEntityTypes.

func (*BatchDeleteEntityTypesOperation) Done

Done reports whether the long-running operation has completed.

func (*BatchDeleteEntityTypesOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*BatchDeleteEntityTypesOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*BatchDeleteEntityTypesOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*BatchDeleteEntityTypesOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

BatchDeleteIntentsOperation

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

BatchDeleteIntentsOperation manages a long-running operation from BatchDeleteIntents.

func (*BatchDeleteIntentsOperation) Done

func (op *BatchDeleteIntentsOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*BatchDeleteIntentsOperation) Metadata

func (op *BatchDeleteIntentsOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*BatchDeleteIntentsOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*BatchDeleteIntentsOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*BatchDeleteIntentsOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

BatchUpdateEntitiesOperation

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

BatchUpdateEntitiesOperation manages a long-running operation from BatchUpdateEntities.

func (*BatchUpdateEntitiesOperation) Done

Done reports whether the long-running operation has completed.

func (*BatchUpdateEntitiesOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*BatchUpdateEntitiesOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*BatchUpdateEntitiesOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*BatchUpdateEntitiesOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

BatchUpdateEntityTypesOperation

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

BatchUpdateEntityTypesOperation manages a long-running operation from BatchUpdateEntityTypes.

func (*BatchUpdateEntityTypesOperation) Done

Done reports whether the long-running operation has completed.

func (*BatchUpdateEntityTypesOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*BatchUpdateEntityTypesOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*BatchUpdateEntityTypesOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*BatchUpdateEntityTypesOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

BatchUpdateIntentsOperation

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

BatchUpdateIntentsOperation manages a long-running operation from BatchUpdateIntents.

func (*BatchUpdateIntentsOperation) Done

func (op *BatchUpdateIntentsOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*BatchUpdateIntentsOperation) Metadata

func (op *BatchUpdateIntentsOperation) Metadata() (*structpb.Struct, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*BatchUpdateIntentsOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*BatchUpdateIntentsOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*BatchUpdateIntentsOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

ClearSuggestionFeatureConfigOperation

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

ClearSuggestionFeatureConfigOperation manages a long-running operation from ClearSuggestionFeatureConfig.

func (*ClearSuggestionFeatureConfigOperation) Done

Done reports whether the long-running operation has completed.

func (*ClearSuggestionFeatureConfigOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*ClearSuggestionFeatureConfigOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*ClearSuggestionFeatureConfigOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*ClearSuggestionFeatureConfigOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

ContextIterator

type ContextIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.Context, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ContextIterator manages a stream of *dialogflowpb.Context.

func (*ContextIterator) Next

func (it *ContextIterator) Next() (*dialogflowpb.Context, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ContextIterator) PageInfo

func (it *ContextIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

ContextsCallOptions

type ContextsCallOptions struct {
	ListContexts      []gax.CallOption
	GetContext        []gax.CallOption
	CreateContext     []gax.CallOption
	UpdateContext     []gax.CallOption
	DeleteContext     []gax.CallOption
	DeleteAllContexts []gax.CallOption
}

ContextsCallOptions contains the retry settings for each method of ContextsClient.

ContextsClient

type ContextsClient struct {

	// The call options for this service.
	CallOptions *ContextsCallOptions
	// contains filtered or unexported fields
}

ContextsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Contexts.

func NewContextsClient

func NewContextsClient(ctx context.Context, opts ...option.ClientOption) (*ContextsClient, error)

NewContextsClient creates a new contexts client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Contexts.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewContextsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*ContextsClient) Close

func (c *ContextsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ContextsClient) Connection

func (c *ContextsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ContextsClient) CreateContext

CreateContext creates a context.

If the specified context already exists, overrides the context.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewContextsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateContextRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#CreateContextRequest.
	}
	resp, err := c.CreateContext(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ContextsClient) DeleteAllContexts

func (c *ContextsClient) DeleteAllContexts(ctx context.Context, req *dialogflowpb.DeleteAllContextsRequest, opts ...gax.CallOption) error

DeleteAllContexts deletes all active contexts in the specified session.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewContextsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteAllContextsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#DeleteAllContextsRequest.
	}
	err = c.DeleteAllContexts(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*ContextsClient) DeleteContext

func (c *ContextsClient) DeleteContext(ctx context.Context, req *dialogflowpb.DeleteContextRequest, opts ...gax.CallOption) error

DeleteContext deletes the specified context.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewContextsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteContextRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#DeleteContextRequest.
	}
	err = c.DeleteContext(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*ContextsClient) GetContext

GetContext retrieves the specified context.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewContextsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetContextRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetContextRequest.
	}
	resp, err := c.GetContext(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ContextsClient) ListContexts

ListContexts returns the list of all contexts in the specified session.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewContextsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListContextsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ListContextsRequest.
	}
	it := c.ListContexts(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*ContextsClient) UpdateContext

UpdateContext updates the specified context.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewContextsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateContextRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#UpdateContextRequest.
	}
	resp, err := c.UpdateContext(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

ConversationDatasetIterator

type ConversationDatasetIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.ConversationDataset, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ConversationDatasetIterator manages a stream of *dialogflowpb.ConversationDataset.

func (*ConversationDatasetIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ConversationDatasetIterator) PageInfo

func (it *ConversationDatasetIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

ConversationDatasetsCallOptions

type ConversationDatasetsCallOptions struct {
	CreateConversationDataset []gax.CallOption
	GetConversationDataset    []gax.CallOption
	ListConversationDatasets  []gax.CallOption
	DeleteConversationDataset []gax.CallOption
	ImportConversationData    []gax.CallOption
}

ConversationDatasetsCallOptions contains the retry settings for each method of ConversationDatasetsClient.

ConversationDatasetsClient

type ConversationDatasetsClient struct {

	// The call options for this service.
	CallOptions *ConversationDatasetsCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

ConversationDatasetsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Conversation datasets.

Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.

func NewConversationDatasetsClient

func NewConversationDatasetsClient(ctx context.Context, opts ...option.ClientOption) (*ConversationDatasetsClient, error)

NewConversationDatasetsClient creates a new conversation datasets client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Conversation datasets.

Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationDatasetsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*ConversationDatasetsClient) Close

func (c *ConversationDatasetsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ConversationDatasetsClient) Connection

func (c *ConversationDatasetsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ConversationDatasetsClient) CreateConversationDataset

CreateConversationDataset creates a new conversation dataset.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: CreateConversationDatasetOperationMetadata

response: ConversationDataset

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationDatasetsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateConversationDatasetRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#CreateConversationDatasetRequest.
	}
	op, err := c.CreateConversationDataset(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationDatasetsClient) CreateConversationDatasetOperation

func (c *ConversationDatasetsClient) CreateConversationDatasetOperation(name string) *CreateConversationDatasetOperation

CreateConversationDatasetOperation returns a new CreateConversationDatasetOperation from a given name. The name must be that of a previously created CreateConversationDatasetOperation, possibly from a different process.

func (*ConversationDatasetsClient) DeleteConversationDataset

DeleteConversationDataset deletes the specified conversation dataset.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: DeleteConversationDatasetOperationMetadata

response: An Empty message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationDatasetsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteConversationDatasetRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#DeleteConversationDatasetRequest.
	}
	op, err := c.DeleteConversationDataset(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*ConversationDatasetsClient) DeleteConversationDatasetOperation

func (c *ConversationDatasetsClient) DeleteConversationDatasetOperation(name string) *DeleteConversationDatasetOperation

DeleteConversationDatasetOperation returns a new DeleteConversationDatasetOperation from a given name. The name must be that of a previously created DeleteConversationDatasetOperation, possibly from a different process.

func (*ConversationDatasetsClient) GetConversationDataset

GetConversationDataset retrieves the specified conversation dataset.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationDatasetsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetConversationDatasetRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetConversationDatasetRequest.
	}
	resp, err := c.GetConversationDataset(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationDatasetsClient) ImportConversationData

ImportConversationData import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: ImportConversationDataOperationMetadata

response: ImportConversationDataOperationResponse

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationDatasetsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ImportConversationDataRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ImportConversationDataRequest.
	}
	op, err := c.ImportConversationData(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationDatasetsClient) ImportConversationDataOperation

func (c *ConversationDatasetsClient) ImportConversationDataOperation(name string) *ImportConversationDataOperation

ImportConversationDataOperation returns a new ImportConversationDataOperation from a given name. The name must be that of a previously created ImportConversationDataOperation, possibly from a different process.

func (*ConversationDatasetsClient) ListConversationDatasets

ListConversationDatasets returns the list of all conversation datasets in the specified project and location.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationDatasetsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListConversationDatasetsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ListConversationDatasetsRequest.
	}
	it := c.ListConversationDatasets(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

ConversationIterator

type ConversationIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.Conversation, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ConversationIterator manages a stream of *dialogflowpb.Conversation.

func (*ConversationIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ConversationIterator) PageInfo

func (it *ConversationIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

ConversationModelEvaluationIterator

type ConversationModelEvaluationIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.ConversationModelEvaluation, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ConversationModelEvaluationIterator manages a stream of *dialogflowpb.ConversationModelEvaluation.

func (*ConversationModelEvaluationIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ConversationModelEvaluationIterator) PageInfo

func (it *ConversationModelEvaluationIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

ConversationModelIterator

type ConversationModelIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.ConversationModel, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ConversationModelIterator manages a stream of *dialogflowpb.ConversationModel.

func (*ConversationModelIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ConversationModelIterator) PageInfo

func (it *ConversationModelIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

ConversationModelsCallOptions

type ConversationModelsCallOptions struct {
	CreateConversationModel           []gax.CallOption
	GetConversationModel              []gax.CallOption
	ListConversationModels            []gax.CallOption
	DeleteConversationModel           []gax.CallOption
	DeployConversationModel           []gax.CallOption
	UndeployConversationModel         []gax.CallOption
	GetConversationModelEvaluation    []gax.CallOption
	ListConversationModelEvaluations  []gax.CallOption
	CreateConversationModelEvaluation []gax.CallOption
}

ConversationModelsCallOptions contains the retry settings for each method of ConversationModelsClient.

ConversationModelsClient

type ConversationModelsClient struct {

	// The call options for this service.
	CallOptions *ConversationModelsCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

ConversationModelsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Manages a collection of models for human agent assistant.

func NewConversationModelsClient

func NewConversationModelsClient(ctx context.Context, opts ...option.ClientOption) (*ConversationModelsClient, error)

NewConversationModelsClient creates a new conversation models client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Manages a collection of models for human agent assistant.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*ConversationModelsClient) Close

func (c *ConversationModelsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ConversationModelsClient) Connection

func (c *ConversationModelsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ConversationModelsClient) CreateConversationModel

CreateConversationModel creates a model.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: CreateConversationModelOperationMetadata

response: ConversationModel

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateConversationModelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#CreateConversationModelRequest.
	}
	op, err := c.CreateConversationModel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationModelsClient) CreateConversationModelEvaluation

CreateConversationModelEvaluation creates evaluation of a conversation model.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateConversationModelEvaluationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#CreateConversationModelEvaluationRequest.
	}
	op, err := c.CreateConversationModelEvaluation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationModelsClient) CreateConversationModelEvaluationOperation

func (c *ConversationModelsClient) CreateConversationModelEvaluationOperation(name string) *CreateConversationModelEvaluationOperation

CreateConversationModelEvaluationOperation returns a new CreateConversationModelEvaluationOperation from a given name. The name must be that of a previously created CreateConversationModelEvaluationOperation, possibly from a different process.

func (*ConversationModelsClient) CreateConversationModelOperation

func (c *ConversationModelsClient) CreateConversationModelOperation(name string) *CreateConversationModelOperation

CreateConversationModelOperation returns a new CreateConversationModelOperation from a given name. The name must be that of a previously created CreateConversationModelOperation, possibly from a different process.

func (*ConversationModelsClient) DeleteConversationModel

DeleteConversationModel deletes a model.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: DeleteConversationModelOperationMetadata

response: An Empty message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteConversationModelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#DeleteConversationModelRequest.
	}
	op, err := c.DeleteConversationModel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*ConversationModelsClient) DeleteConversationModelOperation

func (c *ConversationModelsClient) DeleteConversationModelOperation(name string) *DeleteConversationModelOperation

DeleteConversationModelOperation returns a new DeleteConversationModelOperation from a given name. The name must be that of a previously created DeleteConversationModelOperation, possibly from a different process.

func (*ConversationModelsClient) DeployConversationModel

DeployConversationModel deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: DeployConversationModelOperationMetadata

response: An Empty message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeployConversationModelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#DeployConversationModelRequest.
	}
	op, err := c.DeployConversationModel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*ConversationModelsClient) DeployConversationModelOperation

func (c *ConversationModelsClient) DeployConversationModelOperation(name string) *DeployConversationModelOperation

DeployConversationModelOperation returns a new DeployConversationModelOperation from a given name. The name must be that of a previously created DeployConversationModelOperation, possibly from a different process.

func (*ConversationModelsClient) GetConversationModel

GetConversationModel gets conversation model.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetConversationModelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetConversationModelRequest.
	}
	resp, err := c.GetConversationModel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationModelsClient) GetConversationModelEvaluation

GetConversationModelEvaluation gets an evaluation of conversation model.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetConversationModelEvaluationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetConversationModelEvaluationRequest.
	}
	resp, err := c.GetConversationModelEvaluation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationModelsClient) ListConversationModelEvaluations

ListConversationModelEvaluations lists evaluations of a conversation model.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListConversationModelEvaluationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ListConversationModelEvaluationsRequest.
	}
	it := c.ListConversationModelEvaluations(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*ConversationModelsClient) ListConversationModels

ListConversationModels lists conversation models.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListConversationModelsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ListConversationModelsRequest.
	}
	it := c.ListConversationModels(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*ConversationModelsClient) UndeployConversationModel

UndeployConversationModel undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used:

For article suggestion, article suggestion will fallback to the default model if model is undeployed.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: UndeployConversationModelOperationMetadata

response: An Empty message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationModelsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UndeployConversationModelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#UndeployConversationModelRequest.
	}
	op, err := c.UndeployConversationModel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*ConversationModelsClient) UndeployConversationModelOperation

func (c *ConversationModelsClient) UndeployConversationModelOperation(name string) *UndeployConversationModelOperation

UndeployConversationModelOperation returns a new UndeployConversationModelOperation from a given name. The name must be that of a previously created UndeployConversationModelOperation, possibly from a different process.

ConversationProfileIterator

type ConversationProfileIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.ConversationProfile, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ConversationProfileIterator manages a stream of *dialogflowpb.ConversationProfile.

func (*ConversationProfileIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ConversationProfileIterator) PageInfo

func (it *ConversationProfileIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

ConversationProfilesCallOptions

type ConversationProfilesCallOptions struct {
	ListConversationProfiles     []gax.CallOption
	GetConversationProfile       []gax.CallOption
	CreateConversationProfile    []gax.CallOption
	UpdateConversationProfile    []gax.CallOption
	DeleteConversationProfile    []gax.CallOption
	SetSuggestionFeatureConfig   []gax.CallOption
	ClearSuggestionFeatureConfig []gax.CallOption
}

ConversationProfilesCallOptions contains the retry settings for each method of ConversationProfilesClient.

ConversationProfilesClient

type ConversationProfilesClient struct {

	// The call options for this service.
	CallOptions *ConversationProfilesCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

ConversationProfilesClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing ConversationProfiles.

func NewConversationProfilesClient

func NewConversationProfilesClient(ctx context.Context, opts ...option.ClientOption) (*ConversationProfilesClient, error)

NewConversationProfilesClient creates a new conversation profiles client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing ConversationProfiles.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationProfilesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*ConversationProfilesClient) ClearSuggestionFeatureConfig

ClearSuggestionFeatureConfig clears a suggestion feature from a conversation profile for the given participant role.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: ClearSuggestionFeatureConfigOperationMetadata

response: ConversationProfile

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationProfilesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ClearSuggestionFeatureConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ClearSuggestionFeatureConfigRequest.
	}
	op, err := c.ClearSuggestionFeatureConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationProfilesClient) ClearSuggestionFeatureConfigOperation

func (c *ConversationProfilesClient) ClearSuggestionFeatureConfigOperation(name string) *ClearSuggestionFeatureConfigOperation

ClearSuggestionFeatureConfigOperation returns a new ClearSuggestionFeatureConfigOperation from a given name. The name must be that of a previously created ClearSuggestionFeatureConfigOperation, possibly from a different process.

func (*ConversationProfilesClient) Close

func (c *ConversationProfilesClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ConversationProfilesClient) Connection

func (c *ConversationProfilesClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ConversationProfilesClient) CreateConversationProfile

CreateConversationProfile creates a conversation profile in the specified project.

ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren’t populated in the response. You can retrieve them via GetConversationProfile API.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationProfilesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateConversationProfileRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#CreateConversationProfileRequest.
	}
	resp, err := c.CreateConversationProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationProfilesClient) DeleteConversationProfile

DeleteConversationProfile deletes the specified conversation profile.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationProfilesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteConversationProfileRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#DeleteConversationProfileRequest.
	}
	err = c.DeleteConversationProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*ConversationProfilesClient) GetConversationProfile

GetConversationProfile retrieves the specified conversation profile.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationProfilesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetConversationProfileRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetConversationProfileRequest.
	}
	resp, err := c.GetConversationProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationProfilesClient) ListConversationProfiles

ListConversationProfiles returns the list of all conversation profiles in the specified project.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationProfilesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListConversationProfilesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ListConversationProfilesRequest.
	}
	it := c.ListConversationProfiles(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*ConversationProfilesClient) SetSuggestionFeatureConfig

SetSuggestionFeatureConfig adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

This method is a long-running operation (at https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation type has the following method-specific fields:

metadata: SetSuggestionFeatureConfigOperationMetadata

response: ConversationProfile

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationProfilesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.SetSuggestionFeatureConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#SetSuggestionFeatureConfigRequest.
	}
	op, err := c.SetSuggestionFeatureConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationProfilesClient) SetSuggestionFeatureConfigOperation

func (c *ConversationProfilesClient) SetSuggestionFeatureConfigOperation(name string) *SetSuggestionFeatureConfigOperation

SetSuggestionFeatureConfigOperation returns a new SetSuggestionFeatureConfigOperation from a given name. The name must be that of a previously created SetSuggestionFeatureConfigOperation, possibly from a different process.

func (*ConversationProfilesClient) UpdateConversationProfile

UpdateConversationProfile updates the specified conversation profile.

ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren’t populated in the response. You can retrieve them via GetConversationProfile API.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationProfilesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateConversationProfileRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#UpdateConversationProfileRequest.
	}
	resp, err := c.UpdateConversationProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

ConversationsCallOptions

type ConversationsCallOptions struct {
	CreateConversation   []gax.CallOption
	ListConversations    []gax.CallOption
	GetConversation      []gax.CallOption
	CompleteConversation []gax.CallOption
	ListMessages         []gax.CallOption
}

ConversationsCallOptions contains the retry settings for each method of ConversationsClient.

ConversationsClient

type ConversationsClient struct {

	// The call options for this service.
	CallOptions *ConversationsCallOptions
	// contains filtered or unexported fields
}

ConversationsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing Conversations.

func NewConversationsClient

func NewConversationsClient(ctx context.Context, opts ...option.ClientOption) (*ConversationsClient, error)

NewConversationsClient creates a new conversations client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing Conversations.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*ConversationsClient) Close

func (c *ConversationsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ConversationsClient) CompleteConversation

CompleteConversation completes the specified conversation. Finished conversations are purged from the database after 30 days.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CompleteConversationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#CompleteConversationRequest.
	}
	resp, err := c.CompleteConversation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationsClient) Connection

func (c *ConversationsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ConversationsClient) CreateConversation

CreateConversation creates a new conversation. Conversations are auto-completed after 24 hours.

Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.

For Automated Agent Stage, there will be a dialogflow agent responding to user queries.

For Assist Stage, there’s no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.

If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateConversationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#CreateConversationRequest.
	}
	resp, err := c.CreateConversation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationsClient) GetConversation

GetConversation retrieves the specific conversation.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetConversationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetConversationRequest.
	}
	resp, err := c.GetConversation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ConversationsClient) ListConversations

ListConversations returns the list of all conversations in the specified project.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListConversationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ListConversationsRequest.
	}
	it := c.ListConversations(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*ConversationsClient) ListMessages

ListMessages lists messages that belong to a given conversation. messages are ordered by create_time in descending order. To fetch updates without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
	"google.golang.org/api/iterator"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewConversationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListMessagesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ListMessagesRequest.
	}
	it := c.ListMessages(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

CreateConversationDatasetOperation

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

CreateConversationDatasetOperation manages a long-running operation from CreateConversationDataset.

func (*CreateConversationDatasetOperation) Done

Done reports whether the long-running operation has completed.

func (*CreateConversationDatasetOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateConversationDatasetOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateConversationDatasetOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateConversationDatasetOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

CreateConversationModelEvaluationOperation

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

CreateConversationModelEvaluationOperation manages a long-running operation from CreateConversationModelEvaluation.

func (*CreateConversationModelEvaluationOperation) Done

Done reports whether the long-running operation has completed.

func (*CreateConversationModelEvaluationOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateConversationModelEvaluationOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateConversationModelEvaluationOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateConversationModelEvaluationOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

CreateConversationModelOperation

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

CreateConversationModelOperation manages a long-running operation from CreateConversationModel.

func (*CreateConversationModelOperation) Done

Done reports whether the long-running operation has completed.

func (*CreateConversationModelOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateConversationModelOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateConversationModelOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateConversationModelOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

CreateDocumentOperation

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

CreateDocumentOperation manages a long-running operation from CreateDocument.

func (*CreateDocumentOperation) Done

func (op *CreateDocumentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateDocumentOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateDocumentOperation) Name

func (op *CreateDocumentOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateDocumentOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateDocumentOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteConversationDatasetOperation

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

DeleteConversationDatasetOperation manages a long-running operation from DeleteConversationDataset.

func (*DeleteConversationDatasetOperation) Done

Done reports whether the long-running operation has completed.

func (*DeleteConversationDatasetOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteConversationDatasetOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteConversationDatasetOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteConversationDatasetOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteConversationModelOperation

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

DeleteConversationModelOperation manages a long-running operation from DeleteConversationModel.

func (*DeleteConversationModelOperation) Done

Done reports whether the long-running operation has completed.

func (*DeleteConversationModelOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteConversationModelOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteConversationModelOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteConversationModelOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteDocumentOperation

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

DeleteDocumentOperation manages a long-running operation from DeleteDocument.

func (*DeleteDocumentOperation) Done

func (op *DeleteDocumentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteDocumentOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteDocumentOperation) Name

func (op *DeleteDocumentOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteDocumentOperation) Poll

func (op *DeleteDocumentOperation) Poll(ctx context.Context, opts ...gax.CallOption) error

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteDocumentOperation) Wait

func (op *DeleteDocumentOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeployConversationModelOperation

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

DeployConversationModelOperation manages a long-running operation from DeployConversationModel.

func (*DeployConversationModelOperation) Done

Done reports whether the long-running operation has completed.

func (*DeployConversationModelOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeployConversationModelOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeployConversationModelOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeployConversationModelOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DocumentIterator

type DocumentIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*dialogflowpb.Document, nextPageToken string, err error)
	// contains filtered or unexported fields
}

DocumentIterator manages a stream of *dialogflowpb.Document.

func (*DocumentIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*DocumentIterator) PageInfo

func (it *DocumentIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

DocumentsCallOptions

type DocumentsCallOptions struct {
	ListDocuments   []gax.CallOption
	GetDocument     []gax.CallOption
	CreateDocument  []gax.CallOption
	ImportDocuments []gax.CallOption
	DeleteDocument  []gax.CallOption
	UpdateDocument  []gax.CallOption
	ReloadDocument  []gax.CallOption
	ExportDocument  []gax.CallOption
}

DocumentsCallOptions contains the retry settings for each method of DocumentsClient.

DocumentsClient

type DocumentsClient struct {

	// The call options for this service.
	CallOptions *DocumentsCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

DocumentsClient is a client for interacting with Dialogflow API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for managing knowledge Documents.

func NewDocumentsClient

func NewDocumentsClient(ctx context.Context, opts ...option.ClientOption) (*DocumentsClient, error)

NewDocumentsClient creates a new documents client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for managing knowledge Documents.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewDocumentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*DocumentsClient) Close

func (c *DocumentsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*DocumentsClient) Connection

func (c *DocumentsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*DocumentsClient) CreateDocument

CreateDocument creates a new document.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata

response: Document

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewDocumentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateDocumentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#CreateDocumentRequest.
	}
	op, err := c.CreateDocument(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*DocumentsClient) CreateDocumentOperation

func (c *DocumentsClient) CreateDocumentOperation(name string) *CreateDocumentOperation

CreateDocumentOperation returns a new CreateDocumentOperation from a given name. The name must be that of a previously created CreateDocumentOperation, possibly from a different process.

func (*DocumentsClient) DeleteDocument

DeleteDocument deletes the specified document.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata

response: An Empty message (at https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewDocumentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteDocumentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#DeleteDocumentRequest.
	}
	op, err := c.DeleteDocument(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*DocumentsClient) DeleteDocumentOperation

func (c *DocumentsClient) DeleteDocumentOperation(name string) *DeleteDocumentOperation

DeleteDocumentOperation returns a new DeleteDocumentOperation from a given name. The name must be that of a previously created DeleteDocumentOperation, possibly from a different process.

func (*DocumentsClient) ExportDocument

ExportDocument exports a smart messaging candidate document into the specified destination.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata

response: Document

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewDocumentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ExportDocumentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ExportDocumentRequest.
	}
	op, err := c.ExportDocument(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*DocumentsClient) ExportDocumentOperation

func (c *DocumentsClient) ExportDocumentOperation(name string) *ExportDocumentOperation

ExportDocumentOperation returns a new ExportDocumentOperation from a given name. The name must be that of a previously created ExportDocumentOperation, possibly from a different process.

func (*DocumentsClient) GetDocument

GetDocument retrieves the specified document.

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewDocumentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetDocumentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#GetDocumentRequest.
	}
	resp, err := c.GetDocument(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*DocumentsClient) ImportDocuments

ImportDocuments creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.

This method is a long-running operation (at https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata

response: ImportDocumentsResponse

Example

package main

import (
	"context"

	dialogflow "cloud.google.com/go/dialogflow/apiv2"

	dialogflowpb "google.golang.org/genproto/googleapis/cloud/dialogflow/v2"
)

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewDocumentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ImportDocumentsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/v2#ImportDocumentsRequest.
	}
	op, err := c.ImportDocuments(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*DocumentsClient) ImportDocumentsOperation

func (c *DocumentsClient) ImportDocumentsOperation(name string) *ImportDocumentsOperation

ImportDocumentsOperation returns a new ImportDocumentsOperation from a given name. The name must be that of a previously created ImportDocumentsOperation, possibly from a different process.

func (*DocumentsClient) ListDocuments

ListDocuments returns the list of all documents of the knowledge base.

Example