dialogflow

package
v1.42.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 28, 2021 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Overview

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

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

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.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

Types

type 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.

type 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.

type 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
}
Output:

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 added in v1.42.0

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.
	}
	err = c.DeleteAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*AgentsClient) ExportAgent

ExportAgent exports the specified agent to a ZIP file.

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.
	}
	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
}
Output:

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.
	}
	resp, err := c.GetAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*AgentsClient) GetValidationResult added in v1.42.0

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.
	}
	resp, err := c.GetValidationResult(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

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.

An operation which tracks when importing is complete. It only tracks when the draft agent is updated 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.
	}
	op, err := c.ImportAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

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.

An operation which tracks when restoring is complete. It only tracks when the draft agent is updated 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.
	}
	op, err := c.RestoreAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

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.
	}
	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
	}
}
Output:

func (*AgentsClient) SetAgent added in v1.42.0

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.
	}
	resp, err := c.SetAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*AgentsClient) TrainAgent

TrainAgent trains 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.TrainAgentRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.TrainAgent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

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.

type AnswerRecordIterator added in v1.42.0

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 added in v1.42.0

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 added in v1.42.0

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

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

type AnswerRecordsCallOptions added in v1.42.0

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

AnswerRecordsCallOptions contains the retry settings for each method of AnswerRecordsClient.

type AnswerRecordsClient added in v1.42.0

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 added in v1.42.0

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
}
Output:

func (*AnswerRecordsClient) Close added in v1.42.0

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 added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*AnswerRecordsClient) ListAnswerRecords added in v1.42.0

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.
	}
	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
	}
}
Output:

func (*AnswerRecordsClient) UpdateAnswerRecord added in v1.42.0

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.
	}
	resp, err := c.UpdateAnswerRecord(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type 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.

type 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.

type 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.

type 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.

type 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.

type 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.

type 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.

type 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.

type 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.

type 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
}
Output:

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.
	}
	resp, err := c.CreateContext(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

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.
	}
	err = c.DeleteAllContexts(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

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.
	}
	err = c.DeleteContext(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

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.
	}
	resp, err := c.GetContext(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

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.
	}
	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
	}
}
Output:

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.
	}
	resp, err := c.UpdateContext(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type ConversationIterator added in v1.42.0

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 added in v1.42.0

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 added in v1.42.0

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

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

type ConversationProfileIterator added in v1.42.0

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 added in v1.42.0

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 added in v1.42.0

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

type ConversationProfilesCallOptions added in v1.42.0

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

ConversationProfilesCallOptions contains the retry settings for each method of ConversationProfilesClient.

type ConversationProfilesClient added in v1.42.0

type ConversationProfilesClient struct {

	// The call options for this service.
	CallOptions *ConversationProfilesCallOptions
	// 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 added in v1.42.0

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
}
Output:

func (*ConversationProfilesClient) Close added in v1.42.0

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 added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*ConversationProfilesClient) CreateConversationProfile added in v1.42.0

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.
	}
	resp, err := c.CreateConversationProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ConversationProfilesClient) DeleteConversationProfile added in v1.42.0

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.
	}
	err = c.DeleteConversationProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*ConversationProfilesClient) GetConversationProfile added in v1.42.0

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.
	}
	resp, err := c.GetConversationProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ConversationProfilesClient) ListConversationProfiles added in v1.42.0

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.
	}
	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
	}
}
Output:

func (*ConversationProfilesClient) UpdateConversationProfile added in v1.42.0

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.
	}
	resp, err := c.UpdateConversationProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type ConversationsCallOptions added in v1.42.0

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.

type ConversationsClient added in v1.42.0

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 added in v1.42.0

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
}
Output:

func (*ConversationsClient) Close added in v1.42.0

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 added in v1.42.0

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.
	}
	resp, err := c.CompleteConversation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ConversationsClient) Connection added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*ConversationsClient) CreateConversation added in v1.42.0

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.
	}
	resp, err := c.CreateConversation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ConversationsClient) GetConversation added in v1.42.0

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.
	}
	resp, err := c.GetConversation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ConversationsClient) ListConversations added in v1.42.0

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.
	}
	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
	}
}
Output:

