{"openapi":"3.0.1","info":{"title":"Decommission Knowledge Domain","version":"1.0"},"servers":[{"url":"/"}],"paths":{"/api/knowledge/v1alpha1/domains:createWithSources":{"post":{"operationId":"KnowledgeDomain_CreateDomainWithSources","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1alpha1CreateDomainWithSourcesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1alpha1GetDomainResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Decommission Knowledge Domain","tags":["KnowledgeDomain"],"x-codegen-request-body-name":"body"}}},"components":{"schemas":{"CreateDomainNextVersionRequestMode":{"default":"UNKNOWN","description":" - UNKNOWN: UNKNOWN mode will result in an invalid argument error. An API caller must specify one of the modes below.\n - INGEST_ALL_CONTENTS: All contents will be reprocessed and ingested.\nAlthough this mode is equivalent to create domain using the CreateDomain default method, it's encouraged to use the CreateDomainNextVersion method to create your next domain version for clarity.\n - INGEST_CHANGED_CONTENTS: A Content is considered unchanged only if both of these are true:\n  - It was discovered from the same KnowledgeDomainEntity uri, or KnowledgeDomainEntityWithSources source_location in the case of multiple sources.\n  - It has the same source_location and detected revision as a Content object in the ancestor KnowledgeDomain.\nIngestion artifacts from unchanged contents are copied to the domain’s next version.\nAll other contents (ie. changed contents) will be reprocessed and ingested.\nIf a KnowledgeDomainEntity is not compatible with the KD succession, for example due to a different KnowledgeDomainEntity.label, an error will be returned. An API caller should use INGEST_ALL_CONTENTS mode instead.\n - INGEST_FAILED_CONTENTS: No revision or difference checks will be made for Contents or PriorKnowledge at the source_locations for any of the ContentGroups.\nOnly Contents that ended up in INGESTION_FAILED in the ancestor KD will be retried, and all previously successfully ingested Contents will be carried forward.\n - INGEST_SELECTED_CONTENTS: Ingest only the contents specified in in ContentGroupSource.Content `content` field. This will only re-ingest\npreviously ingested contents specified. No revision or difference checks will be made for Contents or PriorKnowledge\nat the source_locations for any of the ContentGroups.\nAll previously successfully ingested Contents will be carried forward.","enum":["UNKNOWN","INGEST_ALL_CONTENTS","INGEST_CHANGED_CONTENTS","INGEST_FAILED_CONTENTS","INGEST_SELECTED_CONTENTS"],"type":"string"},"googlerpcStatus":{"properties":{"code":{"format":"int32","type":"integer"},"message":{"type":"string"},"details":{"items":{"$ref":"#/components/schemas/protobufAny"},"type":"array"}},"type":"object"},"protobufAny":{"properties":{"type_url":{"type":"string"},"value":{"format":"byte","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string"}},"type":"object"},"v1alpha1CollectionMetadata":{"properties":{"uuid":{"description":"Random UUID returned in the resource response to represent the unique interaction with the API.  This can be thought of as a response id.","type":"string"},"response_time_millis":{"description":"Time difference in milliseconds between when the request was received and when the response was generated, that is, the latency.","format":"int64","type":"integer"}},"title":"Metadata that will be returned with each collection-level GET","type":"object"},"v1alpha1ContentGroup":{"properties":{"content_group_id":{"title":"ID of this entity","type":"string"},"display_name":{"title":"Displayed name","type":"string"},"description":{"title":"Description of the ContentGroup","type":"string"},"source_location":{"description":"URI for the source location for this Content Group;; this field should not be specified by the client and will be filled in by the server when a KD is created using the custom verb createWithSources.","type":"string"},"content_statuses":{"description":"The status breakdown of the contents in the content group; the index corresponds to the Content Status and the value at the index is the number of contents in the content group with that status. For example, if the content group has 5 contents all in the ingesting phase, then this would be [0, 0, 5, 0, 0, 0]. If a content group has 8 contents 2 configured, 1 ingesting, 2 ingested and 3 failed, then this would be [0, 2, 1, 2, 3, 0].","items":{"format":"int32","type":"integer"},"type":"array"},"service_id":{"description":"The third-party service connect; if not specified, the oldest service connect with an authority and type matching the source_location will be assigned.","type":"string"}},"title":"A ContentGroup is a parent collection of Contents\nIt can be joined with many Knowledge Domains\nIt can be joined with many Contents","type":"object"},"v1alpha1ContentGroupAssociation":{"properties":{"content_group_id":{"title":"Unique ID of a valid Content Group.","type":"string"},"knowledge_domain_id":{"title":"Unique ID of a valid Knowledge Domain.","type":"string"}},"type":"object"},"v1alpha1ContentGroupSource":{"properties":{"source_location":{"description":"The source types currently supported are:\n1)  https:// URI of an HTML webpage to download content of.\nCredentials need to be provided via the Pryon Service credentials API for the following:\n2)  https://drive.google.com URLs. Google Drive file and folder URLs (including Google Docs and Sheets).\n3)  https://*.sharepoint.com URLs.\n4)  https://*.box.com URLs.\n5)  https://*.zendesk.com URLs.\n6)  https://*.service-now.com URLs.\n7)  https://*.s3.region.amazonaws.com URLs.\n8)  https://*.atlassian.net URLs.\n9)  https://*.my.salesforce.com or https://*.develop.my.salesforce.com URLs.\n10) https://*.vimeo.com or vimeo.com URLs.\n11) https://youtube.com URLs.","type":"string"},"display_name":{"description":"Friendly display name for this source.","type":"string"},"service_id":{"description":"The third-party service connect. If not specified, the oldest service connect with an authority and type matching the source_location will be assigned.","type":"string"},"content_ids":{"description":"Content IDs of items specified during Domain creation; used alongside CreateNextVersionWithSourcesRequest when CreateNextVersionRequest.Mode == INGEST_SELECTED_CONTENTS; each Content record must already exist within the Content Group previously, or else this returns an error.","items":{"type":"string"},"type":"array"}},"type":"object"},"v1alpha1CreateDomainNextVersionRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1alpha1KnowledgeDomainEntity"},"mode":{"$ref":"#/components/schemas/CreateDomainNextVersionRequestMode"},"ancestor_knowledge_domain_id":{"description":"An ancestor KD to base this KD on; if KD succession Ids are mismatched between the two, an error will be returned.","type":"string"}},"type":"object"},"v1alpha1CreateDomainNextVersionWithSourcesRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1alpha1KnowledgeDomainEntityWithSources"},"ancestor_knowledge_domain_id":{"description":"An existing knowledge domain subject to this versioning operation.","type":"string"},"mode":{"$ref":"#/components/schemas/CreateDomainNextVersionRequestMode"}},"type":"object"},"v1alpha1CreateDomainWithSourcesRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1alpha1KnowledgeDomainEntityWithSources"}},"type":"object"},"v1alpha1DataType":{"default":"DATATYPE_UNSPECIFIED","description":" - DATATYPE_UNSPECIFIED: Unspecified - indicates that data type is not set. This is not a valid option when creating a metadata config.\n - STRING: Free form text characters.\n - BOOLEAN: A boolean value (true or false).\n - INTEGER: Positive and negative whole numbers, but not decimals.\n - DECIMAL: Any number with decimal places.\n - DATETIME: Datetime string.\n - DATETIME_EPOCH: Datetime in epoch time format.","enum":["DATATYPE_UNSPECIFIED","STRING","BOOLEAN","INTEGER","DECIMAL","DATETIME","DATETIME_EPOCH"],"type":"string"},"v1alpha1DomainContentGroupRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1alpha1ContentGroupAssociation"}},"type":"object"},"v1alpha1GetDomainContentGroupByContentResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1alpha1ContentGroup"}},"type":"object"},"v1alpha1GetDomainContentGroupResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1alpha1ContentGroupAssociation"}},"type":"object"},"v1alpha1GetDomainMetadataFieldStatResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1alpha1MetadataFieldStat"}},"type":"object"},"v1alpha1GetDomainResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1alpha1KnowledgeDomainEntity"}},"type":"object"},"v1alpha1GetSubjectResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1alpha1SubjectEntity"}},"type":"object"},"v1alpha1KnowledgeDomainEntity":{"description":"The top-level message sent by the client for the CreateDomain method.","properties":{"knowledge_domain_id":{"description":"When specified, must be a unique ID; if not specified, a unique ID is generated.","type":"string"},"display_name":{"description":"Display name of the knowledge domain.","type":"string"},"description":{"description":"Full description of the knowledge domain.","type":"string"},"status":{"description":"","$ref":"#/components/schemas/v1alpha1KnowledgeDomainEntityStatus"},"labels":{"additionalProperties":{"type":"string"},"description":"DEPRECATED. Knowledge domain specific key/value pair labels used to organize and select subsets of objects.","type":"object"},"kd_succession_id":{"description":"DEPRECATED. Use collection_id; autogenerated uneditable identifier for the parent to the knowledge domain; created with each new knowledge domain.","type":"string"},"status_reason":{"description":"Reason the knowledge domain was transitioned to its current status value; only relevant for status of CONTENT_NOT_SUPPORTED.","type":"string"},"team_ids":{"description":"DEPRECATED; teams are specified at the collection level.","items":{"type":"string"},"type":"array"},"created_by":{"description":"User responsible for creating the knowledge domain; autogenerated and not editable.","type":"string"},"collection_id":{"description":"Parent collection for the knowledge domain; autogenerated and not editable.","type":"string"},"config":{"additionalProperties":{"type":"string"},"description":"Advanced key/value pair configuration; see a Pryon representative before using.","type":"object"}},"type":"object"},"v1alpha1KnowledgeDomainEntityStatus":{"default":"","description":"Output only indicator of whether the knowledge domain can support conversation exchanges.\n\n - CONTENT_AWAIT: Initial value for a newly created KD; if knowledge domain was created with data.uri or data.contents, asynchronous status transition occurs to CONTENT_IDENTIFIED after a constituent Content Group and Contents are created; if knowledge domain was created without either of these, it remains in this status until an explicit PATCH with CONTENT_IDENTIFIED status is received.\n - CONTENT_IDENTIFIED: Starts an automated process of readying the content for conversation exchanges by ingesting each constituent content.\n - CONTENT_READY: Content is ingested and ready to support conversation exchanges.\n - CONTENT_NOT_SUPPORTED: Unable to support conversation exchanges on the content due to content problems; look for INGESTION_FAILED statuses to find out more details.\n - DECOMMISSIONED: No longer needed for conversation exchanges; will be removed from the system by ongoing housekeeping operations.","type":"string"},"v1alpha1KnowledgeDomainEntityWithSources":{"description":"The top-level message sent by the client for the CreateDomainWithSources method.","properties":{"knowledge_domain_id":{"description":"When specified, must be a unique ID; if not specified, a unique ID is generated.","type":"string"},"display_name":{"description":"Display name of the knowledge domain.","type":"string"},"description":{"description":"Full description of the knowledge domain.","type":"string"},"status":{"$ref":"#/components/schemas/v1alpha1KnowledgeDomainEntityStatus"},"sources":{"description":"Content Group for each source; for source folders, a content object is created for each file found at each source; for source URIs and Google Docs, one content object is created with content from the top-level page.","items":{"$ref":"#/components/schemas/v1alpha1ContentGroupSource"},"type":"array"},"labels":{"additionalProperties":{"type":"string"},"description":"Knowledge domain specific key/value pair labels used to organize and select subsets of objects.","type":"object"},"kd_succession_id":{"description":"DEPRECATED. Succession identifiers are automatically assigned and can no longer be controlled by users.","type":"string"},"team_ids":{"description":"Unique identifiers for the teams with knowledge domain access.","items":{"type":"string"},"type":"array"},"solution_id":{"description":"Licensed solution for the collection; if not provided, the organizational default solution is automatically assigned.","type":"string"}},"type":"object"},"v1alpha1ListContentGroupItem":{"properties":{"data":{"$ref":"#/components/schemas/v1alpha1ContentGroup"},"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"}},"type":"object"},"v1alpha1ListContentGroupsResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1CollectionMetadata"},"items":{"additionalProperties":{"$ref":"#/components/schemas/v1alpha1ListContentGroupItem"},"description":"Map of ContentGroups that match the request, keyed by content_group_id.","type":"object"}},"type":"object"},"v1alpha1ListDomainContentGroupItem":{"properties":{"data":{"$ref":"#/components/schemas/v1alpha1ContentGroupAssociation"},"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"}},"type":"object"},"v1alpha1ListDomainContentGroupsResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1CollectionMetadata"},"items":{"additionalProperties":{"$ref":"#/components/schemas/v1alpha1ListDomainContentGroupItem"},"title":"collection of Knowledge Domain to Content Group associations where key is content_group_id","type":"object"}},"type":"object"},"v1alpha1ListDomainItem":{"properties":{"data":{"$ref":"#/components/schemas/v1alpha1KnowledgeDomainEntity"},"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"}},"type":"object"},"v1alpha1ListDomainMetadataFieldValuesResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1CollectionMetadata"},"items":{"description":"List of unique metadata field value strings.","items":{"$ref":"#/components/schemas/v1alpha1ListMetadataFieldValueItem"},"type":"array"},"next_page_token":{"title":"If there are multiple pages, this will be returned and must be specified in each request for pages 2-N using the \"page_token\" query param.  However, the only reliable way to know if more pages exist is to request the next page when a full page of items is returned.\nsee https://cloud.google.com/apis/design/design_patterns#list_pagination","type":"string"},"page_size":{"description":"Returned for convenience and clarity - same as page_size in request.","format":"int32","type":"integer"}},"type":"object"},"v1alpha1ListDomainMetadataFieldsResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1CollectionMetadata"},"items":{"description":"List of unique metadata field items.","items":{"$ref":"#/components/schemas/v1alpha1ListMetadataFieldItem"},"type":"array"}},"type":"object"},"v1alpha1ListDomainsResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1CollectionMetadata"},"items":{"additionalProperties":{"$ref":"#/components/schemas/v1alpha1ListDomainItem"},"description":"Knowledge Domains that match request criteria. Note that the \"status\" field in this list should NOT be considered up-to-date. To get an up-to-date status, GET the individual item.","type":"object"},"next_page_token":{"title":"If there are multiple pages, this will be returned and must be specified in each request for pages 2-N using the \"page_token\" query param.  However, the only reliable way to know if more pages exist is to request the next page when a full page of items is returned.\nsee https://cloud.google.com/apis/design/design_patterns#list_pagination","type":"string"},"total_size":{"format":"int32","title":"This is the total number of items in the collection across all the pages. It is returned with every page and may change during page traversal.\nsee https://cloud.google.com/apis/design/design_patterns#list_pagination","type":"integer"},"page_size":{"description":"Returned for convenience and clarity - same as page_size in request.","format":"int32","type":"integer"},"order_by":{"description":"Returned for convenience and clarity - same as order_by in request.","type":"string"}},"type":"object"},"v1alpha1ListMetadataFieldItem":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1alpha1MetadataField"}},"type":"object"},"v1alpha1ListMetadataFieldValueItem":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1alpha1MetadataFieldValue"}},"type":"object"},"v1alpha1ListSubjectsResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1CollectionMetadata"},"items":{"description":"Subjects that match request criteria.","items":{"$ref":"#/components/schemas/v1alpha1GetSubjectResponse"},"type":"array"},"next_page_token":{"title":"If there are multiple pages, this will be returned and must be specified in each request for pages 2-N using the \"page_token\" query param.  However, the only reliable way to know if more pages exist is to request the next page when a full page of items is returned.\nsee https://cloud.google.com/apis/design/design_patterns#list_pagination","type":"string"},"page_size":{"description":"Returned for convenience and clarity - same as page_size in request.","format":"int32","type":"integer"},"order_by":{"description":"Returned for convenience and clarity - same as order_by in request.","type":"string"}},"type":"object"},"v1alpha1ListTagsResponse":{"properties":{"tag_types":{"description":"List of unique types and their tags.","items":{"$ref":"#/components/schemas/v1alpha1TagType"},"type":"array"},"next_page_token":{"title":"If there are multiple pages, this will be returned and must be specified in each request for pages 2-N using the \"page_token\" query param.  However, the only reliable way to know if more pages exist is to request the next page when a full page of items is returned.\nsee https://cloud.google.com/apis/design/design_patterns#list_pagination","type":"string"},"total_size":{"format":"int32","title":"This is the total number of items in the knowledge domain across all the pages.  It is returned with every page and may change during page traversal.\nsee https://cloud.google.com/apis/design/design_patterns#list_pagination","type":"integer"},"page_size":{"description":"Returned for convenience and clarity - same as page_size in request.","format":"int32","type":"integer"},"order_by":{"description":"Returned for convenience and clarity - same as order_by in request.","type":"string"}},"type":"object"},"v1alpha1MetadataField":{"properties":{"db_field_name":{"description":"The name for the metadata field.","type":"string"},"data_type":{"$ref":"#/components/schemas/v1alpha1DataType"}},"type":"object"},"v1alpha1MetadataFieldStat":{"properties":{"min":{"description":"Minimum value of the metadata field.","format":"int64","type":"string"},"max":{"description":"Maximum value of the metadata field.","format":"int64","type":"string"}},"type":"object"},"v1alpha1MetadataFieldValue":{"properties":{"value":{"description":"String value of the metadata field.","type":"string"},"count":{"description":"Count representing mentions of the value over the KD's contents.","format":"uint64","type":"string"}},"type":"object"},"v1alpha1ResourceMetadata":{"properties":{"uuid":{"description":"Unique identifier for the interaction returned in the resource response; the response ID.","type":"string"},"create_time":{"description":"Time of the initial request.","format":"date-time","type":"string"},"update_time":{"description":"Time of the last update; 0 indicates updates have never been made.","format":"date-time","type":"string"},"response_time_millis":{"format":"int64","title":"Response time (in milliseconds).","type":"integer"}},"type":"object"},"v1alpha1SubjectEntity":{"properties":{"subject_id":{"title":"hash of subject_category_id and term","type":"string"},"term":{"description":"A case-insensitive natural language term that represents the subject.","type":"string"},"subject_category_id":{"title":"Subject category","type":"string"},"definition":{"description":"Natural language definition of the subject.  This is provided by an expert.","type":"string"},"reference_count":{"format":"uint64","title":"!Deprecation Warning!: This field will no longer be kept up to date and must be considered inaccurate. To view subject reference counts \nplease see ListDomainSubjects.\n Number of references to the subject found in the content.  This is provided if known and will otherwise be zero.\nReference count at different levels:\nContent - occurrences in content (0 for Prior Knowledge content subjects)\nContent Group - occurrences in all contents in CG\nKnowledge Domain - occurrences in all contents in KD","type":"string"},"content_count":{"format":"uint64","title":"The number of contents that refer to the subject.  This is provided if known and will otherwise be zero.\nContent - 1\nContent Group - count of all contents it occurs in, in the CG\nKnowledge Domain - count of all contents it occurs in, in the KD","type":"string"}},"title":"A subject is an unique tuple of term and category","type":"object"},"v1alpha1Tag":{"properties":{"value":{"description":"Name of the tag.","type":"string"},"count":{"description":"Count representing mentions of the tag over the KD's contents.\nEmpty if `include_counts` was False (default).","format":"uint64","type":"string"}},"type":"object"},"v1alpha1TagSourceType":{"default":"TAG_SOURCE_TYPE_UNSPECIFIED","description":" - TAG_SOURCE_TYPE_UNSPECIFIED: Default. No tags can be created with this source.\n - SYSTEM_DEFINED: Tags created by the Pryon Cloud Services system.\n - USER_DEFINED: Tags defined by users if the system and created via user input.\n - QUERY_ATTRIBUTE: Tags associated to a content which can be used to improve Exchange response ranking quality based on the context specified in ExchangeInputOption.\nSee \"documentation about improving ranking quality\" link for more details.","enum":["TAG_SOURCE_TYPE_UNSPECIFIED","SYSTEM_DEFINED","USER_DEFINED","QUERY_ATTRIBUTE"],"type":"string"},"v1alpha1TagType":{"properties":{"type_name":{"description":"Name of the type.","type":"string"},"tag_source_type":{"$ref":"#/components/schemas/v1alpha1TagSourceType"},"tags":{"description":"Tags found for the type.","items":{"$ref":"#/components/schemas/v1alpha1Tag"},"type":"array"}},"type":"object"},"v1alpha1UpdateDomainContentGroupsContentPermissionRequest":{"properties":{"knowledge_domain_id":{"description":"Unique identifier of the knowledge domain.","type":"string"}},"title":"input to UpdateDomainContentGroupContentPermission","type":"object"},"v1alpha1UpdateDomainContentGroupsGroupPermissionRequest":{"properties":{"knowledge_domain_id":{"description":"Unique identifier of the knowledge domain asscociated with this update method.","type":"string"}},"title":"input to UpdateDomainContentGroupPermission","type":"object"}}},"x-original-swagger-version":"2.0"}