Notice

public struct Notice : Codable, Equatable

A notice produced for the collection.

  • Severity level of the notice.

    See more

    Declaration

    Swift

    public enum Severity : String

  • Identifies the notice. Many notices might have the same ID. This field exists so that user applications can programmatically identify a notice and take automatic corrective action. Typical notice IDs include: index_failed, index_failed_too_many_requests, index_failed_incompatible_field, index_failed_cluster_unavailable, ingestion_timeout, ingestion_error, bad_request, internal_error, missing_model, unsupported_model, smart_document_understanding_failed_incompatible_field, smart_document_understanding_failed_internal_error, smart_document_understanding_failed_internal_error, smart_document_understanding_failed_warning, smart_document_understanding_page_error, smart_document_understanding_page_warning. Note: This is not a complete list; other values might be returned.

    Declaration

    Swift

    public var noticeID: String?

  • The creation date of the collection in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

    Declaration

    Swift

    public var created: Date?

  • Unique identifier of the document.

    Declaration

    Swift

    public var documentID: String?

  • Unique identifier of the query used for relevance training.

    Declaration

    Swift

    public var queryID: String?

  • Severity level of the notice.

    Declaration

    Swift

    public var severity: String?

  • Ingestion or training step in which the notice occurred. Typical step values include: smartDocumentUnderstanding, ingestion, indexing, convert. Note: This is not a complete list; other values might be returned.

    Declaration

    Swift

    public var step: String?

  • The description of the notice.

    Declaration

    Swift

    public var description: String?