func (*ConversationsClient) ListMessages added in v1.42.0

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.
	}
	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
	}
}
Output:

type CreateDocumentOperation added in v1.42.0

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

CreateDocumentOperation manages a long-running operation from CreateDocument.

func (*CreateDocumentOperation) Done added in v1.42.0

func (op *CreateDocumentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateDocumentOperation) Metadata added in v1.42.0

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 added in v1.42.0

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 added in v1.42.0

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 added in v1.42.0

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

See documentation of Poll for error-handling information.

type DeleteDocumentOperation added in v1.42.0

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

DeleteDocumentOperation manages a long-running operation from DeleteDocument.

func (*DeleteDocumentOperation) Done added in v1.42.0

func (op *DeleteDocumentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteDocumentOperation) Metadata added in v1.42.0

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 added in v1.42.0

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 added in v1.42.0

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 added in v1.42.0

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.

type DocumentIterator added in v1.42.0

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 added in v1.42.0

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 added in v1.42.0

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

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

type DocumentsCallOptions added in v1.42.0

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

DocumentsCallOptions contains the retry settings for each method of DocumentsClient.

type DocumentsClient added in v1.42.0

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 added in v1.42.0

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
}
Output:

func (*DocumentsClient) Close added in v1.42.0

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 added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*DocumentsClient) CreateDocument added in v1.42.0

CreateDocument creates a new document.

Operation <response: Document, metadata: KnowledgeOperationMetadata>

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.
	}
	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
}
Output:

func (*DocumentsClient) CreateDocumentOperation added in v1.42.0

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 added in v1.42.0

DeleteDocument deletes the specified document.

Operation <response: google.protobuf.Empty, metadata: KnowledgeOperationMetadata>

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.
	}
	op, err := c.DeleteDocument(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*DocumentsClient) DeleteDocumentOperation added in v1.42.0

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) GetDocument added in v1.42.0

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.
	}
	resp, err := c.GetDocument(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*DocumentsClient) ListDocuments added in v1.42.0

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

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.NewDocumentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListDocumentsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListDocuments(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*DocumentsClient) ReloadDocument added in v1.42.0

ReloadDocument reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Operation <response: Document, metadata: KnowledgeOperationMetadata>

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.ReloadDocumentRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.ReloadDocument(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*DocumentsClient) ReloadDocumentOperation added in v1.42.0

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

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

func (*DocumentsClient) UpdateDocument added in v1.42.0

UpdateDocument updates the specified document.

Operation <response: Document, metadata: KnowledgeOperationMetadata>

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.UpdateDocumentRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.UpdateDocument(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*DocumentsClient) UpdateDocumentOperation added in v1.42.0

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

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

type EntityTypeIterator

type EntityTypeIterator 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.EntityType, nextPageToken string, err error)
	// contains filtered or unexported fields
}

EntityTypeIterator manages a stream of *dialogflowpb.EntityType.

func (*EntityTypeIterator) 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 (*EntityTypeIterator) PageInfo

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

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

type EntityTypesCallOptions

type EntityTypesCallOptions struct {
	ListEntityTypes        []gax.CallOption
	GetEntityType          []gax.CallOption
	CreateEntityType       []gax.CallOption
	UpdateEntityType       []gax.CallOption
	DeleteEntityType       []gax.CallOption
	BatchUpdateEntityTypes []gax.CallOption
	BatchDeleteEntityTypes []gax.CallOption
	BatchCreateEntities    []gax.CallOption
	BatchUpdateEntities    []gax.CallOption
	BatchDeleteEntities    []gax.CallOption
}

EntityTypesCallOptions contains the retry settings for each method of EntityTypesClient.

type EntityTypesClient

type EntityTypesClient struct {

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

	// 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
}

EntityTypesClient 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 EntityTypes.

func NewEntityTypesClient

func NewEntityTypesClient(ctx context.Context, opts ...option.ClientOption) (*EntityTypesClient, error)

NewEntityTypesClient creates a new entity types 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 EntityTypes.

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*EntityTypesClient) BatchCreateEntities

BatchCreateEntities creates multiple new entities in the specified entity type.

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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.BatchCreateEntitiesRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.BatchCreateEntities(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*EntityTypesClient) BatchCreateEntitiesOperation

