chatbot

package
v3.55.0 Latest Latest
Warning

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

 Go to latest Published: Apr 30, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetAgentsAgent 

type GetAgentsAgent struct {
	// The agent id.
	AgentId string `pulumi:"agentId"`
	// Service space signature, which is used when PAAS interface specifies the service space.
	AgentKey string `pulumi:"agentKey"`
	// The name of the agent.
	AgentName string `pulumi:"agentName"`
	// ID of the agent.
	Id string `pulumi:"id"`
}

type GetAgentsAgentArgs 

type GetAgentsAgentArgs struct {
	// The agent id.
	AgentId pulumi.StringInput `pulumi:"agentId"`
	// Service space signature, which is used when PAAS interface specifies the service space.
	AgentKey pulumi.StringInput `pulumi:"agentKey"`
	// The name of the agent.
	AgentName pulumi.StringInput `pulumi:"agentName"`
	// ID of the agent.
	Id pulumi.StringInput `pulumi:"id"`
}

func (GetAgentsAgentArgs) ElementType 

func (GetAgentsAgentArgs) ElementType() reflect.Type

func (GetAgentsAgentArgs) ToGetAgentsAgentOutput 

func (i GetAgentsAgentArgs) ToGetAgentsAgentOutput() GetAgentsAgentOutput

func (GetAgentsAgentArgs) ToGetAgentsAgentOutputWithContext 

func (i GetAgentsAgentArgs) ToGetAgentsAgentOutputWithContext(ctx context.Context) GetAgentsAgentOutput

type GetAgentsAgentArray 

type GetAgentsAgentArray []GetAgentsAgentInput

func (GetAgentsAgentArray) ElementType 

func (GetAgentsAgentArray) ElementType() reflect.Type

func (GetAgentsAgentArray) ToGetAgentsAgentArrayOutput 

func (i GetAgentsAgentArray) ToGetAgentsAgentArrayOutput() GetAgentsAgentArrayOutput

func (GetAgentsAgentArray) ToGetAgentsAgentArrayOutputWithContext 

func (i GetAgentsAgentArray) ToGetAgentsAgentArrayOutputWithContext(ctx context.Context) GetAgentsAgentArrayOutput

type GetAgentsAgentArrayInput 

type GetAgentsAgentArrayInput interface {
	pulumi.Input

	ToGetAgentsAgentArrayOutput() GetAgentsAgentArrayOutput
	ToGetAgentsAgentArrayOutputWithContext(context.Context) GetAgentsAgentArrayOutput
}

GetAgentsAgentArrayInput is an input type that accepts GetAgentsAgentArray and GetAgentsAgentArrayOutput values. You can construct a concrete instance of `GetAgentsAgentArrayInput` via: 

GetAgentsAgentArray{ GetAgentsAgentArgs{...} }

type GetAgentsAgentArrayOutput 

type GetAgentsAgentArrayOutput struct{ *pulumi.OutputState }

func (GetAgentsAgentArrayOutput) ElementType 

func (GetAgentsAgentArrayOutput) ElementType() reflect.Type

func (GetAgentsAgentArrayOutput) Index 

func (o GetAgentsAgentArrayOutput) Index(i pulumi.IntInput) GetAgentsAgentOutput

func (GetAgentsAgentArrayOutput) ToGetAgentsAgentArrayOutput 

func (o GetAgentsAgentArrayOutput) ToGetAgentsAgentArrayOutput() GetAgentsAgentArrayOutput

func (GetAgentsAgentArrayOutput) ToGetAgentsAgentArrayOutputWithContext 

func (o GetAgentsAgentArrayOutput) ToGetAgentsAgentArrayOutputWithContext(ctx context.Context) GetAgentsAgentArrayOutput

type GetAgentsAgentInput 

type GetAgentsAgentInput interface {
	pulumi.Input

	ToGetAgentsAgentOutput() GetAgentsAgentOutput
	ToGetAgentsAgentOutputWithContext(context.Context) GetAgentsAgentOutput
}

GetAgentsAgentInput is an input type that accepts GetAgentsAgentArgs and GetAgentsAgentOutput values. You can construct a concrete instance of `GetAgentsAgentInput` via: 

GetAgentsAgentArgs{...}

type GetAgentsAgentOutput 

type GetAgentsAgentOutput struct{ *pulumi.OutputState }

func (GetAgentsAgentOutput) AgentId 

func (o GetAgentsAgentOutput) AgentId() pulumi.StringOutput

The agent id.

func (GetAgentsAgentOutput) AgentKey 

func (o GetAgentsAgentOutput) AgentKey() pulumi.StringOutput

Service space signature, which is used when PAAS interface specifies the service space.

func (GetAgentsAgentOutput) AgentName 

func (o GetAgentsAgentOutput) AgentName() pulumi.StringOutput

