types

package
v1.9.1 Latest Latest
Warning

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

 Go to latest Published: Aug 29, 2022 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AppIntegrationsConfiguration 

type AppIntegrationsConfiguration struct {

	// The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for
	// ingesting content.
	//
	// This member is required.
	AppIntegrationArn *string

	// The fields from the source that are made available to your agents in Wisdom.
	//
	// *
	// For  Salesforce
	// (https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm),
	// you must include at least Id, ArticleNumber, VersionNumber, Title,
	// PublishStatus, and IsDeleted.
	//
	// * For  ServiceNow
	// (https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api),
	// you must include at least number, short_description, sys_mod_count,
	// workflow_state, and active.
	//
	// Make sure to include additional fields. These
	// fields are indexed and used to source recommendations.
	//
	// This member is required.
	ObjectFields []string
	// contains filtered or unexported fields
}

Configuration information for Amazon AppIntegrations to automatically ingest content.

type AssistantAssociationData 

type AssistantAssociationData struct {

	// The Amazon Resource Name (ARN) of the Wisdom assistant.
	//
	// This member is required.
	AssistantArn *string

	// The Amazon Resource Name (ARN) of the assistant association.
	//
	// This member is required.
	AssistantAssociationArn *string

	// The identifier of the assistant association.
	//
	// This member is required.
	AssistantAssociationId *string

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// A union type that currently has a single argument, the knowledge base ID.
	//
	// This member is required.
	AssociationData AssistantAssociationOutputData

	// The type of association.
	//
	// This member is required.
	AssociationType AssociationType

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the assistant association.

type AssistantAssociationInputData 

type AssistantAssociationInputData interface {
	// contains filtered or unexported methods
}

The data that is input into Wisdom as a result of the assistant association.

The following types satisfy this interface: 

AssistantAssociationInputDataMemberKnowledgeBaseId
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.AssistantAssociationInputData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssistantAssociationInputDataMemberKnowledgeBaseId:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AssistantAssociationInputDataMemberKnowledgeBaseId 

type AssistantAssociationInputDataMemberKnowledgeBaseId struct {
	Value string
	// contains filtered or unexported fields
}

The identifier of the knowledge base.

type AssistantAssociationOutputData 

type AssistantAssociationOutputData interface {
	// contains filtered or unexported methods
}

The data that is output as a result of the assistant association.

The following types satisfy this interface: 

AssistantAssociationOutputDataMemberKnowledgeBaseAssociation
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.AssistantAssociationOutputData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssistantAssociationOutputDataMemberKnowledgeBaseAssociation:
		_ = v.Value // Value is types.KnowledgeBaseAssociationData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AssistantAssociationOutputDataMemberKnowledgeBaseAssociation 

type AssistantAssociationOutputDataMemberKnowledgeBaseAssociation struct {
	Value KnowledgeBaseAssociationData
	// contains filtered or unexported fields
}

The knowledge base where output data is sent.

type AssistantAssociationSummary 

type AssistantAssociationSummary struct {

	// The Amazon Resource Name (ARN) of the Wisdom assistant.
	//
	// This member is required.
	AssistantArn *string

	// The Amazon Resource Name (ARN) of the assistant association.
	//
	// This member is required.
	AssistantAssociationArn *string

	// The identifier of the assistant association.
	//
	// This member is required.
	AssistantAssociationId *string

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// The association data.
	//
	// This member is required.
	AssociationData AssistantAssociationOutputData

	// The type of association.
	//
	// This member is required.
	AssociationType AssociationType

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about the assistant association.

type AssistantData 

type AssistantData struct {

	// The Amazon Resource Name (ARN) of the Wisdom assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// The name.
	//
	// This member is required.
	Name *string

	// The status of the assistant.
	//
	// This member is required.
	Status AssistantStatus

	// The type of assistant.
	//
	// This member is required.
	Type AssistantType

	// The description.
	Description *string

	// The KMS key used for encryption.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

The assistant data.

type AssistantStatus 

type AssistantStatus string
const (
	AssistantStatusCreateInProgress AssistantStatus = "CREATE_IN_PROGRESS"
	AssistantStatusCreateFailed     AssistantStatus = "CREATE_FAILED"
	AssistantStatusActive           AssistantStatus = "ACTIVE"
	AssistantStatusDeleteInProgress AssistantStatus = "DELETE_IN_PROGRESS"
	AssistantStatusDeleteFailed     AssistantStatus = "DELETE_FAILED"
	AssistantStatusDeleted          AssistantStatus = "DELETED"
)

Enum values for AssistantStatus

func (AssistantStatus) Values 

func (AssistantStatus) Values() []AssistantStatus

Values returns all known values for AssistantStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssistantSummary 

type AssistantSummary struct {

	// The Amazon Resource Name (ARN) of the Wisdom assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// The name of the assistant.
	//
	// This member is required.
	Name *string

	// The status of the assistant.
	//
	// This member is required.
	Status AssistantStatus

	// The type of the assistant.
	//
	// This member is required.
	Type AssistantType

	// The description of the assistant.
	Description *string

	// The KMS key used for encryption.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about the assistant.

type AssistantType 

type AssistantType string
const (
	AssistantTypeAgent AssistantType = "AGENT"
)

Enum values for AssistantType

func (AssistantType) Values 

func (AssistantType) Values() []AssistantType

Values returns all known values for AssistantType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssociationType 

type AssociationType string
const (
	AssociationTypeKnowledgeBase AssociationType = "KNOWLEDGE_BASE"
)

Enum values for AssociationType

func (AssociationType) Values 

func (AssociationType) Values() []AssociationType

Values returns all known values for AssociationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string
	// contains filtered or unexported fields
}

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ContentData 

type ContentData struct {

	// The Amazon Resource Name (ARN) of the content.
	//
	// This member is required.
	ContentArn *string

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The media type of the content.
	//
	// This member is required.
	ContentType *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// A key/value map to store attributes without affecting tagging or
	// recommendations. For example, when synchronizing data between an external system
	// and Wisdom, you can store an external version identifier as metadata to utilize
	// for determining drift.
	//
	// This member is required.
	Metadata map[string]string

	// The name of the content.
	//
	// This member is required.
	Name *string

	// The identifier of the content revision.
	//
	// This member is required.
	RevisionId *string

	// The status of the content.
	//
	// This member is required.
	Status ContentStatus

	// The title of the content.
	//
	// This member is required.
	Title *string

	// The URL of the content.
	//
	// This member is required.
	Url *string

	// The expiration time of the URL as an epoch timestamp.
	//
	// This member is required.
	UrlExpiry *time.Time

	// The URI of the content.
	LinkOutUri *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the content.

type ContentReference 

type ContentReference struct {

	// The Amazon Resource Name (ARN) of the content.
	ContentArn *string

	// The identifier of the content.
	ContentId *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

Reference information about the content.

type ContentStatus 

type ContentStatus string
const (
	ContentStatusCreateInProgress ContentStatus = "CREATE_IN_PROGRESS"
	ContentStatusCreateFailed     ContentStatus = "CREATE_FAILED"
	ContentStatusActive           ContentStatus = "ACTIVE"
	ContentStatusDeleteInProgress ContentStatus = "DELETE_IN_PROGRESS"
	ContentStatusDeleteFailed     ContentStatus = "DELETE_FAILED"
	ContentStatusDeleted          ContentStatus = "DELETED"
	ContentStatusUpdateFailed     ContentStatus = "UPDATE_FAILED"
)

Enum values for ContentStatus

func (ContentStatus) Values 

func (ContentStatus) Values() []ContentStatus

Values returns all known values for ContentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ContentSummary 

type ContentSummary struct {

	// The Amazon Resource Name (ARN) of the content.
	//
	// This member is required.
	ContentArn *string

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The media type of the content.
	//
	// This member is required.
	ContentType *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// A key/value map to store attributes without affecting tagging or
	// recommendations. For example, when synchronizing data between an external system
	// and Wisdom, you can store an external version identifier as metadata to utilize
	// for determining drift.
	//
	// This member is required.
	Metadata map[string]string

	// The name of the content.
	//
	// This member is required.
	Name *string

	// The identifier of the revision of the content.
	//
	// This member is required.
	RevisionId *string

	// The status of the content.
	//
	// This member is required.
	Status ContentStatus

	// The title of the content.
	//
	// This member is required.
	Title *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about the content.

type Document 

type Document struct {

	// A reference to the content resource.
	//
	// This member is required.
	ContentReference *ContentReference

	// The excerpt from the document.
	Excerpt *DocumentText

	// The title of the document.
	Title *DocumentText
	// contains filtered or unexported fields
}

The document.

type DocumentText 

type DocumentText struct {

	// Highlights in the document text.
	Highlights []Highlight

	// Text in the document.
	Text *string
	// contains filtered or unexported fields
}

The text of the document.

type FeedbackData added in v1.9.0 

type FeedbackData struct {

	// The relevance of the target this feedback is for.
	//
	// This member is required.
	Relevance Relevance
	// contains filtered or unexported fields
}

The feedback to submit to Wisdom.

type Filter 

type Filter struct {

	// The field on which to filter.
	//
	// This member is required.
	Field FilterField

	// The operator to use for comparing the field’s value with the provided value.
	//
	// This member is required.
	Operator FilterOperator

	// The desired field value on which to filter.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A search filter.

type FilterField 

type FilterField string
const (
	FilterFieldName FilterField = "NAME"
)

Enum values for FilterField

func (FilterField) Values 

func (FilterField) Values() []FilterField

Values returns all known values for FilterField. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FilterOperator 

type FilterOperator string
const (
	FilterOperatorEquals FilterOperator = "EQUALS"
)

Enum values for FilterOperator

func (FilterOperator) Values 

func (FilterOperator) Values() []FilterOperator

Values returns all known values for FilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Highlight 

type Highlight struct {

	// The offset for the start of the highlight.
	BeginOffsetInclusive int32

	// The offset for the end of the highlight.
	EndOffsetExclusive int32
	// contains filtered or unexported fields
}

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

type KnowledgeBaseAssociationData 

type KnowledgeBaseAssociationData struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

Association information about the knowledge base.

type KnowledgeBaseData 

type KnowledgeBaseData struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The type of knowledge base.
	//
	// This member is required.
	KnowledgeBaseType KnowledgeBaseType

	// The name of the knowledge base.
	//
	// This member is required.
	Name *string

	// The status of the knowledge base.
	//
	// This member is required.
	Status KnowledgeBaseStatus

	// The description.
	Description *string

	// An epoch timestamp indicating the most recent content modification inside the
	// knowledge base. If no content exists in a knowledge base, this value is unset.
	LastContentModificationTime *time.Time

	// Information about how to render the content.
	RenderingConfiguration *RenderingConfiguration

	// The KMS key used for encryption.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// Source configuration information about the knowledge base.
	SourceConfiguration SourceConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the knowledge base.

type KnowledgeBaseStatus 

type KnowledgeBaseStatus string
const (
	KnowledgeBaseStatusCreateInProgress KnowledgeBaseStatus = "CREATE_IN_PROGRESS"
	KnowledgeBaseStatusCreateFailed     KnowledgeBaseStatus = "CREATE_FAILED"
	KnowledgeBaseStatusActive           KnowledgeBaseStatus = "ACTIVE"
	KnowledgeBaseStatusDeleteInProgress KnowledgeBaseStatus = "DELETE_IN_PROGRESS"
	KnowledgeBaseStatusDeleteFailed     KnowledgeBaseStatus = "DELETE_FAILED"
	KnowledgeBaseStatusDeleted          KnowledgeBaseStatus = "DELETED"
)

Enum values for KnowledgeBaseStatus

func (KnowledgeBaseStatus) Values 

func (KnowledgeBaseStatus) Values() []KnowledgeBaseStatus

Values returns all known values for KnowledgeBaseStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type KnowledgeBaseSummary 

type KnowledgeBaseSummary struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The type of knowledge base.
	//
	// This member is required.
	KnowledgeBaseType KnowledgeBaseType

	// The name of the knowledge base.
	//
	// This member is required.
	Name *string

	// The status of the knowledge base summary.
	//
	// This member is required.
	Status KnowledgeBaseStatus

	// The description of the knowledge base.
	Description *string

	// Information about how to render the content.
	RenderingConfiguration *RenderingConfiguration

	// The KMS key used for encryption.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// Configuration information about the external data source.
	SourceConfiguration SourceConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about the knowledge base.

type KnowledgeBaseType 

type KnowledgeBaseType string
const (
	KnowledgeBaseTypeExternal KnowledgeBaseType = "EXTERNAL"
	KnowledgeBaseTypeCustom   KnowledgeBaseType = "CUSTOM"
)

Enum values for KnowledgeBaseType

func (KnowledgeBaseType) Values 

func (KnowledgeBaseType) Values() []KnowledgeBaseType

Values returns all known values for KnowledgeBaseType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NotifyRecommendationsReceivedError 

type NotifyRecommendationsReceivedError struct {

	// A recommendation is causing an error.
	Message *string

	// The identifier of the recommendation that is in error.
	RecommendationId *string
	// contains filtered or unexported fields
}

An error occurred when creating a recommendation.

type PreconditionFailedException 

type PreconditionFailedException struct {
	Message *string
	// contains filtered or unexported fields
}

The provided revisionId does not match, indicating the content has been modified since it was last read.

func (*PreconditionFailedException) Error 

func (e *PreconditionFailedException) Error() string

func (*PreconditionFailedException) ErrorCode 

func (e *PreconditionFailedException) ErrorCode() string

func (*PreconditionFailedException) ErrorFault 

func (e *PreconditionFailedException) ErrorFault() smithy.ErrorFault

func (*PreconditionFailedException) ErrorMessage 

func (e *PreconditionFailedException) ErrorMessage() string

type QueryRecommendationTriggerData added in v1.8.0 

type QueryRecommendationTriggerData struct {

	// The text associated with the recommendation trigger.
	Text *string
	// contains filtered or unexported fields
}

Data associated with the QUERY RecommendationTriggerType.

type RecommendationData 

type RecommendationData struct {

	// The recommended document.
	//
	// This member is required.
	Document *Document

	// The identifier of the recommendation.
	//
	// This member is required.
	RecommendationId *string

	// The relevance level of the recommendation.
	RelevanceLevel RelevanceLevel

	// The relevance score of the recommendation.
	RelevanceScore float64

	// The type of recommendation.
	Type RecommendationType
	// contains filtered or unexported fields
}

Information about the recommendation.

type RecommendationSourceType added in v1.8.0 

type RecommendationSourceType string
const (
	RecommendationSourceTypeIssueDetection RecommendationSourceType = "ISSUE_DETECTION"
	RecommendationSourceTypeRuleEvaluation RecommendationSourceType = "RULE_EVALUATION"
	RecommendationSourceTypeOther          RecommendationSourceType = "OTHER"
)

Enum values for RecommendationSourceType

func (RecommendationSourceType) Values added in v1.8.0 

func (RecommendationSourceType) Values() []RecommendationSourceType

Values returns all known values for RecommendationSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationTrigger added in v1.8.0 

type RecommendationTrigger struct {

	// A union type containing information related to the trigger.
	//
	// This member is required.
	Data RecommendationTriggerData

	// The identifier of the recommendation trigger.
	//
	// This member is required.
	Id *string

	// The identifiers of the recommendations.
	//
	// This member is required.
	RecommendationIds []string

	// The source of the recommendation trigger.
	//
	// * ISSUE_DETECTION: The corresponding
	// recommendations were triggered by a Contact Lens issue.
	//
	// * RULE_EVALUATION: The
	// corresponding recommendations were triggered by a Contact Lens rule.
	//
	// This member is required.
	Source RecommendationSourceType

	// The type of recommendation trigger.
	//
	// This member is required.
	Type RecommendationTriggerType
	// contains filtered or unexported fields
}

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

type RecommendationTriggerData added in v1.8.0 

type RecommendationTriggerData interface {
	// contains filtered or unexported methods
}

A union type containing information related to the trigger.

The following types satisfy this interface: 

RecommendationTriggerDataMemberQuery
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.RecommendationTriggerData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.RecommendationTriggerDataMemberQuery:
		_ = v.Value // Value is types.QueryRecommendationTriggerData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type RecommendationTriggerDataMemberQuery added in v1.8.0 

type RecommendationTriggerDataMemberQuery struct {
	Value QueryRecommendationTriggerData
	// contains filtered or unexported fields
}

Data associated with the QUERY RecommendationTriggerType.

type RecommendationTriggerType added in v1.8.0 

type RecommendationTriggerType string
const (
	RecommendationTriggerTypeQuery RecommendationTriggerType = "QUERY"
)

Enum values for RecommendationTriggerType

func (RecommendationTriggerType) Values added in v1.8.0 

func (RecommendationTriggerType) Values() []RecommendationTriggerType

Values returns all known values for RecommendationTriggerType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationType added in v1.8.0 

type RecommendationType string
const (
	RecommendationTypeKnowledgeContent RecommendationType = "KNOWLEDGE_CONTENT"
)

Enum values for RecommendationType

func (RecommendationType) Values added in v1.8.0 

func (RecommendationType) Values() []RecommendationType

Values returns all known values for RecommendationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Relevance added in v1.9.0 

type Relevance string
const (
	RelevanceHelpful    Relevance = "HELPFUL"
	RelevanceNotHelpful Relevance = "NOT_HELPFUL"
)

Enum values for Relevance

func (Relevance) Values added in v1.9.0 

func (Relevance) Values() []Relevance

Values returns all known values for Relevance. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RelevanceLevel 

type RelevanceLevel string
const (
	RelevanceLevelHigh   RelevanceLevel = "HIGH"
	RelevanceLevelMedium RelevanceLevel = "MEDIUM"
	RelevanceLevelLow    RelevanceLevel = "LOW"
)

Enum values for RelevanceLevel

func (RelevanceLevel) Values 

func (RelevanceLevel) Values() []RelevanceLevel

Values returns all known values for RelevanceLevel. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RenderingConfiguration 

type RenderingConfiguration struct {

	// A URI template containing exactly one variable in ${variableName} format. This
	// can only be set for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the
	// variable must be one of the following:
	//
	// * Salesforce: Id, ArticleNumber,
	// VersionNumber, Title, PublishStatus, or IsDeleted
	//
	// * ServiceNow: number,
	// short_description, sys_mod_count, workflow_state, or active
	//
	// The variable is
	// replaced with the actual value for a piece of content when calling GetContent
	// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html).
	TemplateUri *string
	// contains filtered or unexported fields
}

Information about how to render the content.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ResourceName *string
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResultData 

type ResultData struct {

	// The document.
	//
	// This member is required.
	Document *Document

	// The identifier of the result data.
	//
	// This member is required.
	ResultId *string

	// The relevance score of the results.
	RelevanceScore float64
	// contains filtered or unexported fields
}

Information about the result.

type SearchExpression 

type SearchExpression struct {

	// The search expression filters.
	//
	// This member is required.
	Filters []Filter
	// contains filtered or unexported fields
}

The search expression.

type ServerSideEncryptionConfiguration 

type ServerSideEncryptionConfiguration struct {

	// The KMS key. For information about valid ID values, see Key identifiers (KeyId)
	// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id).
	KmsKeyId *string
	// contains filtered or unexported fields
}

The KMS key used for encryption.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string
	// contains filtered or unexported fields
}

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SessionData 

type SessionData struct {

	// The name of the session.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the session.
	//
	// This member is required.
	SessionArn *string

	// The identifier of the session.
	//
	// This member is required.
	SessionId *string

	// The description of the session.
	Description *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information about the session.

type SessionSummary 

type SessionSummary struct {

	// The Amazon Resource Name (ARN) of the Wisdom assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// The Amazon Resource Name (ARN) of the session.
	//
	// This member is required.
	SessionArn *string

	// The identifier of the session.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

Summary information about the session.

type SourceConfiguration 

type SourceConfiguration interface {
	// contains filtered or unexported methods
}

Configuration information about the external data source.

The following types satisfy this interface: 

SourceConfigurationMemberAppIntegrations
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.SourceConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SourceConfigurationMemberAppIntegrations:
		_ = v.Value // Value is types.AppIntegrationsConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type SourceConfigurationMemberAppIntegrations 

type SourceConfigurationMemberAppIntegrations struct {
	Value AppIntegrationsConfiguration
	// contains filtered or unexported fields
}

Configuration information for Amazon AppIntegrations to automatically ingest content.

type TargetType added in v1.9.0 

type TargetType string
const (
	TargetTypeRecommendation TargetType = "RECOMMENDATION"
	TargetTypeResult         TargetType = "RESULT"
)

Enum values for TargetType

func (TargetType) Values added in v1.9.0 

func (TargetType) Values() []TargetType

Values returns all known values for TargetType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TooManyTagsException 

type TooManyTagsException struct {
	Message *string

	ResourceName *string
	// contains filtered or unexported fields
}

Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.

func (*TooManyTagsException) Error 

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode 

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault 

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage 

func (e *TooManyTagsException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by a service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

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.