func (c *EntityTypesClient) BatchCreateEntitiesOperation(name string) *BatchCreateEntitiesOperation

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

func (*EntityTypesClient) BatchDeleteEntities

BatchDeleteEntities deletes entities in the specified entity type.

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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.BatchDeleteEntitiesRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.BatchDeleteEntities(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*EntityTypesClient) BatchDeleteEntitiesOperation

func (c *EntityTypesClient) BatchDeleteEntitiesOperation(name string) *BatchDeleteEntitiesOperation

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

func (*EntityTypesClient) BatchDeleteEntityTypes

BatchDeleteEntityTypes deletes entity types in 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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.BatchDeleteEntityTypesRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.BatchDeleteEntityTypes(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*EntityTypesClient) BatchDeleteEntityTypesOperation

func (c *EntityTypesClient) BatchDeleteEntityTypesOperation(name string) *BatchDeleteEntityTypesOperation

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

func (*EntityTypesClient) BatchUpdateEntities

BatchUpdateEntities updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren’t explicitly specified in the request.

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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.BatchUpdateEntitiesRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.BatchUpdateEntities(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*EntityTypesClient) BatchUpdateEntitiesOperation

func (c *EntityTypesClient) BatchUpdateEntitiesOperation(name string) *BatchUpdateEntitiesOperation

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

func (*EntityTypesClient) BatchUpdateEntityTypes

BatchUpdateEntityTypes updates/Creates multiple entity types in 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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.BatchUpdateEntityTypesRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.BatchUpdateEntityTypes(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*EntityTypesClient) BatchUpdateEntityTypesOperation

func (c *EntityTypesClient) BatchUpdateEntityTypesOperation(name string) *BatchUpdateEntityTypesOperation

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

func (*EntityTypesClient) Close

func (c *EntityTypesClient) Close() error

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

func (*EntityTypesClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*EntityTypesClient) CreateEntityType

CreateEntityType creates an entity type in 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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateEntityTypeRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.CreateEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EntityTypesClient) DeleteEntityType

func (c *EntityTypesClient) DeleteEntityType(ctx context.Context, req *dialogflowpb.DeleteEntityTypeRequest, opts ...gax.CallOption) error

DeleteEntityType deletes the specified entity type.

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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteEntityTypeRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*EntityTypesClient) GetEntityType

GetEntityType retrieves the specified entity type.

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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetEntityTypeRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EntityTypesClient) ListEntityTypes

ListEntityTypes returns the list of all entity types in the specified agent.

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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListEntityTypesRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListEntityTypes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*EntityTypesClient) UpdateEntityType

UpdateEntityType updates the specified entity type.

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.NewEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateEntityTypeRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.UpdateEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type EnvironmentHistory_EntryIterator added in v1.42.0

type EnvironmentHistory_EntryIterator 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.EnvironmentHistory_Entry, nextPageToken string, err error)
	// contains filtered or unexported fields
}

EnvironmentHistory_EntryIterator manages a stream of *dialogflowpb.EnvironmentHistory_Entry.

func (*EnvironmentHistory_EntryIterator) Next added in v1.42.0

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 (*EnvironmentHistory_EntryIterator) PageInfo added in v1.42.0

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

type EnvironmentIterator added in v1.42.0

type EnvironmentIterator 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.Environment, nextPageToken string, err error)
	// contains filtered or unexported fields
}

EnvironmentIterator manages a stream of *dialogflowpb.Environment.

func (*EnvironmentIterator) Next added in v1.42.0

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 (*EnvironmentIterator) PageInfo added in v1.42.0

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

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

type EnvironmentsCallOptions added in v1.42.0

type EnvironmentsCallOptions struct {
	ListEnvironments      []gax.CallOption
	GetEnvironment        []gax.CallOption
	CreateEnvironment     []gax.CallOption
	UpdateEnvironment     []gax.CallOption
	DeleteEnvironment     []gax.CallOption
	GetEnvironmentHistory []gax.CallOption
}

EnvironmentsCallOptions contains the retry settings for each method of EnvironmentsClient.

type EnvironmentsClient added in v1.42.0

