Documentation
¶
Overview ¶
Package wisdom provides the API client, operations, and parameter types for Amazon Connect Wisdom Service.
All Amazon Connect Wisdom functionality is accessible using the API. For example, you can create an assistant and a knowledge base. Some more advanced features are only accessible using the Wisdom API. For example, you can manually manage content by uploading custom files and control their lifecycle.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func (c *Client) CreateAssistant(ctx context.Context, params *CreateAssistantInput, optFns ...func(*Options)) (*CreateAssistantOutput, error)
- func (c *Client) CreateAssistantAssociation(ctx context.Context, params *CreateAssistantAssociationInput, ...) (*CreateAssistantAssociationOutput, error)
- func (c *Client) CreateContent(ctx context.Context, params *CreateContentInput, optFns ...func(*Options)) (*CreateContentOutput, error)
- func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, ...) (*CreateKnowledgeBaseOutput, error)
- func (c *Client) CreateSession(ctx context.Context, params *CreateSessionInput, optFns ...func(*Options)) (*CreateSessionOutput, error)
- func (c *Client) DeleteAssistant(ctx context.Context, params *DeleteAssistantInput, optFns ...func(*Options)) (*DeleteAssistantOutput, error)
- func (c *Client) DeleteAssistantAssociation(ctx context.Context, params *DeleteAssistantAssociationInput, ...) (*DeleteAssistantAssociationOutput, error)
- func (c *Client) DeleteContent(ctx context.Context, params *DeleteContentInput, optFns ...func(*Options)) (*DeleteContentOutput, error)
- func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, ...) (*DeleteKnowledgeBaseOutput, error)
- func (c *Client) GetAssistant(ctx context.Context, params *GetAssistantInput, optFns ...func(*Options)) (*GetAssistantOutput, error)
- func (c *Client) GetAssistantAssociation(ctx context.Context, params *GetAssistantAssociationInput, ...) (*GetAssistantAssociationOutput, error)
- func (c *Client) GetContent(ctx context.Context, params *GetContentInput, optFns ...func(*Options)) (*GetContentOutput, error)
- func (c *Client) GetContentSummary(ctx context.Context, params *GetContentSummaryInput, optFns ...func(*Options)) (*GetContentSummaryOutput, error)
- func (c *Client) GetKnowledgeBase(ctx context.Context, params *GetKnowledgeBaseInput, optFns ...func(*Options)) (*GetKnowledgeBaseOutput, error)
- func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error)
- func (c *Client) GetSession(ctx context.Context, params *GetSessionInput, optFns ...func(*Options)) (*GetSessionOutput, error)
- func (c *Client) ListAssistantAssociations(ctx context.Context, params *ListAssistantAssociationsInput, ...) (*ListAssistantAssociationsOutput, error)
- func (c *Client) ListAssistants(ctx context.Context, params *ListAssistantsInput, optFns ...func(*Options)) (*ListAssistantsOutput, error)
- func (c *Client) ListContents(ctx context.Context, params *ListContentsInput, optFns ...func(*Options)) (*ListContentsOutput, error)
- func (c *Client) ListKnowledgeBases(ctx context.Context, params *ListKnowledgeBasesInput, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) NotifyRecommendationsReceived(ctx context.Context, params *NotifyRecommendationsReceivedInput, ...) (*NotifyRecommendationsReceivedOutput, error)
- func (c *Client) QueryAssistant(ctx context.Context, params *QueryAssistantInput, optFns ...func(*Options)) (*QueryAssistantOutput, error)
- func (c *Client) RemoveKnowledgeBaseTemplateUri(ctx context.Context, params *RemoveKnowledgeBaseTemplateUriInput, ...) (*RemoveKnowledgeBaseTemplateUriOutput, error)
- func (c *Client) SearchContent(ctx context.Context, params *SearchContentInput, optFns ...func(*Options)) (*SearchContentOutput, error)
- func (c *Client) SearchSessions(ctx context.Context, params *SearchSessionsInput, optFns ...func(*Options)) (*SearchSessionsOutput, error)
- func (c *Client) StartContentUpload(ctx context.Context, params *StartContentUploadInput, optFns ...func(*Options)) (*StartContentUploadOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateContent(ctx context.Context, params *UpdateContentInput, optFns ...func(*Options)) (*UpdateContentOutput, error)
- func (c *Client) UpdateKnowledgeBaseTemplateUri(ctx context.Context, params *UpdateKnowledgeBaseTemplateUriInput, ...) (*UpdateKnowledgeBaseTemplateUriOutput, error)
- type CreateAssistantAssociationInput
- type CreateAssistantAssociationOutput
- type CreateAssistantInput
- type CreateAssistantOutput
- type CreateContentInput
- type CreateContentOutput
- type CreateKnowledgeBaseInput
- type CreateKnowledgeBaseOutput
- type CreateSessionInput
- type CreateSessionOutput
- type DeleteAssistantAssociationInput
- type DeleteAssistantAssociationOutput
- type DeleteAssistantInput
- type DeleteAssistantOutput
- type DeleteContentInput
- type DeleteContentOutput
- type DeleteKnowledgeBaseInput
- type DeleteKnowledgeBaseOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetAssistantAssociationInput
- type GetAssistantAssociationOutput
- type GetAssistantInput
- type GetAssistantOutput
- type GetContentInput
- type GetContentOutput
- type GetContentSummaryInput
- type GetContentSummaryOutput
- type GetKnowledgeBaseInput
- type GetKnowledgeBaseOutput
- type GetRecommendationsInput
- type GetRecommendationsOutput
- type GetSessionInput
- type GetSessionOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListAssistantAssociationsAPIClient
- type ListAssistantAssociationsInput
- type ListAssistantAssociationsOutput
- type ListAssistantAssociationsPaginator
- type ListAssistantAssociationsPaginatorOptions
- type ListAssistantsAPIClient
- type ListAssistantsInput
- type ListAssistantsOutput
- type ListAssistantsPaginator
- type ListAssistantsPaginatorOptions
- type ListContentsAPIClient
- type ListContentsInput
- type ListContentsOutput
- type ListContentsPaginator
- type ListContentsPaginatorOptions
- type ListKnowledgeBasesAPIClient
- type ListKnowledgeBasesInput
- type ListKnowledgeBasesOutput
- type ListKnowledgeBasesPaginator
- type ListKnowledgeBasesPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type NotifyRecommendationsReceivedInput
- type NotifyRecommendationsReceivedOutput
- type Options
- type QueryAssistantAPIClient
- type QueryAssistantInput
- type QueryAssistantOutput
- type QueryAssistantPaginator
- type QueryAssistantPaginatorOptions
- type RemoveKnowledgeBaseTemplateUriInput
- type RemoveKnowledgeBaseTemplateUriOutput
- type ResolveEndpoint
- type SearchContentAPIClient
- type SearchContentInput
- type SearchContentOutput
- type SearchContentPaginator
- type SearchContentPaginatorOptions
- type SearchSessionsAPIClient
- type SearchSessionsInput
- type SearchSessionsOutput
- type SearchSessionsPaginator
- type SearchSessionsPaginatorOptions
- type StartContentUploadInput
- type StartContentUploadOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateContentInput
- type UpdateContentOutput
- type UpdateKnowledgeBaseTemplateUriInput
- type UpdateKnowledgeBaseTemplateUriOutput
Constants ¶
const ServiceAPIVersion = "2020-10-19"
const ServiceID = "Wisdom"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Connect Wisdom Service.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateAssistant ¶
func (c *Client) CreateAssistant(ctx context.Context, params *CreateAssistantInput, optFns ...func(*Options)) (*CreateAssistantOutput, error)
Creates an Amazon Connect Wisdom assistant.
func (*Client) CreateAssistantAssociation ¶
func (c *Client) CreateAssistantAssociation(ctx context.Context, params *CreateAssistantAssociationInput, optFns ...func(*Options)) (*CreateAssistantAssociationOutput, error)
Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
func (*Client) CreateContent ¶
func (c *Client) CreateContent(ctx context.Context, params *CreateContentInput, optFns ...func(*Options)) (*CreateContentOutput, error)
Creates Wisdom content. Before to calling this API, use StartContentUpload (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) to upload an asset.
func (*Client) CreateKnowledgeBase ¶
func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, optFns ...func(*Options)) (*CreateKnowledgeBaseOutput, error)
Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations (https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error. For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
* Call DeleteKnowledgeBase (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html).
* Call DeleteDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html).
* Call CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) to recreate the DataIntegration or a create different one.
* Call CreateKnowledgeBase.
func (*Client) CreateSession ¶
func (c *Client) CreateSession(ctx context.Context, params *CreateSessionInput, optFns ...func(*Options)) (*CreateSessionOutput, error)
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
func (*Client) DeleteAssistant ¶
func (c *Client) DeleteAssistant(ctx context.Context, params *DeleteAssistantInput, optFns ...func(*Options)) (*DeleteAssistantOutput, error)
Deletes an assistant.
func (*Client) DeleteAssistantAssociation ¶
func (c *Client) DeleteAssistantAssociation(ctx context.Context, params *DeleteAssistantAssociationInput, optFns ...func(*Options)) (*DeleteAssistantAssociationOutput, error)
Deletes an assistant association.
func (*Client) DeleteContent ¶
func (c *Client) DeleteContent(ctx context.Context, params *DeleteContentInput, optFns ...func(*Options)) (*DeleteContentOutput, error)
Deletes the content.
func (*Client) DeleteKnowledgeBase ¶
func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, optFns ...func(*Options)) (*DeleteKnowledgeBaseOutput, error)
Deletes the knowledge base. When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations (https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html) and CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) in the Amazon AppIntegrations API Reference.
func (*Client) GetAssistant ¶
func (c *Client) GetAssistant(ctx context.Context, params *GetAssistantInput, optFns ...func(*Options)) (*GetAssistantOutput, error)
Retrieves information about an assistant.
func (*Client) GetAssistantAssociation ¶
func (c *Client) GetAssistantAssociation(ctx context.Context, params *GetAssistantAssociationInput, optFns ...func(*Options)) (*GetAssistantAssociationOutput, error)
Retrieves information about an assistant association.
func (*Client) GetContent ¶
func (c *Client) GetContent(ctx context.Context, params *GetContentInput, optFns ...func(*Options)) (*GetContentOutput, error)
Retrieves content, including a pre-signed URL to download the content.
func (*Client) GetContentSummary ¶
func (c *Client) GetContentSummary(ctx context.Context, params *GetContentSummaryInput, optFns ...func(*Options)) (*GetContentSummaryOutput, error)
Retrieves summary information about the content.
func (*Client) GetKnowledgeBase ¶
func (c *Client) GetKnowledgeBase(ctx context.Context, params *GetKnowledgeBaseInput, optFns ...func(*Options)) (*GetKnowledgeBaseOutput, error)
Retrieves information about the knowledge base.
func (*Client) GetRecommendations ¶
func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error)
Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html). This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html).
func (*Client) GetSession ¶
func (c *Client) GetSession(ctx context.Context, params *GetSessionInput, optFns ...func(*Options)) (*GetSessionOutput, error)
Retrieves information for a specified session.
func (*Client) ListAssistantAssociations ¶
func (c *Client) ListAssistantAssociations(ctx context.Context, params *ListAssistantAssociationsInput, optFns ...func(*Options)) (*ListAssistantAssociationsOutput, error)
Lists information about assistant associations.
func (*Client) ListAssistants ¶
func (c *Client) ListAssistants(ctx context.Context, params *ListAssistantsInput, optFns ...func(*Options)) (*ListAssistantsOutput, error)
Lists information about assistants.
func (*Client) ListContents ¶
func (c *Client) ListContents(ctx context.Context, params *ListContentsInput, optFns ...func(*Options)) (*ListContentsOutput, error)
Lists the content.
func (*Client) ListKnowledgeBases ¶
func (c *Client) ListKnowledgeBases(ctx context.Context, params *ListKnowledgeBasesInput, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)
Lists the knowledge bases.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for the specified resource.
func (*Client) NotifyRecommendationsReceived ¶
func (c *Client) NotifyRecommendationsReceived(ctx context.Context, params *NotifyRecommendationsReceivedInput, optFns ...func(*Options)) (*NotifyRecommendationsReceivedOutput, error)
Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html) and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
func (*Client) QueryAssistant ¶
func (c *Client) QueryAssistant(ctx context.Context, params *QueryAssistantInput, optFns ...func(*Options)) (*QueryAssistantOutput, error)
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html).
func (*Client) RemoveKnowledgeBaseTemplateUri ¶
func (c *Client) RemoveKnowledgeBaseTemplateUri(ctx context.Context, params *RemoveKnowledgeBaseTemplateUriInput, optFns ...func(*Options)) (*RemoveKnowledgeBaseTemplateUriOutput, error)
Removes a URI template from a knowledge base.
func (*Client) SearchContent ¶
func (c *Client) SearchContent(ctx context.Context, params *SearchContentInput, optFns ...func(*Options)) (*SearchContentOutput, error)
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
func (*Client) SearchSessions ¶
func (c *Client) SearchSessions(ctx context.Context, params *SearchSessionsInput, optFns ...func(*Options)) (*SearchSessionsOutput, error)
Searches for sessions.
func (*Client) StartContentUpload ¶
func (c *Client) StartContentUpload(ctx context.Context, params *StartContentUploadInput, optFns ...func(*Options)) (*StartContentUploadOutput, error)
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html) to finalize the content creation process or UpdateContent (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html) to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds the specified tags to the specified resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes the specified tags from the specified resource.
func (*Client) UpdateContent ¶
func (c *Client) UpdateContent(ctx context.Context, params *UpdateContentInput, optFns ...func(*Options)) (*UpdateContentOutput, error)
Updates information about the content.
func (*Client) UpdateKnowledgeBaseTemplateUri ¶
func (c *Client) UpdateKnowledgeBaseTemplateUri(ctx context.Context, params *UpdateKnowledgeBaseTemplateUriInput, optFns ...func(*Options)) (*UpdateKnowledgeBaseTemplateUriOutput, error)
Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
type CreateAssistantAssociationInput ¶
type CreateAssistantAssociationInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // The identifier of the associated resource. // // This member is required. Association types.AssistantAssociationInputData // The type of association. // // This member is required. AssociationType types.AssociationType // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
type CreateAssistantAssociationOutput ¶
type CreateAssistantAssociationOutput struct { // The assistant association. AssistantAssociation *types.AssistantAssociationData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateAssistantInput ¶
type CreateAssistantInput struct { // The name of the assistant. // // This member is required. Name *string // The type of assistant. // // This member is required. Type types.AssistantType // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // The description of the assistant. Description *string // The KMS key used for encryption. ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
type CreateAssistantOutput ¶
type CreateAssistantOutput struct { // Information about the assistant. Assistant *types.AssistantData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateContentInput ¶
type CreateContentInput struct { // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // The name of the content. Each piece of content in a knowledge base must have a // unique name. You can retrieve a piece of content using only its knowledge base // and its name with the SearchContent // (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html) // API. // // This member is required. Name *string // A pointer to the uploaded asset. This value is returned by StartContentUpload // (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html). // // This member is required. UploadId *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *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. Metadata map[string]string // The URI you want to use for the article. If the knowledge base has a // templateUri, setting this argument overrides it for this piece of content. OverrideLinkOutUri *string // The tags used to organize, track, or control access for this resource. Tags map[string]string // The title of the content. If not set, the title is equal to the name. Title *string // contains filtered or unexported fields }
type CreateContentOutput ¶
type CreateContentOutput struct { // The content. Content *types.ContentData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateKnowledgeBaseInput ¶
type CreateKnowledgeBaseInput struct { // The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your // own content. EXTERNAL knowledge bases support integrations with third-party // systems whose content is synchronized automatically. // // This member is required. KnowledgeBaseType types.KnowledgeBaseType // The name of the knowledge base. // // This member is required. Name *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // The description. Description *string // Information about how to render the content. RenderingConfiguration *types.RenderingConfiguration // The KMS key used for encryption. ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration // The source of the knowledge base content. Only set this argument for EXTERNAL // knowledge bases. SourceConfiguration types.SourceConfiguration // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
type CreateKnowledgeBaseOutput ¶
type CreateKnowledgeBaseOutput struct { // The knowledge base. KnowledgeBase *types.KnowledgeBaseData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateSessionInput ¶
type CreateSessionInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // The name of the session. // // This member is required. Name *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // The description. Description *string // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
type CreateSessionOutput ¶
type CreateSessionOutput struct { // The session. Session *types.SessionData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAssistantAssociationInput ¶
type DeleteAssistantAssociationInput struct { // The identifier of the assistant association. Can be either the ID or the ARN. // URLs cannot contain the ARN. // // This member is required. AssistantAssociationId *string // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // contains filtered or unexported fields }
type DeleteAssistantAssociationOutput ¶
type DeleteAssistantAssociationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAssistantInput ¶
type DeleteAssistantInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // contains filtered or unexported fields }
type DeleteAssistantOutput ¶
type DeleteAssistantOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteContentInput ¶
type DeleteContentInput struct { // The identifier of the content. Can be either the ID or the ARN. URLs cannot // contain the ARN. // // This member is required. ContentId *string // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // contains filtered or unexported fields }
type DeleteContentOutput ¶
type DeleteContentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteKnowledgeBaseInput ¶
type DeleteKnowledgeBaseInput struct { // The knowledge base to delete content from. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // contains filtered or unexported fields }
type DeleteKnowledgeBaseOutput ¶
type DeleteKnowledgeBaseOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetAssistantAssociationInput ¶
type GetAssistantAssociationInput struct { // The identifier of the assistant association. Can be either the ID or the ARN. // URLs cannot contain the ARN. // // This member is required. AssistantAssociationId *string // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // contains filtered or unexported fields }
type GetAssistantAssociationOutput ¶
type GetAssistantAssociationOutput struct { // The assistant association. AssistantAssociation *types.AssistantAssociationData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAssistantInput ¶
type GetAssistantInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // contains filtered or unexported fields }
type GetAssistantOutput ¶
type GetAssistantOutput struct { // Information about the assistant. Assistant *types.AssistantData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetContentInput ¶
type GetContentInput struct { // The identifier of the content. Can be either the ID or the ARN. URLs cannot // contain the ARN. // // This member is required. ContentId *string // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // contains filtered or unexported fields }
type GetContentOutput ¶
type GetContentOutput struct { // The content. Content *types.ContentData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetContentSummaryInput ¶
type GetContentSummaryInput struct { // The identifier of the content. Can be either the ID or the ARN. URLs cannot // contain the ARN. // // This member is required. ContentId *string // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // contains filtered or unexported fields }
type GetContentSummaryOutput ¶
type GetContentSummaryOutput struct { // The content summary. ContentSummary *types.ContentSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetKnowledgeBaseInput ¶
type GetKnowledgeBaseInput struct { // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // contains filtered or unexported fields }
type GetKnowledgeBaseOutput ¶
type GetKnowledgeBaseOutput struct { // The knowledge base. KnowledgeBase *types.KnowledgeBaseData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetRecommendationsInput ¶
type GetRecommendationsInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // The identifier of the session. Can be either the ID or the ARN. URLs cannot // contain the ARN. // // This member is required. SessionId *string // The maximum number of results to return per page. MaxResults *int32 // The duration (in seconds) for which the call waits for a recommendation to be // made available before returning. If a recommendation is available, the call // returns sooner than WaitTimeSeconds. If no messages are available and the wait // time expires, the call returns successfully with an empty list. WaitTimeSeconds int32 // contains filtered or unexported fields }
type GetRecommendationsOutput ¶
type GetRecommendationsOutput struct { // The recommendations. // // This member is required. Recommendations []types.RecommendationData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSessionInput ¶
type GetSessionInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // The identifier of the session. Can be either the ID or the ARN. URLs cannot // contain the ARN. // // This member is required. SessionId *string // contains filtered or unexported fields }
type GetSessionOutput ¶
type GetSessionOutput struct { // The session. Session *types.SessionData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶ added in v1.2.3
IdempotencyTokenProvider interface for providing idempotency token
type ListAssistantAssociationsAPIClient ¶
type ListAssistantAssociationsAPIClient interface {
ListAssistantAssociations(context.Context, *ListAssistantAssociationsInput, ...func(*Options)) (*ListAssistantAssociationsOutput, error)
}
ListAssistantAssociationsAPIClient is a client that implements the ListAssistantAssociations operation.
type ListAssistantAssociationsInput ¶
type ListAssistantAssociationsInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAssistantAssociationsOutput ¶
type ListAssistantAssociationsOutput struct { // Summary information about assistant associations. // // This member is required. AssistantAssociationSummaries []types.AssistantAssociationSummary // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAssistantAssociationsPaginator ¶
type ListAssistantAssociationsPaginator struct {
// contains filtered or unexported fields
}
ListAssistantAssociationsPaginator is a paginator for ListAssistantAssociations
func NewListAssistantAssociationsPaginator ¶
func NewListAssistantAssociationsPaginator(client ListAssistantAssociationsAPIClient, params *ListAssistantAssociationsInput, optFns ...func(*ListAssistantAssociationsPaginatorOptions)) *ListAssistantAssociationsPaginator
NewListAssistantAssociationsPaginator returns a new ListAssistantAssociationsPaginator
func (*ListAssistantAssociationsPaginator) HasMorePages ¶
func (p *ListAssistantAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssistantAssociationsPaginator) NextPage ¶
func (p *ListAssistantAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssistantAssociationsOutput, error)
NextPage retrieves the next ListAssistantAssociations page.
type ListAssistantAssociationsPaginatorOptions ¶
type ListAssistantAssociationsPaginatorOptions struct { // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAssistantAssociationsPaginatorOptions is the paginator options for ListAssistantAssociations
type ListAssistantsAPIClient ¶
type ListAssistantsAPIClient interface {
ListAssistants(context.Context, *ListAssistantsInput, ...func(*Options)) (*ListAssistantsOutput, error)
}
ListAssistantsAPIClient is a client that implements the ListAssistants operation.
type ListAssistantsInput ¶
type ListAssistantsInput struct { // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAssistantsOutput ¶
type ListAssistantsOutput struct { // Information about the assistants. // // This member is required. AssistantSummaries []types.AssistantSummary // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAssistantsPaginator ¶
type ListAssistantsPaginator struct {
// contains filtered or unexported fields
}
ListAssistantsPaginator is a paginator for ListAssistants
func NewListAssistantsPaginator ¶
func NewListAssistantsPaginator(client ListAssistantsAPIClient, params *ListAssistantsInput, optFns ...func(*ListAssistantsPaginatorOptions)) *ListAssistantsPaginator
NewListAssistantsPaginator returns a new ListAssistantsPaginator
func (*ListAssistantsPaginator) HasMorePages ¶
func (p *ListAssistantsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssistantsPaginator) NextPage ¶
func (p *ListAssistantsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssistantsOutput, error)
NextPage retrieves the next ListAssistants page.
type ListAssistantsPaginatorOptions ¶
type ListAssistantsPaginatorOptions struct { // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAssistantsPaginatorOptions is the paginator options for ListAssistants
type ListContentsAPIClient ¶
type ListContentsAPIClient interface {
ListContents(context.Context, *ListContentsInput, ...func(*Options)) (*ListContentsOutput, error)
}
ListContentsAPIClient is a client that implements the ListContents operation.
type ListContentsInput ¶
type ListContentsInput struct { // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type ListContentsOutput ¶
type ListContentsOutput struct { // Information about the content. // // This member is required. ContentSummaries []types.ContentSummary // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListContentsPaginator ¶
type ListContentsPaginator struct {
// contains filtered or unexported fields
}
ListContentsPaginator is a paginator for ListContents
func NewListContentsPaginator ¶
func NewListContentsPaginator(client ListContentsAPIClient, params *ListContentsInput, optFns ...func(*ListContentsPaginatorOptions)) *ListContentsPaginator
NewListContentsPaginator returns a new ListContentsPaginator
func (*ListContentsPaginator) HasMorePages ¶
func (p *ListContentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListContentsPaginator) NextPage ¶
func (p *ListContentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContentsOutput, error)
NextPage retrieves the next ListContents page.
type ListContentsPaginatorOptions ¶
type ListContentsPaginatorOptions struct { // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListContentsPaginatorOptions is the paginator options for ListContents
type ListKnowledgeBasesAPIClient ¶
type ListKnowledgeBasesAPIClient interface {
ListKnowledgeBases(context.Context, *ListKnowledgeBasesInput, ...func(*Options)) (*ListKnowledgeBasesOutput, error)
}
ListKnowledgeBasesAPIClient is a client that implements the ListKnowledgeBases operation.
type ListKnowledgeBasesInput ¶
type ListKnowledgeBasesInput struct { // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type ListKnowledgeBasesOutput ¶
type ListKnowledgeBasesOutput struct { // Information about the knowledge bases. // // This member is required. KnowledgeBaseSummaries []types.KnowledgeBaseSummary // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListKnowledgeBasesPaginator ¶
type ListKnowledgeBasesPaginator struct {
// contains filtered or unexported fields
}
ListKnowledgeBasesPaginator is a paginator for ListKnowledgeBases
func NewListKnowledgeBasesPaginator ¶
func NewListKnowledgeBasesPaginator(client ListKnowledgeBasesAPIClient, params *ListKnowledgeBasesInput, optFns ...func(*ListKnowledgeBasesPaginatorOptions)) *ListKnowledgeBasesPaginator
NewListKnowledgeBasesPaginator returns a new ListKnowledgeBasesPaginator
func (*ListKnowledgeBasesPaginator) HasMorePages ¶
func (p *ListKnowledgeBasesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListKnowledgeBasesPaginator) NextPage ¶
func (p *ListKnowledgeBasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)
NextPage retrieves the next ListKnowledgeBases page.
type ListKnowledgeBasesPaginatorOptions ¶
type ListKnowledgeBasesPaginatorOptions struct { // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListKnowledgeBasesPaginatorOptions is the paginator options for ListKnowledgeBases
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags used to organize, track, or control access for this resource. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type NotifyRecommendationsReceivedInput ¶
type NotifyRecommendationsReceivedInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // The identifiers of the recommendations. // // This member is required. RecommendationIds []string // The identifier of the session. Can be either the ID or the ARN. URLs cannot // contain the ARN. // // This member is required. SessionId *string // contains filtered or unexported fields }
type NotifyRecommendationsReceivedOutput ¶
type NotifyRecommendationsReceivedOutput struct { // The identifiers of recommendations that are causing errors. Errors []types.NotifyRecommendationsReceivedError // The identifiers of the recommendations. RecommendationIds []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
type QueryAssistantAPIClient ¶
type QueryAssistantAPIClient interface {
QueryAssistant(context.Context, *QueryAssistantInput, ...func(*Options)) (*QueryAssistantOutput, error)
}
QueryAssistantAPIClient is a client that implements the QueryAssistant operation.
type QueryAssistantInput ¶
type QueryAssistantInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // The text to search for. // // This member is required. QueryText *string // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type QueryAssistantOutput ¶
type QueryAssistantOutput struct { // The results of the query. // // This member is required. Results []types.ResultData // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type QueryAssistantPaginator ¶
type QueryAssistantPaginator struct {
// contains filtered or unexported fields
}
QueryAssistantPaginator is a paginator for QueryAssistant
func NewQueryAssistantPaginator ¶
func NewQueryAssistantPaginator(client QueryAssistantAPIClient, params *QueryAssistantInput, optFns ...func(*QueryAssistantPaginatorOptions)) *QueryAssistantPaginator
NewQueryAssistantPaginator returns a new QueryAssistantPaginator
func (*QueryAssistantPaginator) HasMorePages ¶
func (p *QueryAssistantPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*QueryAssistantPaginator) NextPage ¶
func (p *QueryAssistantPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*QueryAssistantOutput, error)
NextPage retrieves the next QueryAssistant page.
type QueryAssistantPaginatorOptions ¶
type QueryAssistantPaginatorOptions struct { // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
QueryAssistantPaginatorOptions is the paginator options for QueryAssistant
type RemoveKnowledgeBaseTemplateUriInput ¶
type RemoveKnowledgeBaseTemplateUriInput struct { // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // contains filtered or unexported fields }
type RemoveKnowledgeBaseTemplateUriOutput ¶
type RemoveKnowledgeBaseTemplateUriOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type SearchContentAPIClient ¶
type SearchContentAPIClient interface {
SearchContent(context.Context, *SearchContentInput, ...func(*Options)) (*SearchContentOutput, error)
}
SearchContentAPIClient is a client that implements the SearchContent operation.
type SearchContentInput ¶
type SearchContentInput struct { // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // The search expression to filter results. // // This member is required. SearchExpression *types.SearchExpression // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type SearchContentOutput ¶
type SearchContentOutput struct { // Summary information about the content. // // This member is required. ContentSummaries []types.ContentSummary // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SearchContentPaginator ¶
type SearchContentPaginator struct {
// contains filtered or unexported fields
}
SearchContentPaginator is a paginator for SearchContent
func NewSearchContentPaginator ¶
func NewSearchContentPaginator(client SearchContentAPIClient, params *SearchContentInput, optFns ...func(*SearchContentPaginatorOptions)) *SearchContentPaginator
NewSearchContentPaginator returns a new SearchContentPaginator
func (*SearchContentPaginator) HasMorePages ¶
func (p *SearchContentPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchContentPaginator) NextPage ¶
func (p *SearchContentPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchContentOutput, error)
NextPage retrieves the next SearchContent page.
type SearchContentPaginatorOptions ¶
type SearchContentPaginatorOptions struct { // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
SearchContentPaginatorOptions is the paginator options for SearchContent
type SearchSessionsAPIClient ¶
type SearchSessionsAPIClient interface {
SearchSessions(context.Context, *SearchSessionsInput, ...func(*Options)) (*SearchSessionsOutput, error)
}
SearchSessionsAPIClient is a client that implements the SearchSessions operation.
type SearchSessionsInput ¶
type SearchSessionsInput struct { // The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. AssistantId *string // The search expression to filter results. // // This member is required. SearchExpression *types.SearchExpression // The maximum number of results to return per page. MaxResults *int32 // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string // contains filtered or unexported fields }
type SearchSessionsOutput ¶
type SearchSessionsOutput struct { // Summary information about the sessions. // // This member is required. SessionSummaries []types.SessionSummary // If there are additional results, this is the token for the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SearchSessionsPaginator ¶
type SearchSessionsPaginator struct {
// contains filtered or unexported fields
}
SearchSessionsPaginator is a paginator for SearchSessions
func NewSearchSessionsPaginator ¶
func NewSearchSessionsPaginator(client SearchSessionsAPIClient, params *SearchSessionsInput, optFns ...func(*SearchSessionsPaginatorOptions)) *SearchSessionsPaginator
NewSearchSessionsPaginator returns a new SearchSessionsPaginator
func (*SearchSessionsPaginator) HasMorePages ¶
func (p *SearchSessionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchSessionsPaginator) NextPage ¶
func (p *SearchSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchSessionsOutput, error)
NextPage retrieves the next SearchSessions page.
type SearchSessionsPaginatorOptions ¶
type SearchSessionsPaginatorOptions struct { // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
SearchSessionsPaginatorOptions is the paginator options for SearchSessions
type StartContentUploadInput ¶
type StartContentUploadInput struct { // The type of content to upload. // // This member is required. ContentType *string // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // contains filtered or unexported fields }
type StartContentUploadOutput ¶
type StartContentUploadOutput struct { // The headers to include in the upload. // // This member is required. HeadersToInclude map[string]string // The identifier of the upload. // // This member is required. UploadId *string // The URL of the upload. // // This member is required. Url *string // The expiration time of the URL as an epoch timestamp. // // This member is required. UrlExpiry *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // The tags used to organize, track, or control access for this resource. // // This member is required. Tags map[string]string // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateContentInput ¶
type UpdateContentInput struct { // The identifier of the content. Can be either the ID or the ARN. URLs cannot // contain the ARN. // // This member is required. ContentId *string // The the identifier of the knowledge base. Can be either the ID or the ARN // // 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. Metadata map[string]string // The URI for the article. If the knowledge base has a templateUri, setting this // argument overrides it for this piece of content. To remove an existing // overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to // true. OverrideLinkOutUri *string // Unset the existing overrideLinkOutUri if it exists. RemoveOverrideLinkOutUri *bool // The revisionId of the content resource to update, taken from an earlier call to // GetContent, GetContentSummary, SearchContent, or ListContents. If included, this // argument acts as an optimistic lock to ensure content was not modified since it // was last read. If it has been modified, this API throws a // PreconditionFailedException. RevisionId *string // The title of the content. Title *string // A pointer to the uploaded asset. This value is returned by StartContentUpload // (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html). UploadId *string // contains filtered or unexported fields }
type UpdateContentOutput ¶
type UpdateContentOutput struct { // The content. Content *types.ContentData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateKnowledgeBaseTemplateUriInput ¶
type UpdateKnowledgeBaseTemplateUriInput struct { // The the identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. // // This member is required. KnowledgeBaseId *string // The template URI to update. // // This member is required. TemplateUri *string // contains filtered or unexported fields }
type UpdateKnowledgeBaseTemplateUriOutput ¶
type UpdateKnowledgeBaseTemplateUriOutput struct { // The knowledge base to update. KnowledgeBase *types.KnowledgeBaseData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files
¶
- api_client.go
- api_op_CreateAssistant.go
- api_op_CreateAssistantAssociation.go
- api_op_CreateContent.go
- api_op_CreateKnowledgeBase.go
- api_op_CreateSession.go
- api_op_DeleteAssistant.go
- api_op_DeleteAssistantAssociation.go
- api_op_DeleteContent.go
- api_op_DeleteKnowledgeBase.go
- api_op_GetAssistant.go
- api_op_GetAssistantAssociation.go
- api_op_GetContent.go
- api_op_GetContentSummary.go
- api_op_GetKnowledgeBase.go
- api_op_GetRecommendations.go
- api_op_GetSession.go
- api_op_ListAssistantAssociations.go
- api_op_ListAssistants.go
- api_op_ListContents.go
- api_op_ListKnowledgeBases.go
- api_op_ListTagsForResource.go
- api_op_NotifyRecommendationsReceived.go
- api_op_QueryAssistant.go
- api_op_RemoveKnowledgeBaseTemplateUri.go
- api_op_SearchContent.go
- api_op_SearchSessions.go
- api_op_StartContentUpload.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateContent.go
- api_op_UpdateKnowledgeBaseTemplateUri.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go