The name of the agent.

func (GetAgentsAgentOutput) ElementType 

func (GetAgentsAgentOutput) ElementType() reflect.Type

func (GetAgentsAgentOutput) Id 

func (o GetAgentsAgentOutput) Id() pulumi.StringOutput

ID of the agent.

func (GetAgentsAgentOutput) ToGetAgentsAgentOutput 

func (o GetAgentsAgentOutput) ToGetAgentsAgentOutput() GetAgentsAgentOutput

func (GetAgentsAgentOutput) ToGetAgentsAgentOutputWithContext 

func (o GetAgentsAgentOutput) ToGetAgentsAgentOutputWithContext(ctx context.Context) GetAgentsAgentOutput

type GetAgentsArgs 

type GetAgentsArgs struct {
	// The name of the agent.
	AgentName *string `pulumi:"agentName"`
	// A regex string to filter resulting chatbot agents by name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	PageNumber *int    `pulumi:"pageNumber"`
	PageSize   *int    `pulumi:"pageSize"`
}

A collection of arguments for invoking getAgents.

type GetAgentsOutputArgs 

type GetAgentsOutputArgs struct {
	// The name of the agent.
	AgentName pulumi.StringPtrInput `pulumi:"agentName"`
	// A regex string to filter resulting chatbot agents by name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	PageNumber pulumi.IntPtrInput    `pulumi:"pageNumber"`
	PageSize   pulumi.IntPtrInput    `pulumi:"pageSize"`
}

A collection of arguments for invoking getAgents.

func (GetAgentsOutputArgs) ElementType 

func (GetAgentsOutputArgs) ElementType() reflect.Type

type GetAgentsResult 

type GetAgentsResult struct {
	// The agent Name.
	AgentName string `pulumi:"agentName"`
	// A list of availability zones. Each element contains the following attributes:
	Agents []GetAgentsAgent `pulumi:"agents"`
	// The provider-assigned unique ID for this managed resource.
	Id        string   `pulumi:"id"`
	Ids       []string `pulumi:"ids"`
	NameRegex *string  `pulumi:"nameRegex"`
	// A list of chatbot agents names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	PageNumber *int     `pulumi:"pageNumber"`
	PageSize   *int     `pulumi:"pageSize"`
}

A collection of values returned by getAgents.

func GetAgents 

func GetAgents(ctx *pulumi.Context, args *GetAgentsArgs, opts ...pulumi.InvokeOption) (*GetAgentsResult, error)

This data source provides the Chatbot Agents of the current Alibaba Cloud user.

> **NOTE:** Available in v1.203.0+.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/chatbot"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		nameRegex, err := chatbot.GetAgents(ctx, &chatbot.GetAgentsArgs{
			NameRegex: pulumi.StringRef("^my-Agent"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("alicloudChatbotAgentsId1", nameRegex.Agents[0].Id)
		return nil
	})
}