type EnvironmentsClient struct {

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

EnvironmentsClient 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 Environments.

func NewEnvironmentsClient added in v1.42.0

func NewEnvironmentsClient(ctx context.Context, opts ...option.ClientOption) (*EnvironmentsClient, error)

NewEnvironmentsClient creates a new environments 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 Environments.

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*EnvironmentsClient) Close added in v1.42.0

func (c *EnvironmentsClient) Close() error

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

func (*EnvironmentsClient) Connection added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*EnvironmentsClient) CreateEnvironment added in v1.42.0

CreateEnvironment creates an agent environment.

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.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateEnvironmentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.CreateEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EnvironmentsClient) DeleteEnvironment added in v1.42.0

DeleteEnvironment deletes the specified agent environment.

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.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteEnvironmentRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*EnvironmentsClient) GetEnvironment added in v1.42.0

GetEnvironment retrieves the specified agent environment.

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.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetEnvironmentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*EnvironmentsClient) GetEnvironmentHistory added in v1.42.0

GetEnvironmentHistory gets the history of the specified environment.

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.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetEnvironmentHistoryRequest{
		// TODO: Fill request struct fields.
	}
	it := c.GetEnvironmentHistory(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*EnvironmentsClient) ListEnvironments added in v1.42.0

ListEnvironments returns the list of all non-draft environments of the specified agent.

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.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListEnvironmentsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListEnvironments(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*EnvironmentsClient) UpdateEnvironment added in v1.42.0

UpdateEnvironment updates the specified agent environment.

This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use “-” as Environment ID in environment name to update version in “draft” environment. WARNING: this will negate all recent changes to draft and can’t be undone. You may want to save the draft to a version before calling this function.

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.NewEnvironmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateEnvironmentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.UpdateEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type ExportAgentOperation

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

ExportAgentOperation manages a long-running operation from ExportAgent.

func (*ExportAgentOperation) Done

func (op *ExportAgentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ExportAgentOperation) Metadata

func (op *ExportAgentOperation) 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 (*ExportAgentOperation) Name

func (op *ExportAgentOperation) 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 (*ExportAgentOperation) 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 (*ExportAgentOperation) 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.

type FulfillmentsCallOptions added in v1.42.0

type FulfillmentsCallOptions struct {
	GetFulfillment    []gax.CallOption
	UpdateFulfillment []gax.CallOption
}

FulfillmentsCallOptions contains the retry settings for each method of FulfillmentsClient.

type FulfillmentsClient added in v1.42.0

type FulfillmentsClient struct {

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

FulfillmentsClient 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 Fulfillments.

func NewFulfillmentsClient added in v1.42.0

func NewFulfillmentsClient(ctx context.Context, opts ...option.ClientOption) (*FulfillmentsClient, error)

NewFulfillmentsClient creates a new fulfillments 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 Fulfillments.

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*FulfillmentsClient) Close added in v1.42.0

func (c *FulfillmentsClient) Close() error

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

func (*FulfillmentsClient) Connection added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*FulfillmentsClient) GetFulfillment added in v1.42.0

GetFulfillment retrieves the fulfillment.

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.NewFulfillmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetFulfillmentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetFulfillment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*FulfillmentsClient) UpdateFulfillment added in v1.42.0

UpdateFulfillment updates the fulfillment.

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.NewFulfillmentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateFulfillmentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.UpdateFulfillment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type ImportAgentOperation

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

ImportAgentOperation manages a long-running operation from ImportAgent.

func (*ImportAgentOperation) Done

func (op *ImportAgentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ImportAgentOperation) Metadata

func (op *ImportAgentOperation) 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 (*ImportAgentOperation) Name

func (op *ImportAgentOperation) 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 (*ImportAgentOperation) Poll

func (op *ImportAgentOperation) 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 (*ImportAgentOperation) Wait

func (op *ImportAgentOperation) 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.

type IntentIterator

type IntentIterator 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.Intent, nextPageToken string, err error)
	// contains filtered or unexported fields
}

IntentIterator manages a stream of *dialogflowpb.Intent.

func (*IntentIterator) Next

