Documentation
¶
Index ¶
- type AccessDeniedException
- type CapacityUnitsConfiguration
- type ConflictException
- type Document
- type InternalServerException
- type RescoreExecutionPlanStatus
- type RescoreExecutionPlanSummary
- type RescoreResultItem
- type ResourceNotFoundException
- type ResourceUnavailableException
- type ServiceQuotaExceededException
- type Tag
- type ThrottlingException
- type ValidationException
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
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 CapacityUnitsConfiguration ¶
type CapacityUnitsConfiguration struct {
// The amount of extra capacity for your rescore execution plan.
//
// A single extra capacity unit for a rescore execution plan provides 0.01 rescore
// requests per second. You can add up to 1000 extra capacity units.
//
// This member is required.
RescoreCapacityUnits *int32
// contains filtered or unexported fields
}
Sets additional capacity units configured for your rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can add and remove capacity units to fit your usage requirements.
type ConflictException ¶
type ConflictException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.
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 Document ¶
type Document struct {
// The identifier of the document from the search service.
//
// This member is required.
Id *string
// The original document score or rank from the search service. Amazon Kendra
// Intelligent Ranking gives the document a new score or rank based on its
// intelligent search algorithms.
//
// This member is required.
OriginalScore *float32
// The body text of the search service's document.
Body *string
// The optional group identifier of the document from the search service.
// Documents with the same group identifier are grouped together and processed as
// one document within the service.
GroupId *string
// The title of the search service's document.
Title *string
// The body text of the search service's document represented as a list of tokens
// or words. You must choose to provide Body or TokenizedBody . You cannot provide
// both.
TokenizedBody []string
// The title of the search service's document represented as a list of tokens or
// words. You must choose to provide Title or TokenizedTitle . You cannot provide
// both.
TokenizedTitle []string
// contains filtered or unexported fields
}
Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.
type InternalServerException ¶
type InternalServerException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Supportfor help.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type RescoreExecutionPlanStatus ¶
type RescoreExecutionPlanStatus string
const ( RescoreExecutionPlanStatusCreating RescoreExecutionPlanStatus = "CREATING" RescoreExecutionPlanStatusUpdating RescoreExecutionPlanStatus = "UPDATING" RescoreExecutionPlanStatusActive RescoreExecutionPlanStatus = "ACTIVE" RescoreExecutionPlanStatusDeleting RescoreExecutionPlanStatus = "DELETING" RescoreExecutionPlanStatusFailed RescoreExecutionPlanStatus = "FAILED" )
Enum values for RescoreExecutionPlanStatus
func (RescoreExecutionPlanStatus) Values ¶
func (RescoreExecutionPlanStatus) Values() []RescoreExecutionPlanStatus
Values returns all known values for RescoreExecutionPlanStatus. 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 RescoreExecutionPlanSummary ¶
type RescoreExecutionPlanSummary struct {
// The Unix timestamp when the rescore execution plan was created.
CreatedAt *time.Time
// The identifier of the rescore execution plan.
Id *string
// The name of the rescore execution plan.
Name *string
// The current status of the rescore execution plan. When the value is ACTIVE , the
// rescore execution plan is ready for use.
Status RescoreExecutionPlanStatus
// The Unix timestamp when the rescore execution plan was last updated.
UpdatedAt *time.Time
// contains filtered or unexported fields
}
Summary information for a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
type RescoreResultItem ¶
type RescoreResultItem struct {
// The identifier of the document from the search service.
DocumentId *string
// The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the
// result.
Score *float32
// contains filtered or unexported fields
}
A result item for a document with a new relevancy score.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.
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 ResourceUnavailableException ¶
type ResourceUnavailableException struct {
// contains filtered or unexported fields
}
The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.
func (*ResourceUnavailableException) Error ¶
func (e *ResourceUnavailableException) Error() string
func (*ResourceUnavailableException) ErrorCode ¶
func (e *ResourceUnavailableException) ErrorCode() string
func (*ResourceUnavailableException) ErrorFault ¶
func (e *ResourceUnavailableException) ErrorFault() smithy.ErrorFault
func (*ResourceUnavailableException) ErrorMessage ¶
func (e *ResourceUnavailableException) ErrorMessage() string
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see Quotasfor more information, or contact Support to inquire about an increase of limits.
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 Tag ¶
type Tag struct {
// The key for the tag. Keys are not case sensitive and must be unique.
//
// This member is required.
Key *string
// The value associated with the tag. The value can be an empty string but it
// can't be null.
//
// This member is required.
Value *string
// contains filtered or unexported fields
}
A key-value pair that identifies or categorizes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can also use a tag to help control access to a rescore execution plan. A tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
type ThrottlingException ¶
type ThrottlingException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request was denied due to request throttling. Please reduce the number of requests and try again.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type ValidationException ¶
type ValidationException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.
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