```

type GetAgentsResultOutput 

type GetAgentsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAgents.

func GetAgentsOutput 

func GetAgentsOutput(ctx *pulumi.Context, args GetAgentsOutputArgs, opts ...pulumi.InvokeOption) GetAgentsResultOutput

func (GetAgentsResultOutput) AgentName 

func (o GetAgentsResultOutput) AgentName() pulumi.StringOutput

The agent Name.

func (GetAgentsResultOutput) Agents 

func (o GetAgentsResultOutput) Agents() GetAgentsAgentArrayOutput

A list of availability zones. Each element contains the following attributes:

func (GetAgentsResultOutput) ElementType 

func (GetAgentsResultOutput) ElementType() reflect.Type

func (GetAgentsResultOutput) Id 

func (o GetAgentsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetAgentsResultOutput) Ids 

func (o GetAgentsResultOutput) Ids() pulumi.StringArrayOutput

func (GetAgentsResultOutput) NameRegex 

func (o GetAgentsResultOutput) NameRegex() pulumi.StringPtrOutput

func (GetAgentsResultOutput) Names 

func (o GetAgentsResultOutput) Names() pulumi.StringArrayOutput

A list of chatbot agents names.

func (GetAgentsResultOutput) OutputFile 

func (o GetAgentsResultOutput) OutputFile() pulumi.StringPtrOutput

func (GetAgentsResultOutput) PageNumber 

func (o GetAgentsResultOutput) PageNumber() pulumi.IntPtrOutput

func (GetAgentsResultOutput) PageSize 

func (o GetAgentsResultOutput) PageSize() pulumi.IntPtrOutput

func (GetAgentsResultOutput) ToGetAgentsResultOutput 

func (o GetAgentsResultOutput) ToGetAgentsResultOutput() GetAgentsResultOutput

func (GetAgentsResultOutput) ToGetAgentsResultOutputWithContext 

func (o GetAgentsResultOutput) ToGetAgentsResultOutputWithContext(ctx context.Context) GetAgentsResultOutput

type PublishTask 

type PublishTask struct {
	pulumi.CustomResourceState

	// The business space key. If you do not set it, the default business space is accessed. The key value is obtained on the business management page of the primary account.
	AgentKey pulumi.StringOutput `pulumi:"agentKey"`
	// The type of the publishing unit. Please use the CreateInstancePublishTask API to publish the robot.
	BizType pulumi.StringOutput `pulumi:"bizType"`
	// UTC time of task creation
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// Additional release information. Currently supported: If the BizType is faq, enter the category Id in this field to indicate that only the knowledge under these categories is published.
	DataIdLists pulumi.StringArrayOutput `pulumi:"dataIdLists"`
	// UTC time for task modification
	ModifyTime pulumi.StringOutput `pulumi:"modifyTime"`
	// The status of the task.
	Status pulumi.StringOutput `pulumi:"status"`
}

Provides a Chatbot Publish Task resource.

For information about Chatbot Publish Task and how to use it, see [What is Publish Task](https://help.aliyun.com/document_detail/433996.html).

> **NOTE:** Available since v1.203.0+.

## Example Usage

Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/chatbot"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := chatbot.GetAgents(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = chatbot.NewPublishTask(ctx, "default", &chatbot.PublishTaskArgs{
			BizType:  pulumi.String("faq"),
			AgentKey: pulumi.String(_default.Agents[0].AgentKey),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Chatbot Publish Task can be imported using the id, e.g.

```sh $ pulumi import alicloud:chatbot/publishTask:PublishTask example <id> ```

func GetPublishTask 

func GetPublishTask(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PublishTaskState, opts ...pulumi.ResourceOption) (*PublishTask, error)

GetPublishTask gets an existing PublishTask resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPublishTask 

func NewPublishTask(ctx *pulumi.Context,
	name string, args *PublishTaskArgs, opts ...pulumi.ResourceOption) (*PublishTask, error)

NewPublishTask registers a new resource with the given unique name, arguments, and options.

func (*PublishTask) ElementType 

func (*PublishTask) ElementType() reflect.Type

func (*PublishTask) ToPublishTaskOutput 

func (i *PublishTask) ToPublishTaskOutput() PublishTaskOutput

func (*PublishTask) ToPublishTaskOutputWithContext 

func (i *PublishTask) ToPublishTaskOutputWithContext(ctx context.Context) PublishTaskOutput

type PublishTaskArgs 

type PublishTaskArgs struct {
	// The business space key. If you do not set it, the default business space is accessed. The key value is obtained on the business management page of the primary account.
	AgentKey pulumi.StringPtrInput
	// The type of the publishing unit. Please use the CreateInstancePublishTask API to publish the robot.
	BizType pulumi.StringInput
	// Additional release information. Currently supported: If the BizType is faq, enter the category Id in this field to indicate that only the knowledge under these categories is published.
	DataIdLists pulumi.StringArrayInput
}

The set of arguments for constructing a PublishTask resource.

func (PublishTaskArgs) ElementType 

func (PublishTaskArgs) ElementType() reflect.Type

type PublishTaskArray 

type PublishTaskArray []PublishTaskInput

func (PublishTaskArray) ElementType 

func (PublishTaskArray) ElementType() reflect.Type

func (PublishTaskArray) ToPublishTaskArrayOutput 

func (i PublishTaskArray) ToPublishTaskArrayOutput() PublishTaskArrayOutput

func (PublishTaskArray) ToPublishTaskArrayOutputWithContext 

func (i PublishTaskArray) ToPublishTaskArrayOutputWithContext(ctx context.Context) PublishTaskArrayOutput

type PublishTaskArrayInput 

type PublishTaskArrayInput interface {
	pulumi.Input

	ToPublishTaskArrayOutput() PublishTaskArrayOutput
	ToPublishTaskArrayOutputWithContext(context.Context) PublishTaskArrayOutput
}

PublishTaskArrayInput is an input type that accepts PublishTaskArray and PublishTaskArrayOutput values. You can construct a concrete instance of `PublishTaskArrayInput` via: 

PublishTaskArray{ PublishTaskArgs{...} }

type PublishTaskArrayOutput 

type PublishTaskArrayOutput struct{ *pulumi.OutputState }

func (PublishTaskArrayOutput) ElementType 

func (PublishTaskArrayOutput) ElementType() reflect.Type

func (PublishTaskArrayOutput) Index 

func (o PublishTaskArrayOutput) Index(i pulumi.IntInput) PublishTaskOutput

func (PublishTaskArrayOutput) ToPublishTaskArrayOutput 

func (o PublishTaskArrayOutput) ToPublishTaskArrayOutput() PublishTaskArrayOutput

func (PublishTaskArrayOutput) ToPublishTaskArrayOutputWithContext 

func (o PublishTaskArrayOutput) ToPublishTaskArrayOutputWithContext(ctx context.Context) PublishTaskArrayOutput

type PublishTaskInput 

type PublishTaskInput interface {
	pulumi.Input

	ToPublishTaskOutput() PublishTaskOutput
	ToPublishTaskOutputWithContext(ctx context.Context) PublishTaskOutput
}

type PublishTaskMap 

type PublishTaskMap map[string]PublishTaskInput

func (PublishTaskMap) ElementType 

func (PublishTaskMap) ElementType() reflect.Type

func (PublishTaskMap) ToPublishTaskMapOutput 

func (i PublishTaskMap) ToPublishTaskMapOutput() PublishTaskMapOutput

func (PublishTaskMap) ToPublishTaskMapOutputWithContext 

func (i PublishTaskMap) ToPublishTaskMapOutputWithContext(ctx context.Context) PublishTaskMapOutput

type PublishTaskMapInput 

type PublishTaskMapInput interface {
	pulumi.Input

	ToPublishTaskMapOutput() PublishTaskMapOutput
	ToPublishTaskMapOutputWithContext(context.Context) PublishTaskMapOutput
}

PublishTaskMapInput is an input type that accepts PublishTaskMap and PublishTaskMapOutput values. You can construct a concrete instance of `PublishTaskMapInput` via: 

PublishTaskMap{ "key": PublishTaskArgs{...} }

type PublishTaskMapOutput 

type PublishTaskMapOutput struct{ *pulumi.OutputState }

func (PublishTaskMapOutput) ElementType 

func (PublishTaskMapOutput) ElementType() reflect.Type

func (PublishTaskMapOutput) MapIndex 

func (o PublishTaskMapOutput) MapIndex(k pulumi.StringInput) PublishTaskOutput

func (PublishTaskMapOutput) ToPublishTaskMapOutput 

func (o PublishTaskMapOutput) ToPublishTaskMapOutput() PublishTaskMapOutput

func (PublishTaskMapOutput) ToPublishTaskMapOutputWithContext 

func (o PublishTaskMapOutput) ToPublishTaskMapOutputWithContext(ctx context.Context) PublishTaskMapOutput

type PublishTaskOutput 

type PublishTaskOutput struct{ *pulumi.OutputState }

func (PublishTaskOutput) AgentKey 

func (o PublishTaskOutput) AgentKey() pulumi.StringOutput

The business space key. If you do not set it, the default business space is accessed. The key value is obtained on the business management page of the primary account.

func (PublishTaskOutput) BizType 

func (o PublishTaskOutput) BizType() pulumi.StringOutput

The type of the publishing unit. Please use the CreateInstancePublishTask API to publish the robot.

func (PublishTaskOutput) CreateTime 

func (o PublishTaskOutput) CreateTime() pulumi.StringOutput

UTC time of task creation

func (PublishTaskOutput) DataIdLists 

func (o PublishTaskOutput) DataIdLists() pulumi.StringArrayOutput

Additional release information. Currently supported: If the BizType is faq, enter the category Id in this field to indicate that only the knowledge under these categories is published.

func (PublishTaskOutput) ElementType 

func (PublishTaskOutput) ElementType() reflect.Type

func (PublishTaskOutput) ModifyTime 

func (o PublishTaskOutput) ModifyTime() pulumi.StringOutput

UTC time for task modification

func (PublishTaskOutput) Status 

func (o PublishTaskOutput) Status() pulumi.StringOutput

The status of the task.

func (PublishTaskOutput) ToPublishTaskOutput 

func (o PublishTaskOutput) ToPublishTaskOutput() PublishTaskOutput

func (PublishTaskOutput) ToPublishTaskOutputWithContext 

func (o PublishTaskOutput) ToPublishTaskOutputWithContext(ctx context.Context) PublishTaskOutput

type PublishTaskState 

type PublishTaskState struct {
	// The business space key. If you do not set it, the default business space is accessed. The key value is obtained on the business management page of the primary account.
	AgentKey pulumi.StringPtrInput
	// The type of the publishing unit. Please use the CreateInstancePublishTask API to publish the robot.
	BizType pulumi.StringPtrInput
	// UTC time of task creation
	CreateTime pulumi.StringPtrInput
	// Additional release information. Currently supported: If the BizType is faq, enter the category Id in this field to indicate that only the knowledge under these categories is published.
	DataIdLists pulumi.StringArrayInput
	// UTC time for task modification
	ModifyTime pulumi.StringPtrInput
	// The status of the task.
	Status pulumi.StringPtrInput
}

func (PublishTaskState) ElementType 

func (PublishTaskState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.