func (it *IntentIterator) Next() (*dialogflowpb.Intent, 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 (*IntentIterator) PageInfo

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

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

type IntentsCallOptions

type IntentsCallOptions struct {
	ListIntents        []gax.CallOption
	GetIntent          []gax.CallOption
	CreateIntent       []gax.CallOption
	UpdateIntent       []gax.CallOption
	DeleteIntent       []gax.CallOption
	BatchUpdateIntents []gax.CallOption
	BatchDeleteIntents []gax.CallOption
}

IntentsCallOptions contains the retry settings for each method of IntentsClient.

type IntentsClient

type IntentsClient struct {

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

	// 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
}

IntentsClient 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 Intents.

func NewIntentsClient

func NewIntentsClient(ctx context.Context, opts ...option.ClientOption) (*IntentsClient, error)

NewIntentsClient creates a new intents 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 Intents.

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*IntentsClient) BatchDeleteIntents

BatchDeleteIntents deletes intents in 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.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.BatchDeleteIntentsRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.BatchDeleteIntents(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*IntentsClient) BatchDeleteIntentsOperation

func (c *IntentsClient) BatchDeleteIntentsOperation(name string) *BatchDeleteIntentsOperation

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

func (*IntentsClient) BatchUpdateIntents

BatchUpdateIntents updates/Creates multiple intents in 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.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.BatchUpdateIntentsRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.BatchUpdateIntents(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*IntentsClient) BatchUpdateIntentsOperation

func (c *IntentsClient) BatchUpdateIntentsOperation(name string) *BatchUpdateIntentsOperation

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

func (*IntentsClient) Close

func (c *IntentsClient) Close() error

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

func (*IntentsClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*IntentsClient) CreateIntent

CreateIntent creates an intent in 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.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateIntentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.CreateIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*IntentsClient) DeleteIntent

func (c *IntentsClient) DeleteIntent(ctx context.Context, req *dialogflowpb.DeleteIntentRequest, opts ...gax.CallOption) error

DeleteIntent deletes the specified intent and its direct or indirect followup intents.

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.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteIntentRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*IntentsClient) GetIntent

GetIntent retrieves the specified intent.

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.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetIntentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*IntentsClient) ListIntents

ListIntents returns the list of all intents in the specified agent.

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.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListIntentsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListIntents(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*IntentsClient) UpdateIntent

UpdateIntent updates the specified intent.

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.NewIntentsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateIntentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.UpdateIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type KnowledgeBaseIterator added in v1.42.0

type KnowledgeBaseIterator 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.KnowledgeBase, nextPageToken string, err error)
	// contains filtered or unexported fields
}

KnowledgeBaseIterator manages a stream of *dialogflowpb.KnowledgeBase.

func (*KnowledgeBaseIterator) Next added in v1.42.0

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 (*KnowledgeBaseIterator) PageInfo added in v1.42.0

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

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

type KnowledgeBasesCallOptions added in v1.42.0

type KnowledgeBasesCallOptions struct {
	ListKnowledgeBases  []gax.CallOption
	GetKnowledgeBase    []gax.CallOption
	CreateKnowledgeBase []gax.CallOption
	DeleteKnowledgeBase []gax.CallOption
	UpdateKnowledgeBase []gax.CallOption
}

KnowledgeBasesCallOptions contains the retry settings for each method of KnowledgeBasesClient.

type KnowledgeBasesClient added in v1.42.0

type KnowledgeBasesClient struct {

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

KnowledgeBasesClient 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 KnowledgeBases.

func NewKnowledgeBasesClient added in v1.42.0

func NewKnowledgeBasesClient(ctx context.Context, opts ...option.ClientOption) (*KnowledgeBasesClient, error)

NewKnowledgeBasesClient creates a new knowledge bases 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 KnowledgeBases.

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*KnowledgeBasesClient) Close added in v1.42.0

func (c *KnowledgeBasesClient) Close() error

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

func (*KnowledgeBasesClient) Connection added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*KnowledgeBasesClient) CreateKnowledgeBase added in v1.42.0

CreateKnowledgeBase creates a knowledge base.

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.NewKnowledgeBasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateKnowledgeBaseRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.CreateKnowledgeBase(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*KnowledgeBasesClient) DeleteKnowledgeBase added in v1.42.0

DeleteKnowledgeBase deletes the specified knowledge base.

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.NewKnowledgeBasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteKnowledgeBaseRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteKnowledgeBase(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*KnowledgeBasesClient) GetKnowledgeBase added in v1.42.0

GetKnowledgeBase retrieves the specified knowledge base.

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.NewKnowledgeBasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetKnowledgeBaseRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetKnowledgeBase(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*KnowledgeBasesClient) ListKnowledgeBases added in v1.42.0

ListKnowledgeBases returns the list of all knowledge bases of the specified agent.

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.NewKnowledgeBasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListKnowledgeBasesRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListKnowledgeBases(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*KnowledgeBasesClient) UpdateKnowledgeBase added in v1.42.0

UpdateKnowledgeBase updates the specified knowledge base.

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.NewKnowledgeBasesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateKnowledgeBaseRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.UpdateKnowledgeBase(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type MessageIterator added in v1.42.0

type MessageIterator 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.Message, nextPageToken string, err error)
	// contains filtered or unexported fields
}

MessageIterator manages a stream of *dialogflowpb.Message.

func (*MessageIterator) Next added in v1.42.0

func (it *MessageIterator) Next() (*dialogflowpb.Message, 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 (*MessageIterator) PageInfo added in v1.42.0

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

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

type ParticipantIterator added in v1.42.0

type ParticipantIterator 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.Participant, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ParticipantIterator manages a stream of *dialogflowpb.Participant.

func (*ParticipantIterator) Next added in v1.42.0

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 (*ParticipantIterator) PageInfo added in v1.42.0

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

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

type ParticipantsCallOptions added in v1.42.0

type ParticipantsCallOptions struct {
	CreateParticipant []gax.CallOption
	GetParticipant    []gax.CallOption
	ListParticipants  []gax.CallOption
	UpdateParticipant []gax.CallOption
	AnalyzeContent    []gax.CallOption
	SuggestArticles   []gax.CallOption
	SuggestFaqAnswers []gax.CallOption
}

ParticipantsCallOptions contains the retry settings for each method of ParticipantsClient.

type ParticipantsClient added in v1.42.0

type ParticipantsClient struct {

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

ParticipantsClient 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 Participants.

func NewParticipantsClient added in v1.42.0

func NewParticipantsClient(ctx context.Context, opts ...option.ClientOption) (*ParticipantsClient, error)

NewParticipantsClient creates a new participants 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 Participants.

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*ParticipantsClient) AnalyzeContent added in v1.42.0

AnalyzeContent adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments (at https://cloud.google.com/dialogflow/es/docs/agents-versions).

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.NewParticipantsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.AnalyzeContentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.AnalyzeContent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ParticipantsClient) Close added in v1.42.0

func (c *ParticipantsClient) Close() error

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

func (*ParticipantsClient) Connection added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*ParticipantsClient) CreateParticipant added in v1.42.0

CreateParticipant creates a new participant in a 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.NewParticipantsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateParticipantRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.CreateParticipant(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ParticipantsClient) GetParticipant added in v1.42.0

GetParticipant retrieves a conversation participant.

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.NewParticipantsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetParticipantRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetParticipant(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ParticipantsClient) ListParticipants added in v1.42.0

ListParticipants returns the list of all participants in the specified conversation.

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.NewParticipantsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListParticipantsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListParticipants(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*ParticipantsClient) SuggestArticles added in v1.42.0

SuggestArticles gets suggested articles for a participant based on specific historical messages.

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.NewParticipantsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.SuggestArticlesRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.SuggestArticles(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ParticipantsClient) SuggestFaqAnswers added in v1.42.0

SuggestFaqAnswers gets suggested faq answers for a participant based on specific historical messages.

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.NewParticipantsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.SuggestFaqAnswersRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.SuggestFaqAnswers(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*ParticipantsClient) UpdateParticipant added in v1.42.0

UpdateParticipant updates the specified participant.

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.NewParticipantsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateParticipantRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.UpdateParticipant(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type ReloadDocumentOperation added in v1.42.0

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

ReloadDocumentOperation manages a long-running operation from ReloadDocument.

func (*ReloadDocumentOperation) Done added in v1.42.0

func (op *ReloadDocumentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ReloadDocumentOperation) Metadata added in v1.42.0

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 (*ReloadDocumentOperation) Name added in v1.42.0

func (op *ReloadDocumentOperation) 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 (*ReloadDocumentOperation) Poll added in v1.42.0

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 (*ReloadDocumentOperation) Wait added in v1.42.0

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

See documentation of Poll for error-handling information.

type RestoreAgentOperation

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

RestoreAgentOperation manages a long-running operation from RestoreAgent.

func (*RestoreAgentOperation) Done

func (op *RestoreAgentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RestoreAgentOperation) Metadata

func (op *RestoreAgentOperation) 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 (*RestoreAgentOperation) Name

func (op *RestoreAgentOperation) 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 (*RestoreAgentOperation) Poll

func (op *RestoreAgentOperation) 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 (*RestoreAgentOperation) Wait

func (op *RestoreAgentOperation) 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.

type SessionEntityTypeIterator

type SessionEntityTypeIterator 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.SessionEntityType, nextPageToken string, err error)
	// contains filtered or unexported fields
}

SessionEntityTypeIterator manages a stream of *dialogflowpb.SessionEntityType.

func (*SessionEntityTypeIterator) 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 (*SessionEntityTypeIterator) PageInfo

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

type SessionEntityTypesCallOptions

type SessionEntityTypesCallOptions struct {
	ListSessionEntityTypes  []gax.CallOption
	GetSessionEntityType    []gax.CallOption
	CreateSessionEntityType []gax.CallOption
	UpdateSessionEntityType []gax.CallOption
	DeleteSessionEntityType []gax.CallOption
}

SessionEntityTypesCallOptions contains the retry settings for each method of SessionEntityTypesClient.

type SessionEntityTypesClient

type SessionEntityTypesClient struct {

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

SessionEntityTypesClient 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 SessionEntityTypes.

func NewSessionEntityTypesClient

func NewSessionEntityTypesClient(ctx context.Context, opts ...option.ClientOption) (*SessionEntityTypesClient, error)

NewSessionEntityTypesClient creates a new session entity types 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 SessionEntityTypes.

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*SessionEntityTypesClient) Close

func (c *SessionEntityTypesClient) Close() error

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

func (*SessionEntityTypesClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*SessionEntityTypesClient) CreateSessionEntityType

CreateSessionEntityType creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateSessionEntityTypeRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.CreateSessionEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SessionEntityTypesClient) DeleteSessionEntityType

DeleteSessionEntityType deletes the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteSessionEntityTypeRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteSessionEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*SessionEntityTypesClient) GetSessionEntityType

GetSessionEntityType retrieves the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetSessionEntityTypeRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetSessionEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SessionEntityTypesClient) ListSessionEntityTypes

ListSessionEntityTypes returns the list of all session entity types in the specified session.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListSessionEntityTypesRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListSessionEntityTypes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*SessionEntityTypesClient) UpdateSessionEntityType

UpdateSessionEntityType updates the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

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.NewSessionEntityTypesClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateSessionEntityTypeRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.UpdateSessionEntityType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type SessionsCallOptions

type SessionsCallOptions struct {
	DetectIntent          []gax.CallOption
	StreamingDetectIntent []gax.CallOption
}

SessionsCallOptions contains the retry settings for each method of SessionsClient.

type SessionsClient

type SessionsClient struct {

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

SessionsClient 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.

A service used for session interactions.

For more information, see the API interactions guide (at https://cloud.google.com/dialogflow/docs/api-overview).

func NewSessionsClient

func NewSessionsClient(ctx context.Context, opts ...option.ClientOption) (*SessionsClient, error)

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

A service used for session interactions.

For more information, see the API interactions guide (at https://cloud.google.com/dialogflow/docs/api-overview).

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*SessionsClient) Close

func (c *SessionsClient) Close() error

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

func (*SessionsClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*SessionsClient) DetectIntent

DetectIntent processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.

Note: Always use agent versions for production traffic. See Versions and environments (at https://cloud.google.com/dialogflow/es/docs/agents-versions).

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.NewSessionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DetectIntentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.DetectIntent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*SessionsClient) StreamingDetectIntent

StreamingDetectIntent processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Note: Always use agent versions for production traffic. See Versions and environments (at https://cloud.google.com/dialogflow/es/docs/agents-versions).

Example
package main

import (
	"context"
	"io"

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

func main() {
	ctx := context.Background()
	c, err := dialogflow.NewSessionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()
	stream, err := c.StreamingDetectIntent(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	go func() {
		reqs := []*dialogflowpb.StreamingDetectIntentRequest{
			// TODO: Create requests.
		}
		for _, req := range reqs {
			if err := stream.Send(req); err != nil {
				// TODO: Handle error.
			}
		}
		stream.CloseSend()
	}()
	for {
		resp, err := stream.Recv()
		if err == io.EOF {
			break
		}
		if err != nil {
			// TODO: handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

type TrainAgentOperation

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

TrainAgentOperation manages a long-running operation from TrainAgent.

func (*TrainAgentOperation) Done

func (op *TrainAgentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*TrainAgentOperation) Metadata

func (op *TrainAgentOperation) 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 (*TrainAgentOperation) Name

func (op *TrainAgentOperation) 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 (*TrainAgentOperation) Poll

func (op *TrainAgentOperation) 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 (*TrainAgentOperation) Wait

func (op *TrainAgentOperation) 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.

type UpdateDocumentOperation added in v1.42.0

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

UpdateDocumentOperation manages a long-running operation from UpdateDocument.

func (*UpdateDocumentOperation) Done added in v1.42.0

func (op *UpdateDocumentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateDocumentOperation) Metadata added in v1.42.0

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 (*UpdateDocumentOperation) Name added in v1.42.0

func (op *UpdateDocumentOperation) 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 (*UpdateDocumentOperation) Poll added in v1.42.0

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 (*UpdateDocumentOperation) Wait added in v1.42.0

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

See documentation of Poll for error-handling information.

type VersionIterator added in v1.42.0

type VersionIterator 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.Version, nextPageToken string, err error)
	// contains filtered or unexported fields
}

VersionIterator manages a stream of *dialogflowpb.Version.

func (*VersionIterator) Next added in v1.42.0

func (it *VersionIterator) Next() (*dialogflowpb.Version, 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 (*VersionIterator) PageInfo added in v1.42.0

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

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

type VersionsCallOptions added in v1.42.0

type VersionsCallOptions struct {
	ListVersions  []gax.CallOption
	GetVersion    []gax.CallOption
	CreateVersion []gax.CallOption
	UpdateVersion []gax.CallOption
	DeleteVersion []gax.CallOption
}

VersionsCallOptions contains the retry settings for each method of VersionsClient.

type VersionsClient added in v1.42.0

type VersionsClient struct {

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

VersionsClient 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 Versions.

func NewVersionsClient added in v1.42.0

func NewVersionsClient(ctx context.Context, opts ...option.ClientOption) (*VersionsClient, error)

NewVersionsClient creates a new versions 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 Versions.

Example
package main

import (
	"context"

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

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

	// TODO: Use client.
	_ = c
}
Output:

func (*VersionsClient) Close added in v1.42.0

func (c *VersionsClient) Close() error

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

func (*VersionsClient) Connection added in v1.42.0

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

Connection returns a connection to the API service.

Deprecated.

func (*VersionsClient) CreateVersion added in v1.42.0

CreateVersion creates an agent version.

The new version points to the agent instance in the “default” environment.

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.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.CreateVersionRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.CreateVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*VersionsClient) DeleteVersion added in v1.42.0

func (c *VersionsClient) DeleteVersion(ctx context.Context, req *dialogflowpb.DeleteVersionRequest, opts ...gax.CallOption) error

DeleteVersion delete the specified agent version.

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.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.DeleteVersionRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}
Output:

func (*VersionsClient) GetVersion added in v1.42.0

GetVersion retrieves the specified agent version.

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.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.GetVersionRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*VersionsClient) ListVersions added in v1.42.0

ListVersions returns the list of all versions of the specified agent.

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.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.ListVersionsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListVersions(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}
Output:

func (*VersionsClient) UpdateVersion added in v1.42.0

UpdateVersion updates the specified agent version.

Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

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.NewVersionsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dialogflowpb.UpdateVersionRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.UpdateVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL